bazaarify / docs Goto Github PK

When trying to get the list of categories to use in sending to Birdeye. We found in the documentation this API: https://developers.birdeye.com/#/reference/category/all-categories/get-all-categories which calls this route: https://api.birdeye.com/resources/v1/category/all.

This lists all categories like:

[
    "3D Printing",
    "Acai Bowls",
    "Accessories",
    "Accountants",
    "Acne Treatment",
    "Acupuncture",
    "Addiction Medicine",
    "Adoption Services",
    ....
]

but does not have the details of their hierarchy of them.

We found that the API route https://api.birdeye.com/resources/v1/category returns the desired details like:

[
    {
        "id": 1,
        "name": "Advertising / Media / Agency",
        "childCategories": [
            {
                "id": 30,
                "name": "Reputation Management",
                "childCategories": [],
                "coverImageUrl": "advertising-media.jpg",
                "schemaType": null
            },
            {
                "id": 1299,
                "name": "Advertising / Media / Agency",
                "childCategories": [],
                "coverImageUrl": "advertising-media.jpg",
                "schemaType": null
            },
            ...
]

Is this an acceptable route to use for development to get the list of appropriate categories and subcategories?

When using API: https://developers.birdeye.com/#/reference/business/update/update-business

This is related to #175 but separate. Once you send the values for
and trying to send values for androidAppUrl and iosAppUrl the values are not stored in the business profile

Several issues here:

On API: https://developers.birdeye.com/#/reference/business/update/update-business

1. There is no documentation related to the entire section of vendorListing

2. Also there is a spelling area in the current implementation code.

Sample part of payload is:

"vendorListing": {
    "venderCategory": "",
    "venderSubcategory1": "",
    "venderSubcategory2": "",
    "venderSubcategory3": ""
  },

which is not right. The spelling of the Subcategories is being spelled vender vs the correct spelling like the header vendor.

3. There is no currently documented API to get the list of Categories here. Was able to determine that this route works but does require a token which is different for the API: https://app.birdeye.com/resources/v1/business/masterdata/vendor

When calling API: https://developers.birdeye.com/#/reference/business/update/update-business

'When trying to add values for the two following fields: tollFreePhoneNumber or localPhoneNumber.

Either together or separate, the following error occurs:

{
    "code": 500,
    "message": null
}

There is malformed endpoint path for Review Summary in the docs. The example has the correct path, but this line is incorrect. Should be:

## Review Summary [/v1/review/businessid/{businessId}/summary?{?api_key, statuses}]

List Conversations [POST]
This API will return conversations (messages ) owned by the company. Based on the doc, the size: 100 (number) - Number of conversation return in the response.
so if we send this to the server, I am supposed to receive 100 conversations, right?
{
"businessNumber": "xxxxxxxxxx",
"apiKey": "xxxxxxxxxx",
"startDate": "01/01/2020",
"endDate": "03/20/2023",
"offset": "0",
"size": "100",
"excludeCampaignMessages": 1
}

But I will only receive a random numbers (less than 100) of conversations in the response. Do I miss something here?

When calling API: https://developers.birdeye.com/#/reference/business/update/update-business

The documentation lists this field as iosAppURL. When using that field it throws an error:

{
    "code": 500,
    "message": null
}

When updated to iosAppUrl it then appears to work.

When trying to set hours on API: https://developers.birdeye.com/#/reference/business/update/update-business

You are able to set hours with the following example payload:

  {
    "day": 0,
    "startHour": "8:00",
    "endHour": "5:00",
    "isOpen": 1,
    "comment": "This day has sucks and is a case of"
  },

with the startHour after the endHour

This could create syncing issues.

On this API: https://developers.birdeye.com/#/reference/business/update/update-business
The following fields:

• fbCoverOptOut
• fbLogoOptOut
• gmbCoverOptOut
• gmbLogoOptOut

Have an unclear and inverted use of the boolean for the value being set. Please clearify.

When calling API: https://developers.birdeye.com/#/reference/business/update/update-business

The documentation lists this field as youtubeUrl. When using that field it appears to work but does not update the value of the location.

When updated to youTubeUrl it then appears to work.

When trying to update hours on API: https://developers.birdeye.com/#/reference/business/update/update-business

Multiple businesses have hours on a day where they scheduled their lunch at a specific time of them being open. For example.
Open on Monday - Friday from 8:00 am to 12:00 pm and then again from 1:30 pm to 5:30 pm. When trying to add this to the call like

"hoursOfOperations": [
  {
    "day": 0,
    "startHour": "8:00",
    "endHour": "12:00",
    "isOpen": 0,
    "comment": "Open in the morning"
  },
  {
    "day": 0,
    "startHour": "13:30",
    "endHour": "17:30",
    "isOpen": 0,
    "comment": "Open in the evening"
  },
...
}

The following undocumented error is displayed:

{
    "code": 2177,
    "message": "Week day cannot appear more than once"
}

This should be something that is possible to set for businesses who do have split hours during the day.

This issue is related to the documentation of the "List Responses" API endpoint at /resources/v1/survey/ext/list/responses/survey_id

1. The documentation says that a page parameter can be passed, however, it would appear that your system starts the first page at "0", not "1". The documentation shows a page "1" as the example. You should indicate somewhere that your pagination for this endpoint starts at 0. Note: I also checked the #Pagination section, but it lists a completely different way of paginating data.

2. When retrieving data, the response object hasNext key will always be "false" even if more pages exist. I suspect this is a bug. Example:

{
    "responseList": [...],
    "totalResponses": 146,
    "overallResponses": 146,
    "pageNo": 0, // <-- pagination is zero-based I guess? This should be documented.
    "pageSize": 100,
    "hasNext": false, <-- Should be true
    "surveyType": "traditional",
    "surveyName": "Customer Satisfaction Survey",
    "surveyId": xxxxxx
}

Hope this information helps.