openapi: 3.0.0 info: title: Birdeye version: '' description: |- Birdeye helps businesses grow through happy customers. Over 80,000 businesses use Birdeye everyday to attract new leads with Listings, Reviews and Referrals, convert them into customers with Webchat, Appointments, and Payments, and delight those customers with Surveys, Ticketing, and Insights - all in one place. The Birdeye APIs are built on HTTP and are RESTful APIs. * Uses resource-oriented URLs. * Uses built-in HTTP capabilities for passing parameters and authentication. * Responds with standard HTTP response codes to indicate errors. * Requests and responses payload attached with all the mentioned APIs, you may choose your preferred language per the integration requirement. ### Authentication and Rate limiting > __NOTE:__ > - __All API requests targeting business accounts must include the x-api-key header. This header is required and mandatory for successful authentication and access to the API endpoints.__ > > - __To protect your API key and prevent unauthorized access, please ensure all API requests are made from your backend server. Do not call the APIs directly from the browser or expose your API key in any client-side code.__ To call a Birdeye API, you need a valid API key. It can be fetched via the Birdeye dashboard and is a confidential key. There is a limit to calling APIs with each API key [connect with the support team to get the current limit]. If too many requests are made within the threshold timeframe, an error will be returned in the response. ### Pagination Multiple API supporting pagination. These APIs have two parameters sindex and count. * sindex: is the start index * count: No. of records, you want to fetch. > __Note__ > - _Deep Pagination with record window greater than 100k is not supported. Either reduce the sindex + count to be less than equal to 100k or use appropriate filters to narrow down your result set._ For example : * Suppose you have to fetch 20 records:


    API call 1 -> sindex=0, count 10
    API call 2 -> sindex -> 10, count 10.

* To fetch 100kth record:


    sindex = 99000 and count = 1000
    will just work fine as sindex + count = 100000 which is less than 100,000.

* If you fetch more than 100kth records:


    sindex = 99000 and count = 1001, sindex + count = 100001
    which is greater than 100,000. Thus, you'll receive an error in response.

### HTTP Status Codes Every API response will have an HTTP status code. * 200 - OK: API request is successful * 202 - Accepted: The API request has been accepted for processing. * 400 - Bad Request: The API request was unacceptable, often due to a missing or invalid parameter. * 404 - Not Found: The requested resource does not exist. * 429 - Rate Limited: You have made too many requests within the threshold timeframe. * 500 - Internal Server Error: Something went wrong on our end. Please get in touch with support. ### Error Response Birdeye API will return a validation error in case of missing/invalid input in the request. The response will return the errorCode and errorMessage. For example :


    {
        "code": 1161,
        "message": "Invalid API key"
    }

paths: "/v1/signup/reseller/subaccount": post: responses: '200': description: OK content: application/json: schema: type: object properties: businessId: type: number description: Id of the created business example: businessId: 653356544 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1076Model" x-apiary-response-models: - "$ref": "#/components/schemas/1076Model" - "$ref": "#/components/schemas/1052Model" - "$ref": "#/components/schemas/1150Model" - "$ref": "#/components/schemas/1151Model" - "$ref": "#/components/schemas/1045Model" - "$ref": "#/components/schemas/1046Model" - "$ref": "#/components/schemas/1047Model" - "$ref": "#/components/schemas/1094Model" - "$ref": "#/components/schemas/1075Model" - "$ref": "#/components/schemas/1025Model" - "$ref": "#/components/schemas/1055Model" - "$ref": "#/components/schemas/1093Model" - "$ref": "#/components/schemas/2150Model" - "$ref": "#/components/schemas/2151Model" - "$ref": "#/components/schemas/2152Model" - "$ref": "#/components/schemas/2153Model" - "$ref": "#/components/schemas/2154Model" - "$ref": "#/components/schemas/2155Model" - "$ref": "#/components/schemas/2156Model" - "$ref": "#/components/schemas/2157Model" - "$ref": "#/components/schemas/2286Model" - "$ref": "#/components/schemas/2166Model" x-apiary-response-examples: error_1076: value: code: 1176 message: Business info cannot be blank error_1052: value: code: 1052 message: User email id cannot be blank error_1150: value: code: 1150 message: Business already associated with this reseller error_1151: value: code: 1151 message: Business already associated with another reseller error_1045: value: code: 1045 message: Business name cannot be blank error_1046: value: code: 1046 message: Business name cannot be more than 250 characters error_1047: value: code: 1047 message: Business name cannot be less than 3 characters error_1094: value: code: 1094 message: Postal code cannot be blank. error_1075: value: code: 1075 message: Business location zip cannot be more than 6 numbers error_1025: value: code: 1025 message: Invalid business type error_1055: value: code: 1055 message: Not a valid US phone number. error_1093: value: code: 1093 message: HierarchyNode is enabled for this account. error_2150: value: code: 2150 message: Not a valid reseller/enterprise id. error_2151: value: code: 2151 message: Not a valid reseller/enterprise id. error_2152: value: code: 2152 message: Not a valid reseller/enterprise id. error_2153: value: code: 2153 message: Business name should not have the word Birdeye. error_2154: value: code: 2154 message: Business is already an active account. error_2155: value: code: 2155 message: Business is already an in-active account. error_2156: value: code: 2156 message: Business/Location/Product already exists error_2157: value: code: 2157 message: Business already associated with another reseller/enterprise. error_2286: value: code: 2286 message: Zip code is not provided for business error_2166: value: code: 2166 message: Invalid Business Type examples: response: value: code: 1176 message: Business info cannot be blank '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" x-apiary-response-models: - "$ref": "#/components/schemas/1175Model" - "$ref": "#/components/schemas/1010Model" x-apiary-response-examples: error_1175: value: code: 1175 message: No business found with the given id error_1010: value: code: 1010 message: No user found with the given id examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create a business operationId: createABusiness description: Create a business API creates a new business under a reseller. tags: - Business parameters: - name: rid in: query description: Id of the Reseller. required: true example: '12334667201' schema: type: number - name: email_id in: query description: Business Email id. required: true example: sample@birdeye.com schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createABusiness_Request" example: businessName: The Business Name zip: 32323 type: Business phone: '4032365164' entityCategory: physical_location countryCode: US aggrOptions: 1 "/v1/business/{businessNumber}/search": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_searchBusiness_Response200" example: accounts: - name: Thurston Rosenlund status: suspended createdAt: May 01, 2013 createdBy: Sam Bilings businessNumber: 396982176121 type: Business - name: Aspen Springs Dental status: paid createdAt: May 20, 2013 businessNumber: 106026111239 type: Business - name: Cherry Creek Family Dental status: paid createdAt: May 20, 2013 businessNumber: 379451236128 type: Business totalCount: 44 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/400Model" examples: response: value: code: 400 message: Page size must not be less than one! '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Search Business operationId: searchBusiness description: Search Business API searches a business using a name or number. Partial name matching is also supported by API. tags: - Business parameters: - name: businessNumber in: path description: Long id of the business, under which user wants to search for. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_searchBusiness_Request" example: pageSize: 25 searchStr: Thurston Rosenlund sortBy: createdAt sortOrder: ASC startIndex: 0 "/v1/business/{business_id}": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getBusiness_Response200" example: businessId: 12345678 name: Dieci Lifestyle Spa alias: Dieci Lifestyle Spa - Livingston, NJ emailId: 4568@livelovespa.com phone: "(973) 716-0101" fax: "(973) 716-0102" websiteURL: http://www.diecispa.com/ description: |- Specialties Bridal ServicesMakeup: Makeovers/Lessons/ Faux Lash applicationMassagesFacialsMicrocurrentMicrodermabrasionBody… keywords: Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists services: Beauty Salon, Hair Spa logoURL: http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg coverImageURL: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg timezone: Pacific Standard Time isServiceAreaProvider: 'Yes' serviceAreas: - description: 2390 Boston Street, Seattle, WA, 98109 placeId: ChIJ9YasdSKZs0wRSt--7QSjsd3 - description: 400 Boston Street, Seattle, WA, 98109 placeId: ChIJ9aasdAOKZasdaSt--7QsdLja4 languages: - English - Spanish payment: Visa, MasterCard, American Express, Debit Cards, Check hoursOfOperations: - day: '0' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '1' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '2' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '3' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '4' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '5' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '6' isOpen: 0 working24x7: 0 location: address1: 90 W Mount Pleasant Ave address2: "(btwn Preston Dr. & N. Mitchell Ave.)" subLocality: Auckland CBD city: Livingston state: NJ zip: '07039' countryCode: US countryName: United States of America reviewCount: 53 avgRating: 3.4 status: active type: Business category: Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists socialProfileURLs: googleUrl: 'null' facebookUrl: twitterUrl: linkedinUrl: youTubeUrl: isSEOEnabled: 'false' baseUrl: https://birdeye.com/diecispa-755009344 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Business operationId: getBusiness description: Get Business API gets business information, including product features opted and profile information. tags: - Business parameters: - name: business_id in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/{businessId}": put: responses: '200': description: OK content: application/json: schema: type: object properties: name: type: string alias: type: string emailId: type: string phone: type: string fax: type: string websiteUrl: type: string description: type: string keywords: type: string services: type: string logoUrl: type: string coverImageUrl: type: string gmbCover: type: string facebookCover: type: string timezone: type: string languages: type: array items: type: string isServiceAreaProvider: type: string serviceAreas: type: array items: type: object properties: description: type: string placeId: type: string required: - description - placeId payment: type: string hoursOfOperations: type: array items: type: object properties: day: type: string isOpen: type: number workingHours: type: array items: type: object properties: startHour: type: string endHour: type: string required: - startHour - endHour comment: type: string required: - day - isOpen - workingHours - comment working24x7: type: number location: type: object properties: address1: type: string address2: type: string city: type: string state: type: string zip: type: string countryCode: type: string countryName: type: string categoryList: type: array items: type: string socialProfileURLs: type: object properties: googleUrl: type: string facebookUrl: nullable: true twitterUrl: nullable: true linkedinUrl: nullable: true youTubeUrl: nullable: true example: name: Dieci Lifestyle Spa alias: Dieci Lifestyle Spa - Livingston, NJ emailId: 4568@livelovespa.com phone: "(973) 716-0101" fax: "(973) 716-0102" websiteUrl: http://www.diecispa.com/ description: |- Specialties Bridal ServicesMakeup: Makeovers/Lessons/ Faux Lash applicationMassagesFacialsMicrocurrentMicrodermabrasionBody… keywords: Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists services: Beauty Salon, Hair Spa logoUrl: http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg coverImageUrl: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg timezone: Pacific Standard Time languages: - English - Spanish isServiceAreaProvider: 'Yes' serviceAreas: - description: 2390 Boston Street, Seattle, WA, 98109 placeId: ChIJ9YasdSKZs0wRSt--7QSjsd3 - description: 400 Boston Street, Seattle, WA, 98109 placeId: ChIJ9aasdAOKZasdaSt--7QsdLja4 payment: Visa, MasterCard, American Express, Debit Cards, Check hoursOfOperations: - day: '0' isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '1' isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '2' isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '3' isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '4' isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '5' isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '6' isOpen: 0 working24x7: 0 location: address1: 90 W Mount Pleasant Ave address2: "(btwn Preston Dr. & N. Mitchell Ave.)" city: Livingston state: NJ zip: '07039' countryCode: US countryName: United States of America categoryList: - Hair Salons socialProfileURLs: googleUrl: 'null' facebookUrl: twitterUrl: linkedinUrl: youTubeUrl: example: name: Dieci Lifestyle Spa alias: Dieci Lifestyle Spa - Livingston, NJ emailId: 4568@livelovespa.com phone: "(973) 716-0101" fax: "(973) 716-0102" websiteUrl: http://www.diecispa.com/ description: |- Specialties Bridal ServicesMakeup: Makeovers/Lessons/ Faux Lash applicationMassagesFacialsMicrocurrentMicrodermabrasionBody… keywords: Hair Salons,Day Spas,Beauty Salon,Beauty Salons,Salons,Massage Therapists services: Beauty Salon, Hair Spa logoUrl: http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg coverImageUrl: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg gmbCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/abcd.jpg facebookCover: http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/fb.jpg timezone: Pacific Standard Time languages: - English - Spanish isServiceAreaProvider: 'Yes' serviceAreas: - description: 2390 Boston Street, Seattle, WA, 98109 placeId: ChIJ9YasdSKZs0wRSt--7QSjsd3 - description: 400 Boston Street, Seattle, WA, 98109 placeId: ChIJ9aasdAOKZasdaSt--7QsdLja4 payment: Visa, MasterCard, American Express, Debit Cards, Check hoursOfOperations: - day: '0' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '1' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '2' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '3' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '4' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '5' isOpen: 1 workingHours: - startHour: '09:00' endHour: '13:30' - startHour: '14:30' endHour: '19:00' comment: '' - day: '6' isOpen: 0 working24x7: 0 location: address1: 90 W Mount Pleasant Ave address2: "(btwn Preston Dr. & N. Mitchell Ave.)" city: Livingston state: NJ zip: '07039' countryCode: US countryName: United States of America categoryList: - Hair Salons socialProfileURLs: googleUrl: 'null' facebookUrl: twitterUrl: linkedinUrl: youTubeUrl: '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1045Model" x-apiary-response-models: - "$ref": "#/components/schemas/1045Model" - "$ref": "#/components/schemas/2296Model" - "$ref": "#/components/schemas/2297Model" - "$ref": "#/components/schemas/2290Model" - "$ref": "#/components/schemas/3334Model" - "$ref": "#/components/schemas/3335Model" - "$ref": "#/components/schemas/3336Model" - "$ref": "#/components/schemas/3337Model" - "$ref": "#/components/schemas/3348Model" - "$ref": "#/components/schemas/2511Model" - "$ref": "#/components/schemas/2512Model" - "$ref": "#/components/schemas/2513Model" - "$ref": "#/components/schemas/2514Model" - "$ref": "#/components/schemas/2515Model" - "$ref": "#/components/schemas/2516Model" - "$ref": "#/components/schemas/2517Model" - "$ref": "#/components/schemas/2518Model" - "$ref": "#/components/schemas/2519Model" - "$ref": "#/components/schemas/2520Model" - "$ref": "#/components/schemas/6000Model" - "$ref": "#/components/schemas/6001Model" x-apiary-response-examples: error_1045: value: code: 1045 message: Business name cannot be blank error_2296: value: code: 2296 message: Invalid Food Delivery link error_2297: value: code: 2297 message: Invalid Food Takeout link error_2290: value: code: 2290 message: Food Takeout/Food Delivery not supported for gmb primary category error_3334: value: code: 2503 message: Primary category can not be included in additional category. error_3335: value: code: 2276 message: Please add upto 9 GBP additional categories only. error_3336: value: code: 2277 message: Duplicate GBP categories are not allowed. error_3337: value: code: 2278 message: Primary GBP category is not allowed in additional GBP categories. error_3348: value: code: 2162 message: Reopen date should not be less than current date. error_2511: value: code: 2511 message: Cannot update business status when listing is already fixed. error_2512: value: code: 2512 message: Cannot update opening soon date when listing is already fixed. error_2513: value: code: 2513 message: Opened On date can not be in future. error_2514: value: code: 2514 message: Opening Soon date is mandatory when business is marked as Opening soon. error_2515: value: code: 2515 message: Reopen date is not supported for this date. error_2516: value: code: 2516 message: Opening Soon Date can not be more than 1 year from now. error_2517: value: code: 2517 message: Opening Soon date should not be less than current date. error_2518: value: code: 2518 message: Business Status is mandatory to pass with reopen, opened on and opening soon date. error_2519: value: code: 2519 message: Third party categories change for opening soon business is not allowed. error_2520: value: code: 2520 message: Open Date is not supported for this date error_6000: value: code: 6000 message: The 'sub_locality' field is mandatory for addresses in New Zealand. error_6001: value: code: 6001 message: The 'sub_locality' field cannot exceed 80 characters. examples: response: value: code: 1045 message: Business name cannot be blank '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1047Model" - "$ref": "#/components/schemas/1046Model" - "$ref": "#/components/schemas/1055Model" - "$ref": "#/components/schemas/1056Model" - "$ref": "#/components/schemas/1069Model" - "$ref": "#/components/schemas/1070Model" - "$ref": "#/components/schemas/1190Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1047: value: code: 1047 message: Business name cannot be less than 3 characters error_1046: value: code: 1046 message: Business name cannot be more than 250 characters error_1055: value: code: 1055 message: Not a valid US phone number. error_1056: value: code: 1056 message: Not a valid US fax number. error_1069: value: code: 1069 message: Business description cannot be more than 4000 characters. error_1070: value: code: 1070 message: Business keywords cannot be more than 1000 characters. error_1190: value: code: 1190 message: Invalid category examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Business operationId: updateBusiness description: Update Business API updates business information. tags: - Business parameters: - name: businessId in: path description: The Business Number required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateBusiness_Request" "/v1/business/{business_Id}": delete: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1174Model" examples: response: value: code: 1174 message: Reseller can't be removed as it has child accounts. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Business operationId: deleteBusiness description: Delete Business API deletes an account or sub-reseller under a reseller. tags: - Business parameters: - name: business_Id in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/business/{business_id}/status": put: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1191Model" examples: response: value: code: 1191 message: Invalid status. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '403': description: Forbidden content: application/json: schema: "$ref": "#/components/schemas/1184Model" examples: response: value: code: 1184 message: Status change is not allowed '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update the status operationId: updateTheStatus description: Status Update Business API updates the activation status of a business. Activation status signifies whether an account is active or inactive. tags: - Business parameters: - name: business_id in: path description: Business id whose status has to be changed. Returned by create business API required: true example: '12345678' schema: type: string - name: astatus in: query description: New status for the business. Valid values are "active/inactive". required: true example: inactive schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/business/child/all": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getChildBusinesses_Response200" example: - id: 986031488 name: Central Ohio Endodontics alias: Central Ohio Endodontics - Dublin, OH address: address1: 5152 Blazer Memorial Pkwy address2: Ste 102 subLocality: Auckland CBD city: Dublin state: OH zip: '43017' countryCode: US countryName: United States of America phone: "(614) 896-2801" type: Business status: active createdOn: Dec 04, 2013 createdBy: Sam Bilings - id: 768996864 name: Environmental Pest Management alias: Environmental Pest Management - Westerville, OH address: address1: 200 Hoff Rd address2: Unit P subLocality: Auckland CBD city: Westerville state: OH zip: '43082' countryCode: US countryName: United States of America phone: "(614) 771-8605" type: Business status: active createdOn: Dec 05, 2013 createdBy: Sam Bilings - id: 144670708364016 name: Sub-reseller alias: Sub-reseller status: active createdOn: Nov 05, 2013 type: Reseller childCount: 1 - id: 144670708364322 name: Holiday Inn alias: Holiday Inn status: active createdOn: Nov 01, 2013 type: Enterprise-Location childCount: 2 summary: Get Child Businesses operationId: getChildBusinesses description: Child Businesses API gets all the businesses under an account. tags: - Business parameters: - name: pid in: query description: Reseller/Sub-reseller/Enterprise Id. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/tabs": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1191Model" examples: response: value: code: 1191 message: Invalid status. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '403': description: Forbidden content: application/json: schema: "$ref": "#/components/schemas/1184Model" examples: response: value: code: 1184 message: Status change is not allowed '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update public profile of Businesses operationId: updatePublicProfileOfBusinesses description: Public profile tabs API saves information on business profile tabs. tags: - Business parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updatePublicProfileOfBusinesses_Request" example: profileTabs: - tabType: map label: map location showOnProfile: 0 showOnWebsite: 1 showOnFacebook: 1 url: http://www.mapurl.com - tabType: Feedback label: Feedback showOnProfile: 0 showOnWebsite: 1 showOnFacebook: 1 url: http://www.feedback.com "/v1/business/{businessId}/hierarchy": get: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number name: type: string alias: nullable: true address: nullable: true phone: nullable: true status: type: string createdOn: type: string type: type: string websiteUrl: nullable: true child: type: array items: type: object properties: id: type: number name: type: string alias: nullable: true address: nullable: true phone: nullable: true status: type: string createdOn: type: string type: type: string websiteUrl: nullable: true child: type: array items: type: object properties: id: type: number name: type: string alias: nullable: true address: nullable: true phone: nullable: true status: type: string createdOn: type: string type: type: string websiteUrl: nullable: true child: type: array items: type: object properties: id: type: number name: type: string alias: type: string address: type: object properties: address1: type: string address2: type: string subLocality: type: string city: type: string state: type: string zip: type: string countryCode: type: string countryName: type: string phone: type: string status: type: string createdOn: type: string type: type: string websiteUrl: type: string child: type: array items: {} parents: type: array items: type: object properties: id: type: number name: type: string alias: nullable: true address: nullable: true phone: nullable: true status: type: string createdOn: type: string type: type: string websiteUrl: nullable: true tags: nullable: true child: type: array items: {} parents: type: array items: {} example: id: 143424324234234 name: Psychiatry alias: address: phone: status: active createdOn: Sep 03, 2016 type: Department websiteUrl: child: - id: 147293020095434 name: Addiction Psychiatry alias: address: phone: status: active createdOn: Sep 03, 2016 type: Specialty websiteUrl: child: - id: 147293022348715 name: NYC Center for Treatment and Research alias: address: phone: status: active createdOn: Sep 03, 2016 type: Practice websiteUrl: child: - id: 1467324432430144 name: Anna B. B., M.D alias: Anna B. B., M.D address: address1: NYC Center for Treatment and Research address2: 561 West 35th Street, 11th Floor subLocality: Auckland CBD city: New York state: NY zip: '10036' countryCode: US countryName: United States of America phone: '646-xxx-xxxx ' status: active createdOn: Jun 30, 2016 type: Physician websiteUrl: https://google.org/abbnyc child: [] parents: - id: 148189355091299 name: Neurology alias: address: phone: status: active createdOn: Dec 16, 2016 type: Specialty websiteUrl: tags: child: [] parents: [] examples: response: value: id: 143424324234234 name: Psychiatry alias: address: phone: status: active createdOn: Sep 03, 2016 type: Department websiteUrl: child: - id: 147293020095434 name: Addiction Psychiatry alias: address: phone: status: active createdOn: Sep 03, 2016 type: Specialty websiteUrl: child: - id: 147293022348715 name: NYC Center for Treatment and Research alias: address: phone: status: active createdOn: Sep 03, 2016 type: Practice websiteUrl: child: - id: 1467324432430144 name: Anna B. B., M.D alias: Anna B. B., M.D address: address1: NYC Center for Treatment and Research address2: 561 West 35th Street, 11th Floor subLocality: Auckland CBD city: New York state: NY zip: '10036' countryCode: US countryName: United States of America phone: '646-xxx-xxxx ' status: active createdOn: Jun 30, 2016 type: Physician websiteUrl: https://google.org/abbnyc child: [] parents: - id: 148189355091299 name: Neurology alias: address: phone: status: active createdOn: Dec 16, 2016 type: Specialty websiteUrl: tags: child: [] parents: [] '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get hierarchy for an enterprise operationId: getHierarchyForAnEnterprise description: |- Get Hierarchy API gets business hierarchy. Hierarchical information contains the parent-child relationship information between businesses. tags: - Business parameters: - name: businessId in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/business-hierarchy/location/update-mapping/{businessId}": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Hierarchy operationId: updateHierarchy description: The Update Hierarchy API maps the hierarchical level to its corresponding level value for a given location. This API is used to update the hierarchical structure of locations, ensuring that each location is correctly placed within the hierarchy based on its level and value. It is important to avoid overwriting existing data by passing all values accurately. tags: - Business parameters: - name: businessId in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: Level: type: string description: It will be a key-value pair for each level with its corresponding level value. example: Division: Division 3 Region: Region 3 RD: Richard Steves Department: Store 3 "/v1/business/{businessNumber}/profile/customcard": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getCustomCardDetails_Response200" example: customCardDetails: - cardId: 5531 title: Mathew description: Card description imageURL: https://d2xt3xymj142xp.cloudfront.net/63936/fileUpload/936_16768607_FRetIc.jpeg imagePosition: '2' isVisible: 1 clickURL: https://www.abcdef.com linkText: Learn More - cardId: 5533 title: Steve Smith description: Card description imageURL: https://d2xt3xymj142xp.cloudfront.net/63936/fileUpload/63676550205863_FRetIc.jpeg imagePosition: '1' isVisible: 0 clickURL: http://www.abcdef.com linkText: Schedule '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Custom card details operationId: getCustomCardDetails description: Get Customer card API returns the detail of customer card of the location tags: - Business parameters: - name: businessNumber in: path description: Id of a business (Long). required: true schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/public/card/{cardId}": put: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Custom card operationId: updateCustomCard description: Manage Custom card API supports updating and deleting a custom card for a business profile. tags: - Business parameters: - name: cardId in: path description: Id of the custom card to update. required: true schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Long Business Number. required: false example: "[Required] Long Business Number." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateCustomCard_Request" example: cardId: 14744 title: title description: desc imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1475208/1737886366109/Screenshot20250109040058.png imagePosition: '1' isVisible: 1 isPinOnTop: 1 clickURL: https://www.google.com/ linkText: '' type: Link type delete: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Custom card operationId: deleteCustomCard description: Manage Custom card API supports updating and deleting a custom card for a business profile. tags: - Business parameters: - name: cardId in: path description: Id of the custom card to delete. required: true schema: type: number - name: Accept in: header description: e.g. */* required: false example: "*/*" schema: type: string default: "*/*" - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Long Business Number. required: false example: "[Required] Long Business Number." schema: type: string "/v1/business/{businessNumber}/timezones": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getTimezoneList_Response200" example: timezones: - value: Etc/GMT+12 label: "(GMT-12:00) Etc/GMT+12" - value: Pacific/Pago_Pago label: "(GMT-11:00) Pacific/Pago_Pago" - value: Pacific/Samoa label: "(GMT-11:00) Pacific/Samoa" - value: Pacific/Niue label: "(GMT-11:00) Pacific/Niue" '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Timezone List operationId: getTimezoneList description: Get Timezone List API fetches the list of all available timezones. tags: - Business parameters: - name: businessNumber in: path description: Id of a business (Long). required: true schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/{businessNumber}/birdeye/impressions": post: responses: '200': description: OK content: application/json: example: total: 300178 locations: - locationName: Natick House of Prom count: '87' - locationName: Kansas City House of Prom count: '265' - locationName: Glendale House of Prom House of Prom count: '158' - locationName: Fairfax House of Prom count: '355' - locationName: David's Bridal - Corporate Office count: '2546' '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2292Model" x-apiary-response-models: - "$ref": "#/components/schemas/2292Model" - "$ref": "#/components/schemas/2293Model" x-apiary-response-examples: error_2292: value: code: 2292 message: sortby can only be 'total' or 'location' error_2293: value: code: 2293 message: order can only be 'asc' or 'desc' examples: response: value: code: 2292 message: sortby can only be 'total' or 'location' summary: Get Birdeye Impressions operationId: getBirdeyeImpressions description: 'Returns only birdeye (source: website) impressions by location as well as total.' tags: - Business parameters: - name: businessNumber in: path description: Account Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getBirdeyeImpressions_Request" example: businessNumbers: - 147286063579104 - 147286063579108 startDate: '2022-11-23' endDate: '2023-11-23' limit: 5 order: desc sortby: location startIndex: 0 "/v1/business/public/custom-fields/create": post: responses: '200': description: OK content: application/json: example: id: 376 fieldName: colours created: 1751480725861 updated: 1751480725861 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5022Model" x-apiary-response-models: - "$ref": "#/components/schemas/5022Model" - "$ref": "#/components/schemas/5023Model" - "$ref": "#/components/schemas/5024Model" - "$ref": "#/components/schemas/5031Model" - "$ref": "#/components/schemas/5039Model" - "$ref": "#/components/schemas/5040Model" x-apiary-response-examples: error_5022: value: code: 5022 message: Another custom field with same name already present. error_5023: value: code: 5023 message: Custom field request dto cannot be null. error_5024: value: code: 5024 message: Custom field creation failed. error_5031: value: code: 5031 message: Method not implemented for unknown custom field type. error_5039: value: code: 5039 message: Custom field name cannot be a reserved keyword. error_5040: value: code: 5040 message: Max limit reached for custom fields. examples: response: value: code: 5022 message: Another custom field with same name already present. summary: Create operationId: create description: Create custom Fields tags: - Custom Fields parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_create_Request" example: defaultValue: Green dropDownOptions: - Blue - Green - Red fieldDescription: This custom field contains list of colours fieldName: colours filterable: 'false' type: DROPDOWN_MULTI "/v1/business/public/custom-fields/update/{fieldId}": put: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5025Model" x-apiary-response-models: - "$ref": "#/components/schemas/5025Model" - "$ref": "#/components/schemas/5026Model" x-apiary-response-examples: error_5025: value: code: 5025 message: Custom field not found. error_5026: value: code: 5026 message: Custom field updation failed. examples: response: value: code: 5025 message: Custom field not found. summary: Update operationId: update description: Update custom Fields tags: - Custom Fields parameters: - name: fieldId in: path description: fieldId of the custom field created earlier. required: true example: '376' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_update_Request" example: defaultValue: Green dropDownOptions: - Blue - Green - Red fieldDescription: This custom field contains list of colours filterable: 'false' isHidden: 'false' "/v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}": get: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number example: 376 description: fieldId of the custom field. fieldValue: type: string example: Green description: Field Value of custom field and will only be visible if value is present. fieldName: type: string example: colours description: Name of the custom field. type: type: string example: DROPDOWN_MULTI description: Type of field. defaultValue: type: string example: Green description: Default Value of custom field and will only be visible if value is present. fieldDescription: type: string example: This custom field contains list of colours description: Description of custom field. filterable: type: boolean description: Whether the custom field will be filterable or not. example: id: 376 fieldName: colours fieldValue: Green type: DROPDOWN_MULTI defaultValue: Greens fieldDescription: This custom field contains list of colours filterable: false '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5025Model" examples: response: value: code: 5025 message: Custom field not found. summary: Get operationId: get description: Get custom Fields tags: - Custom Fields parameters: - name: fieldId in: path description: fieldId of the custom field created earlier. required: true example: '376' schema: type: number - name: locationBizNumber in: path description: Long Location number of the Location required: true example: '123456789' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string "/v1/business/public/custom-fields/getList?locationBizNumber={locationBizNumber}": post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number example: 376 description: fieldId of the custom field. fieldValue: type: string example: Green description: Field Value of custom field and will only be visible if value is present. fieldName: type: string example: colours description: Name of the custom field. type: type: string example: DROPDOWN_MULTI description: Type of field. defaultValue: type: string example: Green description: Default Value of custom field and will only be visible if value is present. fieldDescription: type: string example: This custom field contains list of colours description: Description of custom field. filterable: type: boolean description: Whether the custom field will be filterable or not. dropDownOptions: type: array items: {} description: The list of options in custom field and will only be visible if value is present. example: id: 376 fieldName: colours fieldValue: Green type: DROPDOWN_MULTI defaultValue: Greens fieldDescription: This custom field contains list of colours filterable: false dropDownOptions: - value: Blue - value: Green - value: Red '406': description: Not Acceptable content: application/json: schema: "$ref": "#/components/schemas/1027Model" examples: response: value: code: 1027 message: Invalid business number. summary: POST operationId: pOST description: Get custom Fields List tags: - Custom Fields parameters: - name: locationBizNumber in: path description: Long Location number of the Location. required: true example: '123456789' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: X-BUSINESS-NUMBER in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: page: type: number description: Page number depending upon the size entered. size: type: number description: Maximum number of custom fields required in a result. searchStr: type: string description: To Search for a particular field via custom field Name . sortBy: type: string description: To sort the resultsFor eg via fieldName,id, etc. orderBy: type: string description: Order of the list and it can be only asc or desc. required: - page - size example: page: 0 size: 50 searchStr: colours sortBy: fieldDescription orderBy: asc example: page: 0 size: 50 searchStr: colours sortBy: fieldDescription orderBy: asc "/v1/business/public/custom-fields/delete/{fieldId}": delete: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5025Model" x-apiary-response-models: - "$ref": "#/components/schemas/5025Model" - "$ref": "#/components/schemas/5028Model" x-apiary-response-examples: error_5025: value: code: 5025 message: Custom field not found. error_5028: value: code: 5028 message: Custom field delete failed. examples: response: value: code: 5025 message: Custom field not found. summary: Delete operationId: delete description: Delete custom Fields tags: - Custom Fields parameters: - name: fieldId in: path description: fieldId of the custom field created earlier. required: true example: '376' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/business/public/custom-fields/associate": put: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number example: 376 description: fieldId of the custom field. fieldName: type: string example: colours description: Name of the custom field. type: type: string example: DROPDOWN_MULTI description: Type of field. fieldValue: type: string example: Green description: Associated Field Value of custom field . defaultValue: type: string example: Green description: Default Value of custom field and will only be visible if value is present. isHidden: type: boolean description: Whether the custom field will be hidden or not. allBusinesses: type: boolean description: Whether the custom field will be for all businesses or not. filterable: type: boolean description: Whether the custom field will be filterable or not. '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5025Model" x-apiary-response-models: - "$ref": "#/components/schemas/5025Model" - "$ref": "#/components/schemas/5028Model" x-apiary-response-examples: error_5025: value: code: 5025 message: Custom field not found. error_5028: value: code: 5028 message: Custom field delete failed. examples: response: value: code: 5025 message: Custom field not found. summary: Associate operationId: associate description: Associate custom Fields tags: - Custom Fields parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number. required: false example: "- Long Business Number." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: fieldId: type: number description: fieldId of the custom field. fieldValue: type: string description: Field Value of custom field and will only be visible if value is present. businessNumber: type: number description: Long Business Number. required: - fieldId - fieldValue - businessNumber example: businessNumber: 1234567890 fieldId: 376 fieldValue: Green example: businessNumber: 1234567890 fieldId: 376 fieldValue: Green "/v1/business/public/card": post: responses: '200': description: OK content: application/json: schema: type: object properties: cardId: type: number description: Id of the created custom card. title: type: string description: Title shown on the custom card. description: type: string description: Description/content shown on the custom card. imageURL: type: string description: Public image URL displayed on the card. imagePosition: type: string description: Image position value. isVisible: type: number description: Visibility status of card on the microsite. isPinOnTop: type: number description: Pin status of card on the microsite. clickURL: type: string description: Redirect URL for card click action. Empty when no redirect is configured. example: cardId: 92426 title: AKJ test description: custom card test imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1670003/1759138378356/image12.png imagePosition: '1' isVisible: 0 isPinOnTop: 1 clickURL: '' '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Custom card operationId: createCustomCard description: Create Custom card API creates a custom card for a business profile. tags: - Custom Fields parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Long Business Number. required: false example: "[Required] Long Business Number." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: title: type: string description: Title shown on the custom card. description: type: string description: Description/content shown on the custom card. imageURL: type: string description: Public image URL displayed on the card. imagePosition: type: number description: Position of the image on the card. isVisible: type: number description: Visibility status of card on the microsite. isPinOnTop: type: number description: Pin status of card on the microsite. clickURL: type: string description: Redirect URL for card click action. required: - title example: clickURL: '' description: custom card test imagePosition: 1 imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1670003/1759138378356/image12.png isPinOnTop: 1 isVisible: 0 title: AKJ test example: clickURL: '' description: custom card test imagePosition: 1 imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1670003/1759138378356/image12.png isPinOnTop: 1 isVisible: 0 title: AKJ test "/v1/user/signup/v2": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1052Model" x-apiary-response-models: - "$ref": "#/components/schemas/1052Model" - "$ref": "#/components/schemas/1053Model" - "$ref": "#/components/schemas/1054Model" - "$ref": "#/components/schemas/1014Model" - "$ref": "#/components/schemas/1013Model" - "$ref": "#/components/schemas/1057Model" - "$ref": "#/components/schemas/1059Model" x-apiary-response-examples: error_1052: value: code: 1052 message: User email id cannot be blank error_1053: value: code: 1053 message: User email id is invalid error_1054: value: code: 1054 message: User email id cannot be more than 40 characters error_1014: value: code: 1014 message: User role cannot be blank error_1013: value: code: 1013 message: Unknown user role error_1057: value: code: 1057 message: First name cannot be more than 50 characters error_1059: value: code: 1059 message: Last name cannot be more than 50 characters examples: response: value: code: 1052 message: User email id cannot be blank '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '409': description: Conflict content: application/json: schema: "$ref": "#/components/schemas/1160Model" examples: response: value: code: 1160 message: User is already associated with business. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create User operationId: createUser description: |- Create User API creates a new user for a business. By default, an invitation is sent to the user via email. tags: - User parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber required: false example: "[Required] User associated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createUser_Request" example: firstName: Rhonda lastName: Spears userEmailId: rhonda.spears@example.com phone: 408-xxx-xxxx userRole: owner sendInvite: true "/v1/user/updateUser": put: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1010Model" examples: response: value: code: 1010 message: No user found with the given id '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1177Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1177: value: code: 1177 message: User is not authorized to perform any action on any business examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1189Model" examples: response: value: code: 1189 message: User with given email id not found. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update User operationId: updateUser description: Updates an existing user’s access, notifications, and role. tags: - User parameters: - name: userEmailId in: query description: Email id of the user to be updated required: true example: abc@test.com schema: type: string - name: entUser in: query description: | true if the user needs to provide enterprise level access in case of all locations. entUser needs to be passed as true if user needs to be provided access to all locations otherwise by default its false. required: true example: 'false' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateUser_Request" "/v1/user/remove": delete: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1059Model" examples: response: value: code: 1059 message: Last name cannot be more than 50 characters '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1188Model" x-apiary-response-models: - "$ref": "#/components/schemas/1188Model" - "$ref": "#/components/schemas/1189Model" - "$ref": "#/components/schemas/1175Model" x-apiary-response-examples: error_1188: value: code: 1188 message: User is not associated with the business. error_1189: value: code: 1189 message: User with given email id not found. error_1175: value: code: 1175 message: No business found with the given id examples: response: value: code: 1188 message: User is not associated with the business. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete a user operationId: deleteAUser description: Delete User API removes user access from a business. tags: - User parameters: - name: bid in: query description: Business Id from which user access has to be revoked required: true example: '123' schema: type: string - name: email in: query description: Email id of the user whose access has to be revoked required: true example: abc@test.com schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/user/forgotpassword": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1052Model" examples: response: value: code: 1052 message: User email id cannot be blank '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1177Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1177: value: code: 1177 message: User is not authorized to perform any action on any business examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1189Model" examples: response: value: code: 1189 message: User with given email id not found. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Forgot Password operationId: forgotPassword description: Forgot Password API generates forgot password mail to reset the password. tags: - User parameters: - name: email in: query description: Email Id of the user whose access has to be revoked required: true example: abc@test.com schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/user/details": get: responses: '200': description: OK content: application/json: schema: type: object properties: emailId: type: string description: User's email Id. firstName: type: string description: User's first name. lastName: type: string description: User's last name. phone: type: string description: User's phone number. userRole: type: string description: Role on the account. businessList: type: array items: type: object properties: businessId: type: string enum: - '1234567' description: Id of the business. businessName: type: string enum: - Drs. Chalker and Peterson, A Dental Partnership description: Business Name. businessAlias: type: string enum: - Drs. Chalker description: Business Alias. required: - businessId - businessName - businessAlias additionalProperties: false description: Accessable Business list required: - businessList '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1188Model" x-apiary-response-models: - "$ref": "#/components/schemas/1188Model" - "$ref": "#/components/schemas/1189Model" - "$ref": "#/components/schemas/1010Model" x-apiary-response-examples: error_1188: value: code: 1188 message: User is not associated with the business. error_1189: value: code: 1189 message: User with given email id not found. error_1010: value: code: 1010 message: No user found with the given id examples: response: value: code: 1188 message: User is not associated with the business. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get details of a user operationId: getDetailsOfAUser description: Get User API gets details of a user. tags: - User parameters: - name: email in: query description: Email Id of the user whose details to be retrieved required: true example: abc@test.com schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/review/businessId/{businessId}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getReviews_Response200" example: - reviewId: '1858537291' rating: 0 comments: Ordered earlier today, delivered fast..exactly what I ordered..thank you so much! title: reviewer: firstName: Sandy Rowe lastName: Johncox nickName: Sandy Rowe Johncox thumbnailUrl: https://ddjkm7n7lx.cloudfront.net/reviewer/dc42f6d8b2b84dc0b688c43e616.jpeg facebookId: '638309687' reviewURL: https://www.facebook.com/Imp-Flow-17565744/reviews sourceType: Facebook inlineReplyEnabled: false reviewDate: Jan 20, 2014 response: Thanks responseDate: Feb 18, 2014 recommended: 1 - reviewId: '73748574902' rating: 0 comments: I am a long time customer and love Dieici. I am there at least once a week. I have never been disappointed with any service. I love all the girls. The customer service is beyond a 10. I also love the new addition Wish to the salon! Wish is a woman's clothing boutique. What could be better...beauty and fashion all in one spot!!! Dieci keeps getting better and better! title: reviewer: firstName: Jennifer lastName: Bennett nickName: Jennifer Bennett thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg emailId: jbennett@gmail.com facebookId: city: Cedar Knolls state: " NJ" reviewUrl: https://birdeye.com/imp-flower-15229573096 sourceType: Direct Feedback inlineReplyEnabled: true reviewDate: Jan 20, 2019 response: Thanks responseDate: Feb 18, 2019 featured: 0 customerId: 7432167 extraParams: key1: value1 key2: value2 key3: value3 assitedByUser: - firstName: Steve lastName: M. emailId: steve@test.com phoneNum: '' - firstName: Smith lastName: S. emailId: smith@test.com phoneNum: '' '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1163Model" x-apiary-response-models: - "$ref": "#/components/schemas/1163Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1186Model" - "$ref": "#/components/schemas/1187Model" - "$ref": "#/components/schemas/1227Model" - "$ref": "#/components/schemas/1228Model" - "$ref": "#/components/schemas/1244Model" x-apiary-response-examples: error_1163: value: code: 1163 message: Invalid start index value error_1167: value: code: 1167 message: API key is missing error_1186: value: code: 1186 message: Invalid from date. Allowed format is "MM/dd/yyyy". error_1187: value: code: 1187 message: Invalid to date. Allowed format is "MM/dd/yyyy". error_1227: value: code: 1227 message: Invalid updated from date. Allowed format is MM/dd/yyyy error_1228: value: code: 1228 message: Invalid updated to date. Allowed format is MM/dd/yyyy error_1244: value: code: 1244 message: Maximum 5 keywords can be selected for filter. examples: response: value: code: 1163 message: Invalid start index value '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1164Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1164: value: code: 1164 message: Invalid result count value examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Reviews operationId: getReviews description: |- Get Reviews returns reviews for a business account with detailed review fields. > __Behavior Note__ > - _If `statuses` is not provided, the API defaults to `["published"]`, which returns featured reviews only._ > - _Status mapping: `published` = featured reviews, `parked` = non-featured reviews._ > - _To fetch both featured and non-featured reviews, pass `statuses: ["published","parked"]` or `statuses: ["all"]` in the request body._ > - _`ratings` filters are applied only within the statuses selected for the request._ > __Note__ > - _Deep Pagination with record window greater than 100k is not supported. Either reduce the sindex + count to be less than equal to 100k or use appropriate filters to narrow down your result set._ tags: - Reviews parameters: - name: businessId in: path description: Id of the Business. required: true example: '12345678' schema: type: number - name: sindex in: query description: Start index of the reviews. Refer API note for max permissible value. required: true example: '10' schema: type: integer - name: count in: query description: Number of reviews to query. Refer API note for max permissible value. required: true example: '30' schema: type: integer - name: includeNonAggregatedReviews in: query description: Include Reviews whose auto-crawling is blocked e.g. PressGaney required: false example: 'false' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: fromDate: type: string description: Review date start in UTC format. toDate: type: string description: Review date end in UTC format, eg if toDate is 04/01/2013, reviews of date 04/01/2013 is excluded . fromTimestamp: type: number description: Review start date in milliseconds, pass either fromDate or fromTimestamp. toTimestamp: type: number description: Review end date in milliseconds, pass either endDate or toTimestamp. updateFromDate: type: string description: Review updated date start in UTC format. updateToDate: type: string description: Review updated date end in UTC format. sources: type: string description: 'Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.' ratings: type: array description: Review rating Possible values 0,1,2,3,4,5. items: {} searchStr: type: string description: String that is contained by review. subBusinessIds: type: array description: BusinessIds under enterprise account. items: {} statuses: type: array description: Review status filter. Valid values are "published", "parked", and "all". If omitted, default is "published" only (featured reviews). "published" refers to featured reviews and "parked" refers to non-featured reviews. items: {} allChild: type: boolean description: Get review from all child ignoring merge reviews flag configured at parent/child relationship level. tags: type: array description: Reviews with assigned tags items: {} fetchExtraParams: type: boolean description: To fetch custom field(s) associated with the customer attributed to the review [if any]. needCustomerInfo: type: boolean description: To fetch customer information associated with the reviewer [if attributed]. fetchAssitedByDetails: type: boolean description: To retrieve employees associated with the review [if mapped]. example: fromTimestamp: 1712986782000 toTimestamp: 1715578782000 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 searchStr: test string subBusinessIds: - 12345678 - 1232111 - 1231231321 statuses: - all allChild: 'true' tags: - positive - negative fetchExtraParams: false needCustomerInfo: false fetchAssitedByDetails: true example: fromTimestamp: 1712986782000 toTimestamp: 1715578782000 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 searchStr: test string subBusinessIds: - 12345678 - 1232111 - 1231231321 statuses: - all allChild: 'true' tags: - positive - negative fetchExtraParams: false needCustomerInfo: false fetchAssitedByDetails: true "/v1/review/archive/public": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_archivedGetReviews_Response200" example: - reviewId: '123456745001001' rating: 4.0 comments: Great service! recommended: 1 status: Published reviewer: firstName: John lastName: Doe nickName: thumbnailUrl: https://... sourceType: Google reviewDate: Fri, Feb 02, 2018 10:48 AM rDate: 1705276800000 archiveDate: Apr 05, 2026 deleteDate: Apr 05, 2027 response: Thank you for your feedback! responseDate: Oct 23, 2024 02:17 PM (SST) businessId: '175347500666724' businessName: Acme Corp - Downtown businessType: Business customerId: 3923910 medias: - url: https://cdn.example.com/photo.jpg thumbnailUrl: https://cdn.example.com/photo.jpg type: IMAGE '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2177Model" examples: response: value: code: 400 message: Invalid media id '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Archived Get Reviews operationId: archivedGetReviews description: Archived Get Reviews returns archived public reviews for the requested business and date range, with optional filters for source, delete date, ratings, status, and search text. tags: - Reviews parameters: - name: includeNonAggregatedReviews in: query description: Include reviews whose auto-crawling is blocked. Default is `false`. required: false example: 'false' schema: type: boolean - name: sindex in: query description: Start index of the reviews. Default is `0`. required: false example: '0' schema: type: integer - name: count in: query description: Number of reviews to fetch. Default is `10000`. required: false example: '10000' schema: type: integer - name: sortby in: query description: Sort field identifier. Default is `7`. required: false example: '7' schema: type: integer - name: sortorder in: query description: Sort order identifier. Default is `1`. required: false example: '1' schema: type: integer - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User-associated business number. required: false example: "[Required] User-associated business number." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_archivedGetReviews_Request" example: businessNumbers: [] startDate: 1712986782000 endDate: 1715578782000 sourceAlias: - google - facebook deleteStartDate: 1712986782000 deleteEndDate: 1715578782000 ratings: - 4 - 5 statuses: - published - parked searchStr: great service "/v1/review/businessid/{businessId}/summary": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getReviewsSummary_Response200" '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get reviews summary operationId: getReviewsSummary description: |- Review Summary API returns the number of reviews based on the review source. It also returns the list of review sources and review ratings. tags: - Reviews parameters: - name: businessId in: path description: Id of the business. required: true example: '12345678' schema: type: string - name: statuses in: query description: List of review status. Status “published” refers to featured reviews, while “parked” refers to non-featured reviews. required: false example: published,parked schema: type: array items: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/review/reply/business/{businessNumber}/review/{reviewId}": put: responses: '200': description: OK content: application/json: schema: type: object properties: response: type: string description: Review Reply text that is posted. responseBy: type: string description: Default user (static value) responseDate: type: string description: Reply posted date in millis. example: response: Thanks for reviewing us. responseBy: Default user responseDate: 1604926421189 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1011Model" x-apiary-response-models: - "$ref": "#/components/schemas/1011Model" - "$ref": "#/components/schemas/1042Model" - "$ref": "#/components/schemas/2110Model" - "$ref": "#/components/schemas/21101Model" - "$ref": "#/components/schemas/21103Model" - "$ref": "#/components/schemas/21104Model" - "$ref": "#/components/schemas/2111Model" - "$ref": "#/components/schemas/21113Model" - "$ref": "#/components/schemas/21114Model" - "$ref": "#/components/schemas/21112Model" - "$ref": "#/components/schemas/2222Model" - "$ref": "#/components/schemas/1541Model" - "$ref": "#/components/schemas/2075Model" - "$ref": "#/components/schemas/20706Model" - "$ref": "#/components/schemas/2078Model" x-apiary-response-examples: error_1011: value: code: 1011 message: Business id is invalid error_1042: value: code: 1042 message: Invalid review id error_2110: value: code: 2110 message: Your review response could not be submitted due to a temporary error on Google. Please try after some time. error_21101: value: code: 21101 message: Google page is not integrated. Kindly integrate it first. error_21103: value: code: 21103 message: Your review response could not be submitted due to a temporary error on Google. error_21104: value: code: 21104 message: Sorry, We could not find this review on Google. Please go to your Google Business page and reply to this review. Thank you. error_2111: value: code: 2111 message: Your review response could not be submitted due to a temporary error on Facebook. Please try after some time. error_21113: value: code: 21113 message: Facebook page is not integrated. Kindly integrate it first. error_21114: value: code: 21114 message: Sorry, We could not find this review on Facebook. Please go to your Facebook page and reply to this review. Thank you. error_21112: value: code: 21112 message: Your review response could not be submitted due to a temporary error on Facebook. error_2222: value: code: 2222 message: Oops! Something is off on our side. We are working on it. Please check later. error_1541: value: code: 1541 message: Rate Limit of API has been exceeded. error_2075: value: code: 2075 message: Error while claiming a provider for Care Dash error_20706: value: code: 20706 message: Error while posting a reply to Care Dash error_2078: value: code: 2078 message: Error while posting a reply to Rent examples: response: value: code: 1011 message: Business id is invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id summary: Post Review Reply operationId: postReviewReply description: Eligible reviews can be replied to from the Birdeye platform using Review Reply API. tags: - Reviews parameters: - name: businessNumber in: path description: Id of the business. required: true example: '169744180007807' schema: type: string - name: reviewId in: path description: Review Id. required: true example: '88778877' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: response: type: string description: Review Reply text to be posted. isPrivateResponse: type: string description: Flag to post reply privately to reviewer [Only in case of Managed Service]. example: response: Enter Reply here isPrivateResponse: false example: response: Enter Reply here isPrivateResponse: false "/v1/tag": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create tags operationId: createTags description: Create Tags creates new tag(s) in the account. tags: - Reviews parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: tags: type: array description: List of tag name. items: {} example: tags: - positive - spam example: tags: - positive - spam "/v1/tag/{tagname}": delete: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete a tag operationId: deleteATag description: Delete Tag deletes any tag from the account. tags: - Reviews parameters: - name: businessId in: query description: Business Number. required: true example: '12345678' schema: type: string - name: tagname in: path description: Tag name to be deleted. required: true example: positive2022 schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/tag/all": get: responses: '200': description: OK content: application/json: schema: type: array items: type: string example: - dental - dentist - doctor - ortho example: - dental - dentist - doctor - ortho '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get all tags operationId: getAllTags description: Fetch Tags returns the list of tags associated with the account. tags: - Reviews parameters: - name: businessId in: query description: Business Number. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/tag/add/review": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Assign tags to filtered reviews operationId: assignTagsToFilteredReviews description: Assign the list of tags to the reviews on the basis of review filter. tags: - Reviews parameters: - name: bid in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: tag in: query description: List of tags. required: true example: positive2022&negative2022 schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_assignTagsToFilteredReviews_Request" example: reviewIds: - '3901784402334' - '3901744402337' - '3902344402875' fromDate: 04/01/2013 toDate: 05/3/2015 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 keywords: - water searchStr: Awesome subBusinessIds: - 134387654345 - 134387654346 - 13438765437 "/v1/tag/remove/review": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Remove tags from filtered reviews operationId: removeTagsFromFilteredReviews description: Search reviews and remove tags removes the list of tags from reviews on the basis of review filter. tags: - Reviews parameters: - name: bid in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: tag in: query description: List of tags to be removed from reviews. required: true example: positive2022&negative2022 schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_removeTagsFromFilteredReviews_Request" example: reviewIds: - 3901784402334 - 3901744402337 fromDate: 04/01/2013 toDate: 05/3/2015 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 keywords: - water searchStr: Awesome subBusinessIds: - 134387654345 - 134387654346 - 13438765437 "/v1/tag/remove/all/review": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Remove particular tags from all reviews operationId: removeParticularTagsFromAllReviews description: Remove particular tags from all reviews removes the list of tags from all the reviews of an account. tags: - Reviews parameters: - name: bid in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: tags: type: array description: List of tags to be removed. items: {} example: tags: - happy - good - smile example: tags: - happy - good - smile "/v1/customer-v2/external/saveCustomer": post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number description: Id of enterprise customer. example: id: 115339282 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/5008Model" - "$ref": "#/components/schemas/5043Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_5008: value: code: 5008 message: RequestBody not found error_5043: value: code: 5043 message: Contact not found for the given request examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1532Model" examples: response: value: code: 1532 message: Business id is missing or invalid. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create or Update Contact operationId: createOrUpdateContact description: Customers can be created & updated using Create or Update Contact API. tags: - Contact parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createOrUpdateContact_Request" example: id: 115339282 firstName: Michael lastName: Scott email: michael@test.com phone: "(212) xxx-xxxx" countryCode: US emailOptin: true smsOptin: true blocked: false businessIds: - 161458406365307 - 161072537475129 tags: - Tag One - Tag Two customFields: - fieldName: Company type: text fieldValue: Dunder Mifflin - fieldName: Product type: text fieldValue: Paper externalId: ABC123 "/v1/customer-v2/external/getCustomer": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getContact_Response200" example: id: 115339282 firstName: Michael lastName: Scott email: test.user@test.com phone: "(212) xxx-xxxx" countryCode: US blocked: false emailOtin: true smsOptin: true source: api created: January 12, 2021 mappings: - cid: 1234451 location: new horizon bid: 710687 businessNumber: 161458406365307 - cid: 1235452 location: North Carolina bid: 714169 businessNumber: 161072537475129 tags: - Tag One - Tag Two customFields: - fieldName: Company type: text fieldValue: Dunder Mifflin - fieldName: Product type: text fieldValue: Paper externalId: ABC123 experienceScore: 8 experienceScoreSource: review '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/5043Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_5043: value: code: 5043 message: Contact not found for the given request examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1532Model" examples: response: value: code: 1532 message: Business id is missing or invalid. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Contact operationId: getContact description: Get Contact fetches Customer details. tags: - Contact parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: id: type: string description: Id of enterprise customer. optional (if cid, phone or email is provided). cid: type: string description: Id of customer mapping on a location. optional (if id, phone or email is provided). email: type: string description: Email of customer, optional (if phone, id or cid is provided). phone: type: string description: Phone of customer optional (if email, id or cid is provided). experienceScore: type: boolean description: If true, includes the experience score of the customer in the response. Default is false. example: id: 115339282 cid: 293847172 email: test.user@test.com phone: "(212) xxx-xxxx" experienceScore: false example: id: 115339282 cid: 293847172 email: test.user@test.com phone: "(212) xxx-xxxx" experienceScore: false "/v1/customer-v2/external/deleteCustomer": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5043Model" examples: response: value: code: 5043 message: Contact not found for the given request '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1532Model" examples: response: value: code: 1532 message: Business id is missing or invalid. summary: Delete Contact operationId: deleteContact description: Customers can be deleted using Delete Contact API. tags: - Contact parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: id: type: string description: Id of enterprise customer. businessIds: type: array description: List of business Ids. If businessIds are provided, mappings would be deleted from those locations only. If no businessIds are provided, the customer would be deleted from all the locations. items: {} required: - id example: id: 115339282 businessIds: - 161322681923726 - 161322681923727 example: id: 115339282 businessIds: - 161322681923726 - 161322681923727 "/v1/customer/checkin": post: responses: '200': description: OK content: application/json: schema: type: object properties: customerId: type: number description: Id of enterprise customer. '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1142Model" x-apiary-response-models: - "$ref": "#/components/schemas/1142Model" - "$ref": "#/components/schemas/1086Model" - "$ref": "#/components/schemas/1087Model" - "$ref": "#/components/schemas/1088Model" - "$ref": "#/components/schemas/1055Model" - "$ref": "#/components/schemas/1170Model" x-apiary-response-examples: error_1142: value: code: 1142 message: Customer name cannot be blank error_1086: value: code: 1086 message: Customer email id cannot be blank. error_1087: value: code: 1087 message: Customer email id is invalid. error_1088: value: code: 1088 message: Customer email id cannot be more than 40 characters. error_1055: value: code: 1055 message: Not a valid US phone number. error_1170: value: code: 1170 message: SMS Alert flag is invalid. Valid values are 0 or 1. examples: response: value: code: 1142 message: Customer name cannot be blank '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1033Model" x-apiary-response-models: - "$ref": "#/components/schemas/1033Model" - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1175Model" x-apiary-response-examples: error_1033: value: code: 1033 message: You are not authorized to perform this action error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1175: value: code: 1175 message: No business found with the given id examples: response: value: code: 1033 message: You are not authorized to perform this action '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Customer Checkin operationId: customerCheckin description: Customer check-in can be done using Check in API. tags: - Contact parameters: - name: bid in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_customerCheckin_Request" example: name: Steve Smith emailId: steves@abcd.com phone: 408-xxx-xxxx smsEnabled: 1 additionalParams: Tag Group Name 1: Tag Name 1 Tag Group Name 2: Tag Name 2 location: New York employees: - emailId: sshikha@abcd.com externalId: ABC123 "/v1/customer/history/{customerId}": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_customerActivityLog_Response200" example: - type: Share review email activityDate: Mar 11, 2018 08:44 PM action: Sent activityTimestamp: 1435290249000 - type: Review request email activityDate: Mar 12, 2018 08:43 PM action: Sent activityTimestamp: 1435290234000 - type: Review request email activityDate: Mar 13, 2018 08:43 PM action: 5-star review written on Birdeye activityTimestamp: 1435290234000 - type: Created activityDate: Mar 13, 2018 08:43 PM action: No Action activityTimestamp: 1435290234000 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1089Model" x-apiary-response-models: - "$ref": "#/components/schemas/1089Model" - "$ref": "#/components/schemas/1091Model" - "$ref": "#/components/schemas/1523Model" - "$ref": "#/components/schemas/1524Model" x-apiary-response-examples: error_1089: value: code: 1089 message: Customer id is invalid. error_1091: value: code: 1091 message: User id not authorized to view this customer. error_1523: value: code: 1523 message: The correct date format should be mm/dd/yyyy. error_1524: value: code: 1524 message: Date entered is invalid. examples: response: value: code: 1089 message: Customer id is invalid. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Customer activity log operationId: customerActivityLog description: You can retrieve the customer history or customer activity log using the Customer activity log API. tags: - Contact parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: startDate in: query description: The start date format should be MM/dd/yyyy. if start date is not set, then we will use the date customer was created. required: false example: 12/30/2021 schema: type: string - name: endDate in: query description: The end date format should be MM/dd/yyyy. if end date is not set, then we will use the current date. required: false example: 12/30/2022 schema: type: string - name: customerId in: path description: Id of the customer. required: true example: '12344' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/customer/id/{customerId}": delete: responses: '200': description: OK content: application/json: schema: type: object properties: email: type: string description: Email Id of the customer. firstName: type: string description: First name of the customer. number: type: string description: Phone number of the customer. example: emailId: tom@abcd.com firstName: tom number: '411504416' '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1089Model" examples: response: value: code: 1089 message: Customer id is invalid. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Customer Delete operationId: customerDelete description: Customer can be deleted using this API. tags: - Contact parameters: - name: customerId in: path description: Id of enterprise customer. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/customer-v2/change-permission": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1089Model" examples: response: value: code: 1089 message: Customer id is invalid. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Subscribe/Unsubscribe Customer operationId: subscribeUnsubscribeCustomer description: Customer can be subscribe/unsubscribe from Email & SMS using this API. tags: - Contact parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_subscribeUnsubscribeCustomer_Request" example: permission: both-unsubscribed email: - test1@mail.in phone: - '2345654326' accountNumber: 123456789876543 "/v2/customer/list": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_contact_Response200" example: page: 0 size: 25 totalPages: 68 totalCount: 1679 customers: - customerId: 12345 name: Dummy1 email: sam@gmail.com phone: xxx-xxx-xxxx lastActivityWithTime: 12 Aug 2019 02:05 PM PDT - customerId: 54321 name: Summy2 email: samuel@gmail.com phone: xxx-xxx-xxxx lastActivityWithTime: 12 Aug 2019 02:05 PM PDT '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Contact operationId: contact description: Contact list API fetches contact list for a business. tags: - Contact parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: page in: query description: The page number. required: true example: '0' schema: type: number - name: size in: query description: Maximum number of contacts return in response. required: true example: '30' schema: type: number - name: sortby in: query description: The sorting order of the list. required: true example: lastActivityOn schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: startDate: type: string description: Start Date in format mm/dd/yyyy endDate: type: string description: End Date in format mm/dd/yyyy example: startDate: 07/01/2019 endDate: 07/19/2019 example: startDate: 07/01/2019 endDate: 07/19/2019 "/v1/contact/details": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_customerOrLeadList_Response200" example: page: 0 size: 100 totalPages: 310 totalCount: 30983 contacts: - firstName: Dummy1F lastName: Dummy1L email: sam@gmail.com phone: xxx-xxx-xxxx created: '2021-01-06T22:25:12.000+0000' contactType: customer source: facebook mappings: - businessId: 123456789909 customerId: 2341 - businessId: 123456789910 customerId: 2342 - firstName: Dummy2F lastName: Dummy2L email: samuel@gmail.com phone: '' created: '2021-01-06T22:06:41.000+0000' contactType: lead source: webchat mappings: - businessId: 123456789909 customerId: 2343 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/21121Model" x-apiary-response-models: - "$ref": "#/components/schemas/21121Model" - "$ref": "#/components/schemas/21120Model" - "$ref": "#/components/schemas/21122Model" - "$ref": "#/components/schemas/2347Model" - "$ref": "#/components/schemas/2348Model" x-apiary-response-examples: error_21121: value: code: 21121 message: Invalid contact source provided in the request. error_21120: value: code: 21120 message: Invalid contact type provided in the request. Valid contact types are lead or customer error_21122: value: code: 21122 message: Reseller business is not supported in this request error_2347: value: code: 2347 message: Max page size allowed is 1,000 error_2348: value: code: 2348 message: Max window size allowed is 60000 for a filter selection examples: response: value: code: 21121 message: Invalid contact source provided in the request. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Customer or Lead list operationId: customerOrLeadList description: Customer or Lead list fetches the contact list for a business, which can be filtered based on contact type (Lead or Customer) & source of the contact. tags: - Contact parameters: - name: tags in: query description: If tag data is required send true, default value is false. required: false example: 'true' schema: type: boolean - name: customfields in: query description: If custom fields data is required send true, default is false. required: false example: 'true' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: sources: type: array description: Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google. items: {} startDateUtc: type: string description: Start date in format mm/dd/yyyy. endDateUtc: type: string description: End date in format mm/dd/yyyy. contactType: type: string description: Possible values are "lead", "customer". If blank then all contact types are returned. businessId: type: number description: Business number of the location, when enterprise number is provided, then fetch data for all locations. page: type: string description: Page number to request. size: type: string description: Number of records per page, max is 5000. required: - startDateUtc - endDateUtc - businessId - page - size example: sources: - api - dashboard - facebook - integration - sftp - bulkupload - webchat - crmimport - other - referral - voicecall - text - email - google startDateUtc: 10/01/2020 endDateUtc: 11/01/2021 contactType: customer businessId: 158629168202762 page: 0 size: 100 example: sources: - api - dashboard - facebook - integration - sftp - bulkupload - webchat - crmimport - other - referral - voicecall - text - email - google startDateUtc: 10/01/2020 endDateUtc: 11/01/2021 contactType: customer businessId: 158629168202762 page: 0 size: 100 "/v1/contactUs/{businessId}": post: responses: '200': description: OK content: application/json: schema: type: object properties: customerId: type: number description: Id of the enterprise customer. example: customerId: 1234567 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1001Model" x-apiary-response-models: - "$ref": "#/components/schemas/1001Model" - "$ref": "#/components/schemas/1021Model" - "$ref": "#/components/schemas/1087Model" - "$ref": "#/components/schemas/1088Model" - "$ref": "#/components/schemas/1089Model" - "$ref": "#/components/schemas/1142Model" - "$ref": "#/components/schemas/5046Model" x-apiary-response-examples: error_1001: value: code: 1001 message: Name of the contact is too long. error_1021: value: code: 1021 message: Invalid Phone Number. error_1087: value: code: 1087 message: Customer email id is invalid. error_1088: value: code: 1088 message: Customer email id cannot be more than 40 characters. error_1089: value: code: 1089 message: Customer id is invalid. error_1142: value: code: 1142 message: Customer name cannot be blank error_5046: value: code: 5046 message: The customer is blocked examples: response: value: code: 1001 message: Name of the contact is too long. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Contact Us Request operationId: contactUsRequest description: Contact Us form can be integrated with Birdeye Inbox using Contact Us API. tags: - Contact parameters: - name: businessId in: path description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: customerComment: type: string description: Comment or query by the customer customer: type: object properties: name: type: string description: Name of the customer. emailId: type: string description: Email Id of the Customer. Mandatory if phone not provided. phone: type: string description: Phone No of the Customer. Mandatory if email not provided. required: - name description: Customer details. additionalParams: type: object properties: {} description: Additional Params contains (key,value) pair which can be used to track the customers. required: - customer example: customerComment: What all services do you offer? customer: name: Dummy Name emailId: sam@gmail.com phone: '4424242424' additionalParams: channel: Web utm_campiagn: New Year example: customerComment: What all services do you offer? customer: name: Dummy Name emailId: sam@gmail.com phone: '4424242424' additionalParams: channel: Web utm_campiagn: New Year "/v1/contact/{businessId}/update-feed": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getOptOutContactData_Response200" example: emailOptOut: - id: 1213422 firstName: John lastName: Doe emailId: john@yahoo.com phone: "(212) 234-1242" - id: 1213423 firstName: Johnny lastName: Doe emailId: johnny@yahoo.com phone: "(212) 231-1242" textOptOut: - id: 1213425 firstName: Jane lastName: Doe emailId: john@yahoo.com phone: "(212) 234-1242" - id: 1213423 firstName: Johnny lastName: Doe emailId: johnny@yahoo.com phone: "(212) 231-1242" blocked: - id: 1213422 firstName: John lastName: Doe emailId: john@yahoo.com phone: "(212) 234-1242" - id: 1213423 firstName: Johnny lastName: Doe emailId: johnny@yahoo.com phone: "(212) 231-1242" '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/20083Model" examples: response: value: code: 20083 message: End date can't be before start date '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get opt-out contact data operationId: getOptOutContactData description: API to fetch the daily opt-out or blocked contact data for a business tags: - Contact parameters: - name: businessId in: path description: Id of a business (Long). required: true example: '123456' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Get_opt-out_contact_dataBody" content: application/json: example: end: 1693657040000 start: 1693570640000 subscriptionStatus: - blocked - opted-out "/v1/contact/external/preferences/saveCustomer": post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: number description: Id of enterprise customer. example: id: 115339282 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/5008Model" - "$ref": "#/components/schemas/5043Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_5008: value: code: 5008 message: RequestBody not found error_5043: value: code: 5043 message: Contact not found for the given request examples: response: value: code: 20099 message: Text Communication categorisation is not enabled please use smsOptin flag '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1532Model" examples: response: value: code: 1532 message: Business id is missing or invalid. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Upsert Contact operationId: upsertContact description: Customers can Create or Update Contact API. tags: - Contact V2 parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_upsertContact_Request" example: id: 115339282 firstName: Michael lastName: Scott email: michael@test.com phone: "(212) xxx-xxxx" countryCode: US smsOptin: true blocked: false businessIds: - 161458406365307 - 161072537475129 tags: - Tag One - Tag Two customFields: - fieldName: Company type: text fieldValue: Dunder Mifflin - fieldName: Product type: text fieldValue: Paper externalId: ABC123 emailPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true smsPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true "/v1/contact/external/preferences/getCustomer": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_retrieveContact_Response200" example: id: 115339282 firstName: Michael lastName: Scott email: test.user@test.com phone: "(212) xxx-xxxx" countryCode: US blocked: false smsOptin: true source: api created: January 12, 2021 mappings: - cid: 1234451 location: new horizon bid: 710687 businessNumber: 161458406365307 - cid: 1235452 location: North Carolina bid: 714169 businessNumber: 161072537475129 tags: - Tag One - Tag Two customFields: - fieldName: Company type: text fieldValue: Dunder Mifflin - fieldName: Product type: text fieldValue: Paper externalId: ABC123 emailPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true smsPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/5043Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_5043: value: code: 5043 message: Contact not found for the given request examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1532Model" examples: response: value: code: 1532 message: Business id is missing or invalid. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Retrieve Contact operationId: retrieveContact description: Retrieve a customer's contact profile and associated details. tags: - Contact V2 parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: id: type: string description: Id of enterprise customer. optional (if cid, phone or email is provided). cid: type: string description: Id of customer mapping on a location. optional (if id, phone or email is provided). email: type: string description: Email of customer, optional (if phone, id or cid is provided). phone: type: string description: Phone of customer optional (if email, id or cid is provided). example: id: 115339282 cid: 293847172 email: test.user@test.com phone: "(212) xxx-xxxx" example: id: 115339282 cid: 293847172 email: test.user@test.com phone: "(212) xxx-xxxx" "/v1/contact/external/preferences/checkin": post: responses: '200': description: OK content: application/json: schema: type: object properties: customerId: type: number description: Id of enterprise customer. '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1142Model" x-apiary-response-models: - "$ref": "#/components/schemas/1142Model" - "$ref": "#/components/schemas/1086Model" - "$ref": "#/components/schemas/1087Model" - "$ref": "#/components/schemas/1088Model" - "$ref": "#/components/schemas/1055Model" - "$ref": "#/components/schemas/1170Model" x-apiary-response-examples: error_1142: value: code: 1142 message: Customer name cannot be blank error_1086: value: code: 1086 message: Customer email id cannot be blank. error_1087: value: code: 1087 message: Customer email id is invalid. error_1088: value: code: 1088 message: Customer email id cannot be more than 40 characters. error_1055: value: code: 1055 message: Not a valid US phone number. error_1170: value: code: 1170 message: SMS Alert flag is invalid. Valid values are 0 or 1. examples: response: value: code: 20099 message: Text Communication categorisation is not enabled please use smsOptin flag '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1033Model" x-apiary-response-models: - "$ref": "#/components/schemas/1033Model" - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1175Model" x-apiary-response-examples: error_1033: value: code: 1033 message: You are not authorized to perform this action error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1175: value: code: 1175 message: No business found with the given id examples: response: value: code: 1033 message: You are not authorized to perform this action '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Customer Checkin operationId: customerCheckinPost description: Customer check-in can be done using Check in API. tags: - Contact V2 parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_customerCheckinPost_Request" example: name: Steve Smith emailId: steves@abcd.com phone: 408-xxx-xxxx smsEnabled: 1 additionalParams: Tag Group Name 1: Tag Name 1 Tag Group Name 2: Tag Name 2 location: New York employees: - emailId: sshikha@abcd.com externalId: ABC123 emailPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true smsPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true "/v1/contact/external/preferences/change-permission": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1089Model" examples: response: value: code: 1089 message: Customer id is invalid. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Communication Preferences operationId: updateCommunicationPreferences description: Customer can be subscribe/unsubscribe from Email & SMS using this API. tags: - Contact V2 parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: emailPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: Email communication preference flags. smsPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: SMS communication preference flags. smsOptin: type: boolean description: SMS communication. email: type: array description: Customer email ids. items: {} phone: type: array description: Customer phone numbers. items: {} accountNumber: type: number description: Location id. required: - accountNumber "/v1/contact/external/preferences/update-feed": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_retrieveOptedOutContacts_Response200" example: emailOptOut: - id: 1213422 firstName: John lastName: Doe emailId: john@yahoo.com phone: "(212) 234-1242" optOutFrom: - marketing - feedback - id: 1213423 firstName: Johnny lastName: Doe emailId: johnny@yahoo.com phone: "(212) 231-1242" optOutFrom: - marketing - feedback textOptOut: - id: 1213425 firstName: Jane lastName: Doe emailId: john@yahoo.com phone: "(212) 234-1242" optOutFrom: - marketing - feedback - id: 1213423 firstName: Johnny lastName: Doe emailId: johnny@yahoo.com phone: "(212) 231-1242" optOutFrom: - marketing - feedback blocked: - id: 1213422 firstName: John lastName: Doe emailId: john@yahoo.com phone: "(212) 234-1242" optOutFrom: - marketing - feedback - id: 1213423 firstName: Johnny lastName: Doe emailId: johnny@yahoo.com phone: "(212) 231-1242" optOutFrom: - marketing - feedback '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/20083Model" examples: response: value: code: 20083 message: End date can't be before start date '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Retrieve Opted-Out Contacts operationId: retrieveOptedOutContacts description: API to fetch the daily opt-out or blocked contact data for a business tags: - Contact V2 parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Get_opt-out_contact_dataBody" content: application/json: example: end: 1693657040000 start: 1693570640000 subscriptionStatus: - blocked - opted-out "/v1/campaign/external/campaign-request-url": post: responses: '200': description: OK content: application/json: schema: type: object properties: externalUId: type: number description: Id of the requested URL. url: type: number description: Short link of the requested URL. example: externalUId: 10001805512 url: https://birdeye.cx/a1swor '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1089Model" x-apiary-response-models: - "$ref": "#/components/schemas/1089Model" - "$ref": "#/components/schemas/1040Model" - "$ref": "#/components/schemas/1315Model" x-apiary-response-examples: error_1089: value: code: 1089 message: Customer id is invalid. error_1040: value: code: 1040 message: Invalid temmplate id. error_1315: value: code: 1315 message: Invalid survey. examples: response: value: code: 1089 message: Customer id is invalid. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Fetch Request URL operationId: fetchRequestUrl description: Fetch Request URL gets the short link of the requested URL for the customer. tags: - Campaign parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessId: type: number description: Id of a business (Long). customerId: type: number description: Id of the Customer. surveyId: type: number description: Survey Id, required only for survey requests. templateId: type: number description: Id of Text template, required except for survey requests. checkinId: type: number description: Checkin id of customer. required: - businessId - customerId example: businessId: '100018055' customerId: 39870987 surveyId: 6102 templateId: 1133204 checkinId: 123456 example: businessId: '100018055' customerId: 39870987 surveyId: 6102 templateId: 1133204 checkinId: 123456 "/v1/campaign/external/default-review-sources": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1011: value: code: 1011 message: Business id is invalid examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Set Defaullt Review Sources operationId: setDefaulltReviewSources description: Set Default Review Sources API updates default templates of businesses under a reseller with default review sources (i.e., Google/Facebook). tags: - Campaign parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessId: type: number description: Id of reseller (Long). customerId: type: array description: List of business ids under a reseller. items: {} required: - businessId - customerId "/v1/aggregation/business/{businessId}": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllAggregationSource_Response200" '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get all aggregation source operationId: getAllAggregationSource description: Get source list API returns the list of aggregations associated with the location/SMB. tags: - Aggregation parameters: - name: businessId in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/survey/reviewsites-alias": get: responses: '200': description: OK content: application/json: schema: type: object properties: aliases: type: array description: List of source aliases. items: {} example: aliases: - Google - Citysearch - Yahoo! Local - Yellow Pages - Insider Pages - Superpages - Amazon - Facebook - Realself - ConsumersAdvocate - Vrbo - Tell Management - Rehabs.com '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get all aggregation source operationId: getAllAggregationSourceGet description: Get Source List-lite returns a list of aggregation aliases associated with the location/SMB. tags: - Aggregation parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/aggregation/business/{business_id}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_addAggregationUrl_Response200" examples: response: value: id: 237030543 sourceAlias: citysearch sourceName: Citysearch sourceUrl: http://www.citysearch.com/biz/maria Body: '' '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1030Model" x-apiary-response-models: - "$ref": "#/components/schemas/1030Model" - "$ref": "#/components/schemas/1031Model" - "$ref": "#/components/schemas/1032Model" x-apiary-response-examples: error_1030: value: code: 1030 message: URL cannot be blank error_1031: value: code: 1031 message: Source id cannot be blank error_1032: value: code: 1032 message: Invalid source id examples: response: value: code: 1030 message: URL cannot be blank '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Add aggregation URL operationId: addAggregationUrl description: Add Aggregation Link adds the aggregation URL to the location. tags: - Aggregation parameters: - name: business_id in: path description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Add_aggregation_URLBody" content: application/json: example: sourceAlias: 'citysearch ' url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco "/v1/aggregation/business/{businessID}/aggregation/{aggregationID}": delete: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1039Model" examples: response: value: code: 1039 message: Invalid business aggregation id '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete aggregation URL operationId: deleteAggregationUrl description: Delete Aggregation API deletes aggregation from the location/SMB. tags: - Aggregation parameters: - name: businessID in: path description: Id of the business. required: true example: '12345678' schema: type: string - name: aggregationID in: path description: Id of the aggregation to be deleted. required: true example: abcdefgh schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/reports/smb": get: responses: '200': description: OK content: application/json: schema: type: object properties: allTime: type: object properties: avgRating: type: object properties: percentChange: type: number rating: type: number benchmark: type: object properties: industryRating: type: number industryReviewCount: type: number percentChange: type: number rating: type: number custCommn: type: object properties: {} reviewCount: type: object properties: count: type: number percentChange: type: number sentiments: type: object properties: negative: type: number neutral: type: number positive: type: number visitors: type: object properties: {} last30Days: type: object properties: avgRating: type: object properties: rating: type: number benchmark: type: object properties: industryRating: type: number industryReviewCount: type: number percentChange: type: number rating: type: number custCommn: type: object properties: reviewRequest: type: number reviewRequestSms: type: number shareReview: type: number reviewCount: type: object properties: count: type: number percentChange: type: number sentiments: type: object properties: negative: type: number neutral: type: number positive: type: number visitors: type: object properties: {} negativeReviews: type: array items: type: object properties: comments: type: string rating: type: number response: type: string reviewDate: type: string reviewId: type: string reviewUrl: type: string reviewer: type: object properties: city: type: string nickName: type: string state: type: string thumbnailUrl: type: string sourceType: type: string required: - comments - rating - response - reviewDate - reviewId - reviewUrl - reviewer - sourceType positiveReviews: type: array items: type: object properties: comments: type: string rating: type: number response: type: string reviewDate: type: string reviewId: type: string reviewUrl: type: string reviewer: type: object properties: city: type: string nickName: type: string state: type: string thumbnailUrl: type: string sourceType: type: string required: - comments - rating - response - reviewDate - reviewId - reviewUrl - reviewer - sourceType syndication: type: object properties: presenceCount: type: number reviewDistribution: type: array items: type: object properties: count: type: number name: type: string required: - count - name reviewListings: type: array items: type: object properties: id: type: number name: type: string url: type: string required: - id - name - url example: allTime: avgRating: percentChange: 0 rating: 4.3 benchmark: industryRating: 4.1 industryReviewCount: 75785 percentChange: 4 rating: 4.3 custCommn: {} reviewCount: count: 376 percentChange: 0 sentiments: negative: 45 neutral: 36 positive: 295 visitors: {} last30Days: avgRating: rating: 0 benchmark: industryRating: 0 industryReviewCount: 0 percentChange: 0 rating: 0 custCommn: reviewRequest: 0 reviewRequestSms: 0 shareReview: 0 reviewCount: count: 0 percentChange: 0 sentiments: negative: 0 neutral: 0 positive: 0 visitors: {} negativeReviews: - comments: One word...inconsistent. We had high hopes for this place but alas it was not to be. While the servers were polite, they lacked the professionalism normally expected at most dining establishments...you know, simple things like the waiter introducing himself by name or dropping by to see how we liked the food or refilling our drinks. The minestrone soup was pretty good but the fried calamari was bland, rubbery, obviously over cooked, and did I mention bland. The linguini pescatora was also inconsistent. The pasta in the dish was excellent but the calamari was once again over cooked and rubbery, I got a couple of clams that were not cleaned resulting in a few mouthfuls of dirt, and the shrimp was once again over cooked. We also ordered the margherita pizza with mushrooms and that was pretty good. Overall, we cannot recommend this place. rating: 1 response: '' reviewDate: Jan 30, 2015 reviewId: '2335311245464' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=60fLFX4lRvHnodkhoWC2lw&nb=1 reviewer: city: Yorba Linda nickName: wendy w. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: citysearch - comments: |- Veal Scaloppini, mushrooms, marsala wine, seasonal vegetables and potatoes $24. Flavor was great but disappointed in portion 2 small thin slice, I had better portion in North Beach...my shoe sole was large than this portion. I'm petite size woman; still left hungry....not a hungry man plate. Don't waste your money on this one, men. rating: 2 response: '' reviewDate: Jan 26, 2015 reviewId: '2335208845791' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=FKcQE7naP_Wb4D2ylDsLaQ&nb=1 reviewer: city: San Francisco nickName: Catalina W. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: citysearch - comments: I have to say that this restaurant is very nice but very Loud!:( The bread was old:( The prosciutto appetizer was ridiculous! They only used one slice on six slices of bread:( My husband's main course of the Veal Scallopini was a complete shame! Great sauce but come on! 4 very thin slices of veal w/veggies & red potatoes, he was starving when we got home!:( At $24!!! Ridiculously stingy! My lamb shank & mashed potatoes was superb! No veggies though:( $19 We won't be returning, I was not impressed, I'd rather go to North Beach w/ real Italian dining:) they do have good food but they need to step it up a notch for the prices they charge, I hope they read they're review's so they can change things, Good luck rating: 2 response: '' reviewDate: Jan 26, 2015 reviewId: '2337522245554' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=Xn9XOjZYNknHQu5eF9MteQ&nb=1 reviewer: city: San Francisco nickName: Adele R. state: CA sourceType: citysearch positiveReviews: - comments: Service is awesome- everyone is from Italy and are so sweet and low the menu/specials from head to toe. Great wine selection that's pretty reasonable. The Bruschetta varieties are unique and yummy. Sometimes main dishes can be hit or miss-not very consistent but it's a new restaurant that I can see establish itself a few great dishes overtime. rating: 4 response: '' reviewDate: Jan 23, 2015 reviewId: '2334445645625' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=YYtOE3hvBjp4jYtLgtgBoQ&nb=1 reviewer: city: San Francisco nickName: Anastasia P. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: citysearch - comments: I've been here 3 times in the past year, & it's been good every time. rating: 4 response: '' reviewDate: Jan 23, 2015 reviewId: '2333514245697' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=3kiZtC-tj-FGLO3GPRqNDA&nb=1 reviewer: city: Daly City nickName: Matt L. state: CA sourceType: Citysearch - comments: Owner is awesome! ! Came here tonight with my parents and sister's family. .highly recommended! ! I will definitely come back here again! rating: 5 response: '' reviewDate: Jan 21, 2015 reviewId: '2336865297689' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=U8mRtt5vA93l0n7j2H1J_w&nb=1 reviewer: city: San Francisco nickName: Johnny C. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: Citysearch syndication: presenceCount: 0 reviewDistribution: - count: 328 name: citysearch - count: 8 name: Google - count: 1 name: Yellow Pages - count: 16 name: Foursquare - count: 23 name: Facebook reviewListings: - id: 2 name: Google url: https://plus.google.com/112610500708977805079/about?gl=US&hl=en-US - id: 3 name: Citysearch url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco - id: 4 name: Yahoo! Local url: https://local.yahoo.com/info-148859369-maria-da-vittorio-san-francisco - id: 5 name: Yellow Pages url: http://www.yellowpages.com/san-francisco-ca/mip/maria-da-vittorio-478366944 - id: 10 name: Foursquare url: https://foursquare.com/v/maria-da-vittorio/5195394d498e344eeb952b4f - id: 16 name: Superpages url: http://www.superpages.com/bp/San-Francisco-CA/maria-Da-Vittorio-L2450131113.htm - id: 33 name: Merchant Circle url: http://www.merchantcircle.com/business/maria.Da.Vittorio.415-592-8398 - id: 63 name: YellowBot url: http://www.yellowbot.com/maria-da-vittorio-san-francisco-ca.html - id: 84 name: MapQuest url: http://www.mapquest.com/us/california/italian-restaurants-san-francisco/maria-da-vittorio-284984723 - id: 110 name: Facebook url: https://www.facebook.com/mariadavittorio example: allTime: avgRating: percentChange: 0 rating: 4.3 benchmark: industryRating: 4.1 industryReviewCount: 75785 percentChange: 4 rating: 4.3 custCommn: {} reviewCount: count: 376 percentChange: 0 sentiments: negative: 45 neutral: 36 positive: 295 visitors: {} last30Days: avgRating: rating: 0 benchmark: industryRating: 0 industryReviewCount: 0 percentChange: 0 rating: 0 custCommn: reviewRequest: 0 reviewRequestSms: 0 shareReview: 0 reviewCount: count: 0 percentChange: 0 sentiments: negative: 0 neutral: 0 positive: 0 visitors: {} negativeReviews: - comments: One word...inconsistent. We had high hopes for this place but alas it was not to be. While the servers were polite, they lacked the professionalism normally expected at most dining establishments...you know, simple things like the waiter introducing himself by name or dropping by to see how we liked the food or refilling our drinks. The minestrone soup was pretty good but the fried calamari was bland, rubbery, obviously over cooked, and did I mention bland. The linguini pescatora was also inconsistent. The pasta in the dish was excellent but the calamari was once again over cooked and rubbery, I got a couple of clams that were not cleaned resulting in a few mouthfuls of dirt, and the shrimp was once again over cooked. We also ordered the margherita pizza with mushrooms and that was pretty good. Overall, we cannot recommend this place. rating: 1 response: '' reviewDate: Jan 30, 2015 reviewId: '2335311245464' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=60fLFX4lRvHnodkhoWC2lw&nb=1 reviewer: city: Yorba Linda nickName: wendy w. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: citysearch - comments: |- Veal Scaloppini, mushrooms, marsala wine, seasonal vegetables and potatoes $24. Flavor was great but disappointed in portion 2 small thin slice, I had better portion in North Beach...my shoe sole was large than this portion. I'm petite size woman; still left hungry....not a hungry man plate. Don't waste your money on this one, men. rating: 2 response: '' reviewDate: Jan 26, 2015 reviewId: '2335208845791' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=FKcQE7naP_Wb4D2ylDsLaQ&nb=1 reviewer: city: San Francisco nickName: Catalina W. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: citysearch - comments: I have to say that this restaurant is very nice but very Loud!:( The bread was old:( The prosciutto appetizer was ridiculous! They only used one slice on six slices of bread:( My husband's main course of the Veal Scallopini was a complete shame! Great sauce but come on! 4 very thin slices of veal w/veggies & red potatoes, he was starving when we got home!:( At $24!!! Ridiculously stingy! My lamb shank & mashed potatoes was superb! No veggies though:( $19 We won't be returning, I was not impressed, I'd rather go to North Beach w/ real Italian dining:) they do have good food but they need to step it up a notch for the prices they charge, I hope they read they're review's so they can change things, Good luck rating: 2 response: '' reviewDate: Jan 26, 2015 reviewId: '2337522245554' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=Xn9XOjZYNknHQu5eF9MteQ&nb=1 reviewer: city: San Francisco nickName: Adele R. state: CA sourceType: citysearch positiveReviews: - comments: Service is awesome- everyone is from Italy and are so sweet and low the menu/specials from head to toe. Great wine selection that's pretty reasonable. The Bruschetta varieties are unique and yummy. Sometimes main dishes can be hit or miss-not very consistent but it's a new restaurant that I can see establish itself a few great dishes overtime. rating: 4 response: '' reviewDate: Jan 23, 2015 reviewId: '2334445645625' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=YYtOE3hvBjp4jYtLgtgBoQ&nb=1 reviewer: city: San Francisco nickName: Anastasia P. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: citysearch - comments: I've been here 3 times in the past year, & it's been good every time. rating: 4 response: '' reviewDate: Jan 23, 2015 reviewId: '2333514245697' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=3kiZtC-tj-FGLO3GPRqNDA&nb=1 reviewer: city: Daly City nickName: Matt L. state: CA sourceType: Citysearch - comments: Owner is awesome! ! Came here tonight with my parents and sister's family. .highly recommended! ! I will definitely come back here again! rating: 5 response: '' reviewDate: Jan 21, 2015 reviewId: '2336865297689' reviewUrl: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco?hrid=U8mRtt5vA93l0n7j2H1J_w&nb=1 reviewer: city: San Francisco nickName: Johnny C. state: CA thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/9a070cf98f014f5d9b06987dcc9c48fe.jpeg sourceType: Citysearch syndication: presenceCount: 0 reviewDistribution: - count: 328 name: citysearch - count: 8 name: Google - count: 1 name: Yellow Pages - count: 16 name: Foursquare - count: 23 name: Facebook reviewListings: - id: 2 name: Google url: https://plus.google.com/112610500708977805079/about?gl=US&hl=en-US - id: 3 name: Citysearch url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco - id: 4 name: Yahoo! Local url: https://local.yahoo.com/info-148859369-maria-da-vittorio-san-francisco - id: 5 name: Yellow Pages url: http://www.yellowpages.com/san-francisco-ca/mip/maria-da-vittorio-478366944 - id: 10 name: Foursquare url: https://foursquare.com/v/maria-da-vittorio/5195394d498e344eeb952b4f - id: 16 name: Superpages url: http://www.superpages.com/bp/San-Francisco-CA/maria-Da-Vittorio-L2450131113.htm - id: 33 name: Merchant Circle url: http://www.merchantcircle.com/business/maria.Da.Vittorio.415-592-8398 - id: 63 name: YellowBot url: http://www.yellowbot.com/maria-da-vittorio-san-francisco-ca.html - id: 84 name: MapQuest url: http://www.mapquest.com/us/california/italian-restaurants-san-francisco/maria-da-vittorio-284984723 - id: 110 name: Facebook url: https://www.facebook.com/mariadavittorio '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Dashboard data operationId: getDashboardData description: Get Dashboard Data API gives you an overview of business data with data points like review & rating count, sentiment of reviews, negative/positive reviews, and past 30 days' reviews with review responses. tags: - Report parameters: - name: bid in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/reports/business/analytics/email": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getReviewConversionReport_Response200" example: emailSentInfo: total: 28 emailDetails: - reqType: share_request count: 5 - reqType: share_request_reminder count: 3 - reqType: review_request count: 12 - reqType: review_request_reminder count: 10 emailOpenInfo: total: 26 pc: 14 mobile: ios: 5 android: 4 other: 0 tablet: ios: 3 android: 0 other: 0 emailClickInfo: total: 20 pc: citysearch: 4 google: 6 birdeye: 4 otherSites: 0 mobile: citysearch: 2 google: 0 birdeye: 4 otherSites: 0 reviews: - sourceName: citysearch sourceAlias: citysearch avgRating: 4.6 reviewCount: 159 - sourceName: Google sourceAlias: google avgRating: 4.9 reviewCount: 8 - sourceName: Yellow Pages sourceAlias: yellow_pages avgRating: 5 reviewCount: 1 smsDetail: msgSent: 34 msgClick: 28 destination: citysearch: 12 google: 6 birdeye: 10 otherSites: 0 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1039Model" examples: response: value: code: 1039 message: Invalid business aggregation id '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Review conversion report operationId: getReviewConversionReport description: Review conversion report API gives you the detail overview of the review request send to the customer. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: fromDate in: query description: Date from result is expected. Format MM/DD/YYYY. required: false example: 01/13/2021 schema: type: string - name: toDate in: query description: Date up to result is expected. Format MM/DD/YYYY. required: false example: 01/21/2021 schema: type: string - name: days in: query description: Use to get results for last some days. required: false example: '120' schema: type: number - name: months in: query description: Use to get results for last some months. required: false example: '2' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/reports/review/analytic/time": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewAndRatingOverTimeReport_Response200" '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Review and rating over time Report operationId: reviewAndRatingOverTimeReport description: Review and rating over time API gives you the number of reviews and average rating in accordance with the time. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: sortby in: query description: Values can be 'count' or 'rating'. required: false example: rating schema: type: string - name: sorder in: query description: "'0' for ascending and '1' for descending order." required: false example: '0' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: sourceAliases: type: array description: List of source aliases. items: {} businessNumbers: type: array description: List of business number. items: {} days: type: number description: Use to get results for last some days. example: sourceAliases: - 'citysearch ' - google businessNumbers: - '943967608' - '943476803' days: 12 example: sourceAliases: - 'citysearch ' - google businessNumbers: - '943967608' - '943476803' days: 12 "/v1/reports/rating/location": post: responses: '200': description: OK content: application/json: schema: type: object properties: rating: type: number description: Average Rating for the particular location. count: type: number description: Number of reviews for the particular location. milestone: type: string description: Name of the Location. businessId: type: number description: Business number of the location. state: type: string description: State. example: - rating: 4.6 count: 132 milestone: Smile dental businessId: 943967608 state: CA - rating: 3.2 count: 367 milestone: Blaze Dental businessId: 943589678 state: CA '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Reviews & Rating By Location Report operationId: reviews&RatingByLocationReport description: Reviews & Rating By Location gives an overall view of how many reviews, and the average ratings are associated with each location. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: sortby in: query description: Values can be 'count' or 'rating'. required: false example: rating schema: type: string - name: sorder in: query description: "'0' for ascending and '1' for descending order." required: false example: '0' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Reviews_Rating_By_Location_ReportBody" content: application/json: example: sourceAliases: - 'citysearch ' - google businessNumbers: - '943967608' - '943476803' months: 12 "/v1/review/report/count-by-rating/{BusinessId}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewCount_Rating_Response200" example: reviewCount: 108 countByRating: - rating: 0 count: 17 - rating: 1 count: 19 - rating: 2 count: 3 - rating: 3 count: 14 - rating: 4 count: 11 - rating: 5 count: 44 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Review Count & Rating operationId: reviewCount&Rating description: Review Count & Rating API fetches the review count according to the rating. tags: - Report parameters: - name: BusinessId in: path description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: Business Numbers under enterprise account. items: {} sourceAlias: type: string description: Alias of the source. fromDate: type: string description: Review date (start). toDate: type: string description: Review date (end). example: businessNumbers: - 145308764185002 - 145308769721320 sourceAlias: - google - citysearch fromDate: 04/01/2013 toDate: 05/3/2015 example: businessNumbers: - 145308764185002 - 145308769721320 sourceAlias: - google - citysearch fromDate: 04/01/2013 toDate: 05/3/2015 "/v1/review/report/count-by-rating/employee/{BusinessId}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewCount_RatingByEmployee_Response200" example: employees: - employee: firstName: David lastName: Wood phone: '4424242424' countByRating: - rating: 0 count: 0 - rating: 1 count: 1 - rating: 2 count: 0 - rating: 3 count: 0 - rating: 4 count: 2 - rating: 5 count: 1 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Review Count & Rating By Employee operationId: reviewCount&RatingByEmployee description: Review Count & Rating By Employee returns review count by rating associated with each assisted employee. tags: - Report parameters: - name: BusinessId in: path description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewCount_RatingByEmployee_Request" example: businessNumbers: - 145308764185002 - 145308769721320 sourceAlias: - google - citysearch employees: - firstName: David lastName: Wood phone: '4424242424' fromDate: 04/01/2013 toDate: 05/3/2015 "/v1/keywords/opmetric/location": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_insightsCategoryReportByLocationReport_Response200" example: - alias: 7653 - Xrtrm - Balltown Rd avgScore: 4 grade: A totalCount: 1679 metricForLocn: Beverages: category: Beverages avgScore: 3.8 count: 5 grade: B+ Assortment (Beverages): category: Assortment parentCategory: Beverages avgScore: 5 count: 1 grade: A+ Utensils: category: Utensils avgScore: 0 count: 0 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Insights Category Report by location report operationId: insightsCategoryReportByLocationReport description: Insights Category Report by location provides the location-wise insights category data in the response. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: startDate: type: string description: Start Date format MM/dd/YYYY. endDate: type: string description: End Date format MM/dd/YYYY. reviewSites: type: array description: List of Souce Ids. items: {} businessNumbers: type: array description: List of business numbers. items: {} example: startDate: 04/01/2013 endDate: 05/3/2015 reviewSites: - '2' - '110' - '1' - '100' - '3' - '303' - '6' - '84' - '33' - '202' - '25' - '21' - '4' - '5' - '63' businessNumbers: - '9489687712' - '2136910876' example: startDate: 04/01/2013 endDate: 05/3/2015 reviewSites: - '2' - '110' - '1' - '100' - '3' - '303' - '6' - '84' - '33' - '202' - '25' - '21' - '4' - '5' - '63' businessNumbers: - '9489687712' - '2136910876' "/v2/competitive/ranking": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_competitiveRankingReport_Response200" example: positiveCount: 218305 neutralCount: 18600 negativeCount: 22794 positivePercent: 84.0 neutralPercent: 7.0 negativePercent: 9.0 name: Pizza Palace count: 259699 rating: 4.339487006543244 competitors: - positiveCount: 249953 neutralCount: 21827 negativeCount: 16876 positivePercent: 87.0 neutralPercent: 8.0 negativePercent: 6.0 name: Family Pizza count: 288656 rating: 4.457812929751687 - positiveCount: 13148 neutralCount: 2239 negativeCount: 2051 positivePercent: 75.0 neutralPercent: 13.0 negativePercent: 12.0 name: Veggie Pizza and Grill count: 17438 rating: 4.126577756608716 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Competitive Ranking Report operationId: competitiveRankingReport description: Competitive Ranking Report provides the competitors ranking & rating data in the response for a business. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Competitive_Ranking_ReportBody" content: application/json: example: startDate: 10/08/2019 endDate: 01/15/2020 reviewSites: - '2' - '110' "/v1/reports/nps/time/elst": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_nPSOverTimeReport_Response200" example: totalCount: 2 avgNpsScore: "-50" promoters: '0' passives: '50' detractors: '50' dataPoints: - label: 10/08/2019 - 10/13/2019 shortLabel: Oct 08-Oct 13 2019 startDate: 10/08/2019 endDate: 10/13/2019 dynamicLabel: header: label value: 10/08/2019 order: 2147483647 cellType: TEXT detractorPercentile: 100 passivePercentile: 0 promoterPercentile: 0 npsScore: -100 positiveCount: 0 negativeCount: 1 neutralCount: 0 totalCount: 1 - label: 10/14/2019 - 10/20/2019 shortLabel: Oct 14-Oct 20 2019 startDate: 10/14/2019 endDate: 10/20/2019 dynamicLabel: header: label value: 10/14/2019 order: 2147483647 cellType: TEXT detractorPercentile: 0 passivePercentile: 100 promoterPercentile: 0 npsScore: 0 positiveCount: 0 negativeCount: 0 neutralCount: 1 totalCount: 1 groupByType: week dateDiff: 100 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: NPS Over time Report operationId: nPSOverTimeReport description: NPS Over time gives you the NPS score for a selected period of time for all locations across businesses and the count of promoters, passives, and detractors for this business. The report can be grouped per day/week/month/year. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Competitive_Ranking_ReportBody" content: application/json: example: startDate: 10/08/2019 endDate: 01/15/2020 reviewSites: - '2' - '110' "/v1/reports/nps/location/elst": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_nPSByLocationReport_Response200" example: totalCount: 2 avgNpsScore: "-50" promoters: '0' passives: '50' detractors: '50' dataPoints: - nodeId: 1398773 label: Anjou dynamicLabel: header: Location value: Anjou order: 2147483647 cellType: TEXT detractorPercentile: 50 passivePercentile: 50 promoterPercentile: 0 npsScore: -50 positiveCount: 0 negativeCount: 1 neutralCount: 1 totalCount: 2 businessNumber: 172712121274890 dateDiff: 100 totalPages: 1 page: 0 size: 1 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: NPS By Location Report operationId: nPSByLocationReport description: NPS By Location gives you the NPS score for each location and the count of promoters, passives, and detractors for the business. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: startDate: type: string description: Start Date format MM/dd/YYYY. endDate: type: string description: End Date format MM/dd/YYYY. reviewSites: type: array description: List of Souce Ids. items: {} businessNumbers: type: array description: List of business numbers. items: {} example: startDate: 10/08/2019 endDate: 01/15/2020 reviewSites: - '2' - '110' businessNumbers: - '9489676910876' - '9434065498803' example: startDate: 10/08/2019 endDate: 01/15/2020 reviewSites: - '2' - '110' businessNumbers: - '9489676910876' - '9434065498803' "/v1/reports/count/reviewsite": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewBySourceReport_Response200" example: - count: 1132 milestone: Smile Dental businessId: '943967608' reviewSites: - sourceAlias: Citysearch count: 4 - sourceAlias: GooglePlay count: 1060 - sourceAlias: bestcreditrepaircompany count: 1 - sourceAlias: Birdeye count: 67 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Review By Source Report operationId: reviewBySourceReport description: Review By Source API groups the number of reviews and average ratings in an account according to the aggregation source. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Reviews_Rating_By_Location_ReportBody" content: application/json: example: sourceAliases: - 'citysearch ' - google businessNumbers: - '943967608' - '943476803' months: 12 "/v1/reports/count/visitors": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_visitorReport_Response200" example: - count: 315 milestone: Smile Dental businessId: '943967608' visitors: - sourceAlias: Facebook count: 0 - sourceAlias: Google count: 0 - sourceAlias: Twitter count: 0 - sourceAlias: Review Site count: 289 - sourceAlias: Website count: 26 - sourceAlias: Total count: 315 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Visitor report operationId: visitorReport description: Visitor report groups the data according to source. tags: - Report parameters: - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Reviews_Rating_By_Location_ReportBody" content: application/json: example: sourceAliases: - 'citysearch ' - google businessNumbers: - '943967608' - '943476803' months: 12 "/v1/reports/usage": post: responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: name: type: string alias1: type: string emailSentInfo: type: object properties: total: type: number percent: type: number reqCount: type: number reqReminderCount: type: number shareReqCount: type: number shareReqReminderCount: type: number emailOpenInfo: type: object properties: total: type: number percent: type: number reqCount: type: number reqReminderCount: type: number shareReqCount: type: number shareReqReminderCount: type: number emailClickInfo: type: object properties: total: type: number percent: type: number rcmdCount: type: array items: type: object properties: name: type: string count: type: number percent: type: number sourceId: type: number required: - name - count - percent - sourceId nonRcmdCount: type: array items: type: object properties: name: type: string count: type: number percent: type: number sourceId: type: number rcmdReviewsCount: type: array items: type: object properties: sourceId: type: number sourceName: type: string sourceAlias: type: string avgRating: nullable: true reviewCount: type: number required: - sourceId - sourceName - sourceAlias - avgRating - reviewCount nonRcmdReviewsCount: type: array items: type: object properties: sourceId: type: number sourceName: type: string sourceAlias: type: string avgRating: nullable: true reviewCount: type: number smsSentInfo: type: object properties: total: type: number percent: type: number reqCount: type: number reqReminderCount: type: number shareReqCount: type: number shareReqReminderCount: type: number smsOpenInfo: type: object properties: total: type: number percent: type: number reqCount: type: number reqReminderCount: type: number shareReqCount: type: number shareReqReminderCount: type: number smsClickInfo: type: object properties: total: type: number percent: type: number rcmdCount: type: array items: type: object properties: name: type: string count: type: number percent: type: number sourceId: type: number required: - name - count - percent - sourceId nonRcmdCount: type: array items: type: object properties: name: type: string count: type: number percent: type: number sourceId: type: number totalReviewsCount: type: number example: - name: Total alias1: Total emailSentInfo: total: 15990 percent: 0 reqCount: 15990 reqReminderCount: 37034 shareReqCount: 0 shareReqReminderCount: 0 emailOpenInfo: total: 10316 percent: 64.5 reqCount: 10316 reqReminderCount: 0 shareReqCount: 0 shareReqReminderCount: 0 emailClickInfo: total: 1370 percent: 8.6 rcmdCount: - name: Google count: 683 percent: 49.9 sourceId: 2 - name: Facebook count: 263 percent: 19.2 sourceId: 110 - name: Birdeye count: 4 percent: 0.3 sourceId: 100 nonRcmdCount: - name: Birdeye count: 420 percent: 30.7 sourceId: 100 rcmdReviewsCount: - sourceId: 2 sourceName: Google sourceAlias: Google avgRating: reviewCount: 1297 - sourceId: 110 sourceName: Facebook sourceAlias: Facebook avgRating: reviewCount: 517 - sourceId: 100 sourceName: Birdeye sourceAlias: birdeye avgRating: reviewCount: 176 - sourceId: 1 sourceName: Yelp sourceAlias: Yelp avgRating: reviewCount: 171 - sourceId: 25 sourceName: The Knot sourceAlias: The Knot avgRating: reviewCount: 6 - sourceId: 21 sourceName: Wedding Wire sourceAlias: Wedding Wire avgRating: reviewCount: 1 nonRcmdReviewsCount: - sourceId: 100 sourceName: Birdeye sourceAlias: birdeye avgRating: reviewCount: 516 smsSentInfo: total: 39980 percent: 0 reqCount: 39980 reqReminderCount: 0 shareReqCount: 0 shareReqReminderCount: 0 smsOpenInfo: total: 2340 percent: 5.9 reqCount: 2340 reqReminderCount: 0 shareReqCount: 0 shareReqReminderCount: 0 smsClickInfo: total: 1558 percent: 3.9 rcmdCount: - name: Google count: 850 percent: 54.6 sourceId: 2 - name: Facebook count: 425 percent: 27.3 sourceId: 110 - name: Birdeye count: 2 percent: 0.1 sourceId: 100 nonRcmdCount: - name: Birdeye count: 281 percent: 18 sourceId: 100 totalReviewsCount: 2684 example: - name: Total alias1: Total emailSentInfo: total: 15990 percent: 0 reqCount: 15990 reqReminderCount: 37034 shareReqCount: 0 shareReqReminderCount: 0 emailOpenInfo: total: 10316 percent: 64.5 reqCount: 10316 reqReminderCount: 0 shareReqCount: 0 shareReqReminderCount: 0 emailClickInfo: total: 1370 percent: 8.6 rcmdCount: - name: Google count: 683 percent: 49.9 sourceId: 2 - name: Facebook count: 263 percent: 19.2 sourceId: 110 - name: Birdeye count: 4 percent: 0.3 sourceId: 100 nonRcmdCount: - name: Birdeye count: 420 percent: 30.7 sourceId: 100 rcmdReviewsCount: - sourceId: 2 sourceName: Google sourceAlias: Google avgRating: reviewCount: 1297 - sourceId: 110 sourceName: Facebook sourceAlias: Facebook avgRating: reviewCount: 517 - sourceId: 100 sourceName: Birdeye sourceAlias: birdeye avgRating: reviewCount: 176 - sourceId: 1 sourceName: Yelp sourceAlias: Yelp avgRating: reviewCount: 171 - sourceId: 25 sourceName: The Knot sourceAlias: The Knot avgRating: reviewCount: 6 - sourceId: 21 sourceName: Wedding Wire sourceAlias: Wedding Wire avgRating: reviewCount: 1 nonRcmdReviewsCount: - sourceId: 100 sourceName: Birdeye sourceAlias: birdeye avgRating: reviewCount: 516 smsSentInfo: total: 39980 percent: 0 reqCount: 39980 reqReminderCount: 0 shareReqCount: 0 shareReqReminderCount: 0 smsOpenInfo: total: 2340 percent: 5.9 reqCount: 2340 reqReminderCount: 0 shareReqCount: 0 shareReqReminderCount: 0 smsClickInfo: total: 1558 percent: 3.9 rcmdCount: - name: Google count: 850 percent: 54.6 sourceId: 2 - name: Facebook count: 425 percent: 27.3 sourceId: 110 - name: Birdeye count: 2 percent: 0.1 sourceId: 100 nonRcmdCount: - name: Birdeye count: 281 percent: 18 sourceId: 100 totalReviewsCount: 2684 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Usage report operationId: usageReport description: Usage report gives the usage details for the review requests, and the number of requests sent, opened and clicked. tags: - Report parameters: - name: business_id in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: reportType in: query description: The type of Report - Summary or Tabular. required: true example: rating schema: type: string - name: sindex in: query description: The starting index of the reviews required: true example: '0' schema: type: number - name: count in: query description: The number of reviews to query required: true example: '100' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: startDate: type: string description: Start date. endDate: type: string description: End date. reviewSites: type: array description: List of review sites. items: {} ratings: type: array description: List of ratings. items: {} days: type: number description: Use to get results for last some days. groupByDays: type: number description: Group by days. reviewSiteAllFlag: type: boolean description: Pass true if you want to get data from all sources. "/v1/review/report/response-rate/time/rate-over-time": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewResponseRateOverTime_Response200" example: summary: actual: totalCount: 94 avgRating: 4.2 responseRate: 5 unrespondedRate: 95 unrespondedCount: 89 respondedCount: 5 unrespondedCountGrowth: 89.4 respondedCountGrowth: 400.0 totalCountGrowth: 95.8 responseRateGrowth: 150.0 compare: totalCount: 48 avgRating: 4.1 responseRate: 2 unrespondedRate: 98 unrespondedCount: 47 respondedCount: 1 dataPoints: - actual: label: Feb 24, 2025 - Mar 2, 2025 shortLabel: Feb 24 - Mar 2 '25 totalCount: 0 startDate: 02/24/2025 endDate: 03/02/2025 responseRate: 0 unrespondedCount: 0 respondedCount: 0 respondedCountGrowth: 0.0 totalCountGrowth: 0.0 responseRateGrowth: 0.0 compare: label: Mar 19, 2024 - Mar 24, 2024 shortLabel: Mar 19 - Mar 24 '24 totalCount: 0 startDate: 03/19/2024 endDate: 03/24/2024 responseRate: 0 unrespondedCount: 0 respondedCount: 0 dateDiff: 341 groupByType: week dataPresent: true '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Review Response Rate Over Time operationId: reviewResponseRateOverTime description: Review Response Rate Over Time API returns response-rate trends over time, with optional previous-period comparison. tags: - Report parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Business number of the location. required: false example: "[Required] Business number of the location." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Review_Response_Rate_Over_TimeBody" content: application/json: example: reviewSites: - 2 - 1 - 110 - 100 ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 comparisonFilter: startDate: 01/01/2025 endDate: 01/10/2025 "/v1/review/report/response-rate/by-location/overview": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_reviewResponseRateByLocationOverview_Response200" example: summary: actual: totalCount: 0 responseRate: 0 unrespondedRate: 0 unrespondedCount: 0 respondedCount: 0 compare: totalCount: 0 responseRate: 0 unrespondedRate: 0 unrespondedCount: 0 respondedCount: 0 dataPoints: - actual: label: Plano, TX totalCount: 0 responseRate: 0 unrespondedRate: 0 unrespondedCount: 0 respondedCount: 0 businessNumber: 175457918679707 compare: label: Plano, TX totalCount: 0 responseRate: 0 unrespondedRate: 0 unrespondedCount: 0 respondedCount: 0 businessNumber: 175457918679707 - actual: label: Honda Complex totalCount: 0 responseRate: 0 unrespondedRate: 0 unrespondedCount: 0 respondedCount: 0 businessNumber: 175700720136654 compare: label: Honda Complex totalCount: 0 responseRate: 0 unrespondedRate: 0 unrespondedCount: 0 respondedCount: 0 businessNumber: 175700720136654 dataPresent: false '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Review Response Rate By Location Overview operationId: reviewResponseRateByLocationOverview description: Review Response Rate By Location Overview API returns location-wise response-rate metrics. tags: - Report parameters: - name: order in: query description: Sort order. `1` for descending, `0` for ascending. required: false example: '1' schema: type: number - name: sortBy in: query description: Field used for sorting, for example `rate`. required: false example: rate schema: type: string - name: startIndex in: query description: Starting index for pagination. required: false example: '0' schema: type: number - name: size in: query description: Number of records to return. required: false example: '100' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Business number of the location. required: false example: "[Required] Business number of the location." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Review_Response_Rate_Over_TimeBody" content: application/json: example: reviewSites: - 2 - 1 - 110 - 100 ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 comparisonFilter: startDate: 01/01/2025 endDate: 01/10/2025 "/v1/review/report/avg-response-time/by-location": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_averageResponseTimeByLocation_Response200" example: summary: actual: avgResponseTime: days: 2357.9 hours: 56589.57 minutes: 3395374.0 respondedCount: 80 compare: avgResponseTime: days: 0.0 hours: 0.0 minutes: 0.0 respondedCount: 0 dataPoints: - actual: label: Vignesh avgResponseTime: days: 2493.24 hours: 59837.72 minutes: 3590263.0 respondedCount: 70 businessNumber: 174436684666401 compare: label: Vignesh avgResponseTime: days: 0.0 hours: 0.0 minutes: 0.0 respondedCount: 0 businessNumber: 174436684666401 - actual: label: Assembly Row avgResponseTime: days: 1410.52 hours: 33852.52 minutes: 2031151.4 respondedCount: 10 businessNumber: 172957184851864 compare: label: Assembly Row avgResponseTime: days: 0.0 hours: 0.0 minutes: 0.0 respondedCount: 0 businessNumber: 172957184851864 dateDiff: 6792 groupByType: quarter dataPresent: true '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Average Response Time By Location operationId: averageResponseTimeByLocation description: Average Response Time By Location API returns location-wise average response-time metrics. tags: - Report parameters: - name: order in: query description: Sort order. `1` for descending, `0` for ascending. required: false example: '1' schema: type: number - name: sortBy in: query description: Field used for sorting. required: false example: avg-resp-time schema: type: string - name: startIndex in: query description: Starting index for pagination. required: false example: '0' schema: type: number - name: size in: query description: Number of records to return. required: false example: '100' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Business number of the location. required: false example: "[Required] Business number of the location." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Review_Response_Rate_Over_TimeBody" content: application/json: example: reviewSites: - 2 - 1 - 110 - 100 ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 comparisonFilter: startDate: 01/01/2025 endDate: 01/10/2025 "/v1/review/report/avg-response-time/time": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_averageResponseTimeOverTime_Response200" example: summary: actual: avgResponseTime: days: 2357.9 hours: 56589.57 minutes: 3395374.0 respondedCount: 80 compare: avgResponseTime: days: 0.0 hours: 0.0 minutes: 0.0 respondedCount: 0 dataPoints: - actual: label: Apr 2017 - Jun 2017 shortLabel: Q2 2017 startDate: 04/01/2017 endDate: 06/30/2017 avgResponseTime: days: 27.08 hours: 649.83 minutes: 38990.08 respondedCount: 1 compare: label: Apr 2016 - Jun 2016 shortLabel: Q2 2016 startDate: 04/01/2016 endDate: 06/30/2016 avgResponseTime: days: 0.0 hours: 0.0 minutes: 0.0 respondedCount: 0 - actual: label: Jul 2017 - Sep 2017 shortLabel: Q3 2017 startDate: 07/01/2017 endDate: '09/30/2017' avgResponseTime: days: 3.43 hours: 82.28 minutes: 4936.62 respondedCount: 1 compare: label: Jul 2016 - Sep 2016 shortLabel: Q3 2016 startDate: 07/01/2016 endDate: '09/30/2016' avgResponseTime: days: 0.0 hours: 0.0 minutes: 0.0 respondedCount: 0 dateDiff: 6792 groupByType: quarter dataPresent: true '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Average Response Time Over Time operationId: averageResponseTimeOverTime description: Average Response Time Over Time API returns average response-time trends over time, with optional previous-period comparison. tags: - Report parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Business number of the location. required: false example: "[Required] Business number of the location." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Review_Response_Rate_Over_TimeBody" content: application/json: example: reviewSites: - 2 - 1 - 110 - 100 ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 comparisonFilter: startDate: 01/01/2025 endDate: 01/10/2025 "/v1/survey/{survey_id}": get: responses: '200': description: OK content: application/json: example: surveyId: 535 logoUrl: https://d2xt3xymj142xp.cloudfront.net/145301531829695/logo%2F57db1409813c70.82884191.png name: JetBlue Customer Satisfaction Survey status: new created: 1484941995000 lastModified: 1484941995000 responses: 0 questionCount: 4 pages: - name: Introduction id: 2316 order: 0 showQuestionNumbers: 1 visible: false questions: - title: Thank you for traveling with JetBlue Airways! We’d love to hear about your recent trip with us. Your feedback will help us improve the way we serve you name: Question name showQuestionNumbers: 1 id: 10315 skipQuestion: false displayQuestion: false minimumValue: 0 maximumValue: 0 order: 0 visible: true isRequired: true type: label reactElementId: 493 value: [] choices: [] rows: [] skipLogic: [] displayLogic: [] - title: How was your trip today name: Question name showQuestionNumbers: 1 id: 10314 skipQuestion: false displayQuestion: false minimumValue: 0 maximumValue: 0 order: 1 visible: true isRequired: true type: radio reactElementId: 840 value: [] choices: - id: 22854 title: Satified order: 0 - id: 22856 title: Needs Improvement order: 1 - id: 22855 title: Dissatiffied order: 2 rows: [] skipLogic: [] displayLogic: [] - title: Please rate us based on your experience name: Question name showQuestionNumbers: 1 id: 10316 skipQuestion: false displayQuestion: false maximumRateDescription: Excellent minimumRateDescription: Poor minimumValue: 1 maximumValue: 10 order: 2 visible: true isRequired: true type: rating reactElementId: 101 value: [] choices: [] rows: [] skipLogic: [] displayLogic: [] - title: Thanks for your feedback! Please let us know how we can serve you better name: Question name showQuestionNumbers: 1 id: 10317 skipQuestion: false displayQuestion: false minimumValue: 0 maximumValue: 0 order: 3 visible: true isRequired: true type: textarea reactElementId: 813 value: [] choices: [] rows: [] skipLogic: [] displayLogic: [] supportedLocales: [] buttonTexts: - id: 2096 locale: en textKey: Start localeText: Start - id: 2097 locale: en textKey: Cancel localeText: Cancel - id: 2098 locale: en textKey: Back localeText: Back - id: 2099 locale: en textKey: Next localeText: Next - id: 2100 locale: en textKey: Done localeText: Done - id: 2101 locale: en textKey: Finish localeText: Finish - id: 2102 locale: en textKey: Submit localeText: Submit - id: 2103 locale: en textKey: notNow localeText: Not Now businessId: 145301531829695 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1315Model" x-apiary-response-models: - "$ref": "#/components/schemas/1315Model" - "$ref": "#/components/schemas/1161Model" x-apiary-response-examples: error_1315: value: code: 1315 message: Invalid survey. error_1161: value: code: 1161 message: Invalid API key examples: response: value: code: 1315 message: Invalid survey. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Survey operationId: getSurvey description: Get Survey fetches the survey designer page details for a particular survey. It provides all the questions which are available in the requested survey ID. tags: - Survey parameters: - name: survey_id in: path description: Id of the Survey. required: true example: '123' schema: type: integer - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: number - name: lang in: query description: The survey locale, default is english required: false example: english schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/survey/{survey_id}/submit": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1315Model" examples: response: value: code: 1315 message: Invalid survey. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Post a survey response operationId: postASurveyResponse description: Post a survey response API submits the survey response for a particular survey using JSON structure. tags: - Survey parameters: - name: survey_id in: path description: Id of the Survey. required: true example: '123' schema: type: integer - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: example: surveyId: 535 logoUrl: https://d2xt3xymj142xp.cloudfront.net/145301531829695/logo%2F57db1409813c70.82884191.png name: JetBlue Customer Satisfaction Survey status: new created: 1484941995000 responses: 0 questionCount: 4 pages: - name: Introduction id: 2316 order: 0 showQuestionNumbers: 1 visible: false questions: - title: Thank you for traveling with JetBlue Airways! We’d love to hear about your recent trip with us. Your feedback will help us improve the way we serve you name: Question name showQuestionNumbers: 1 id: 10315 skipQuestion: false displayQuestion: false minimumValue: 0 maximumValue: 0 order: 0 visible: true isRequired: true type: label reactElementId: 493 value: [] choices: [] rows: [] skipLogic: [] displayLogic: [] - title: How was your trip today name: Question name showQuestionNumbers: 1 id: 10314 skipQuestion: false displayQuestion: false minimumValue: 0 maximumValue: 0 order: 1 visible: true isRequired: true type: radio reactElementId: 840 value: - '22856' choices: - id: 22854 title: Satified order: 0 - id: 22856 title: Needs Improvement order: 1 - id: 22855 title: Dissatiffied order: 2 rows: [] skipLogic: [] displayLogic: [] - title: Please rate us based on your experience name: Question name showQuestionNumbers: 1 id: 10316 skipQuestion: false displayQuestion: false maximumRateDescription: Excellent minimumRateDescription: Poor minimumValue: 1 maximumValue: 10 order: 2 visible: true isRequired: true type: rating reactElementId: 101 value: - '9' choices: [] rows: [] skipLogic: [] displayLogic: [] - title: Thanks for your feedback! Please let us know how we can serve you better name: Question name showQuestionNumbers: 1 id: 10317 skipQuestion: false displayQuestion: false minimumValue: 0 maximumValue: 0 order: 3 visible: true isRequired: true type: textarea reactElementId: 813 value: - I'm happy with the service! Wi-Fi can be better choices: [] rows: [] skipLogic: [] displayLogic: [] businessId: 145301531829695 isComplete: 1 "/v1/survey/ext/list/responses/{survey_id}": post: responses: '200': description: OK content: application/json: example: responseList: - responseId: 12345 requestDate: 07/11/2018 responseDate: 07/11/2018 completed: true questionCount: 10 locale: en surveyId: 1000 surveyName: Test Edit Test Edit 2(2) locationName: BMW customerId: 123456 customerName: Anonymous ticketed: false ticketIds: - 100770 - 100751 answers: - questionTitle: "We are interested in receiving your feedback. \nabout the care provided at our facility. \n\nPlease take a few minutes to rate your satisfaction with each of the following\n\nPlease describe ur properties." questionType: label visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true - questionTitle: Single CHoice questionType: radio visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: A - questionTitle: Multiple choice q questionType: checkbox visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: A - questionTitle: Multiple Text Entry edited questionType: textarea visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: qwsad - questionTitle: Single TExt Entry edited questionType: text visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: fasdf - questionTitle: Drop Down edited questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Select1 - questionTitle: Please rate us based on your experience Rating Question edited questionType: rating visible: true conditional: true shownToCustomer: true hidden: false maxValue: 10 minValue: 1 showTime: true showDate: true answer: '6' - questionTitle: Please rate us for the below mentioned services Matrix Drop Down edited questionType: matrixdropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true childAnswers: - questionTitle: Click to write statement 1 questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice 1 - questionTitle: Click to write statement 2 questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice 1 - questionTitle: Click to write statement 3 questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice 1 - questionTitle: Click to write statement 4 questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice 2 - questionTitle: Click to write statement 5 questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice 2 - questionTitle: Click to write statement questionType: dropdown visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice 2 - questionTitle: How likely are you to recommend us to your family and friends NPS edited? questionType: nps visible: true conditional: false shownToCustomer: true hidden: false maxValue: 10 minValue: 0 showTime: true showDate: true answer: '7' - questionTitle: Matrix Radio Choice editedf questionType: matrixradio visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true childAnswers: - questionTitle: Click to write statement A questionType: radio visible: true conditional: false shownToCustomer: true hidden: false maxValue: 0 minValue: 0 showTime: true showDate: true answer: Choice D overallScore: '9.0' customParam: order Date: '2024-03-21 06:14:00' orderId: '52' extraParams: facilityId: '38861' Integration Trigger: Updated Rentals Current balance due: '0.0000' Move In date: 12-19-2023 totalResponses: 1 pageNo: 0 pageSize: 1 hasNext: true '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1315Model" examples: response: value: code: 1315 message: Invalid survey. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: List Responses for a Survey operationId: listResponsesForASurvey description: List Responses for a Survey API fetches all the responses available for a particular survey ID. tags: - Survey parameters: - name: survey_id in: path description: Id of the Survey. required: true example: '123' schema: type: integer - name: businessNumber in: query description: The Business Number of Enterprise required: true example: '169744180007807' schema: type: string - name: page in: query description: The page number, starts with 0. required: false example: '0' schema: type: integer - name: size in: query description: The size of the page. required: false example: '30' schema: type: integer - name: sortby in: query description: The sort by parameter. required: false example: date schema: type: string - name: sorder in: query description: The sort order parameter. required: false example: asc schema: type: string - name: includeTicketId in: query description: The field to fetch ticketIds associated with the response. required: false example: 'false' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: startDate: type: string description: Start date. endDate: type: string description: End date. example: startDate: 07/03/2018 06:30:00 endDate: 07/23/2018 06:45:00 example: startDate: 07/03/2018 06:30:00 endDate: 07/23/2018 06:45:00 "/v1/survey/business/{business_id}/all": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllSurveys_Response200" example: - surveyId: 9 name: JetBlue Customer Satisfaction Survey status: new created: 1458844108000 lastModified: 1482174350000 responses: 97 questionCount: 13 - surveyId: 10 name: JetBlue Membership Survey status: active created: 1481554022000 lastModified: 1484867564000 responses: 20 questionCount: 18 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get All Surveys operationId: getAllSurveys description: Get All Surveys fetches the list of all available surveys on the business. tags: - Survey parameters: - name: sortby in: query description: Sort results by lastModified[modified], Created[created], Response Count[response]. required: false example: modified schema: type: string - name: sorder in: query description: Sort order ascending (0) and descending (1). required: false example: '0' schema: type: string - name: searchStr in: query description: Search survey by name or business location. required: false example: abc schema: type: string - name: business_id in: path description: Business ID. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/survey/external/create/{businessId}": post: responses: '200': description: OK content: application/json: example: surveyId: 1234 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2044Model" x-apiary-response-models: - "$ref": "#/components/schemas/2044Model" - "$ref": "#/components/schemas/2093Model" - "$ref": "#/components/schemas/2045Model" - "$ref": "#/components/schemas/2046Model" - "$ref": "#/components/schemas/2047Model" - "$ref": "#/components/schemas/2048Model" - "$ref": "#/components/schemas/2049Model" - "$ref": "#/components/schemas/2050Model" - "$ref": "#/components/schemas/2051Model" - "$ref": "#/components/schemas/2052Model" - "$ref": "#/components/schemas/2053Model" - "$ref": "#/components/schemas/2054Model" - "$ref": "#/components/schemas/2055Model" - "$ref": "#/components/schemas/2056Model" - "$ref": "#/components/schemas/2057Model" - "$ref": "#/components/schemas/2058Model" - "$ref": "#/components/schemas/2059Model" - "$ref": "#/components/schemas/2060Model" - "$ref": "#/components/schemas/2061Model" - "$ref": "#/components/schemas/2062Model" - "$ref": "#/components/schemas/2063Model" - "$ref": "#/components/schemas/2064Model" - "$ref": "#/components/schemas/2065Model" - "$ref": "#/components/schemas/2066Model" - "$ref": "#/components/schemas/2067Model" - "$ref": "#/components/schemas/2068Model" - "$ref": "#/components/schemas/2069Model" - "$ref": "#/components/schemas/2070Model" - "$ref": "#/components/schemas/2071Model" - "$ref": "#/components/schemas/2072Model" - "$ref": "#/components/schemas/2073Model" - "$ref": "#/components/schemas/2074Model" - "$ref": "#/components/schemas/2092Model" - "$ref": "#/components/schemas/2076Model" - "$ref": "#/components/schemas/2077Model" - "$ref": "#/components/schemas/2091Model" - "$ref": "#/components/schemas/2079Model" - "$ref": "#/components/schemas/2080Model" - "$ref": "#/components/schemas/2081Model" - "$ref": "#/components/schemas/2082Model" - "$ref": "#/components/schemas/2083Model" - "$ref": "#/components/schemas/2084Model" - "$ref": "#/components/schemas/2085Model" - "$ref": "#/components/schemas/2086Model" - "$ref": "#/components/schemas/2087Model" - "$ref": "#/components/schemas/2088Model" - "$ref": "#/components/schemas/2094Model" - "$ref": "#/components/schemas/2095Model" x-apiary-response-examples: error_2044: value: code: 2044 message: Survey already completed error_2093: value: code: 2093 message: Survey Field Type passed is unknown error_2045: value: code: 2045 message: Invalid Survey Type error_2046: value: code: 2046 message: Min Value is greater then Max Value error_2047: value: code: 2047 message: Survey Fields Missing! error_2048: value: code: 2048 message: Field Rows Missing error_2049: value: code: 2049 message: Interval can only be 30 min or 60 min error_2050: value: code: 2050 message: More than one location question cannot be present error_2051: value: code: 2051 message: More than one review question cannot be present error_2052: value: code: 2052 message: Review question should be present in the last page of the survey as a single question error_2053: value: code: 2053 message: Contact Fields are not present error_2054: value: code: 2054 message: Min Value out of range error_2055: value: code: 2055 message: Max Value out of range error_2056: value: code: 2056 message: Min and Max values can only be even numbers when the interval is 60 minutes error_2057: value: code: 2057 message: Either one of Min and Max values is missing in datetime type question error_2058: value: code: 2058 message: LocationIds are not present error_2059: value: code: 2059 message: Invalid type of contact question error_2060: value: code: 2060 message: reviewSources are not present for review type question error_2061: value: code: 2061 message: Pickone type of survey can only contain pickone type questions error_2062: value: code: 2062 message: Traditional type survey cannot contain these type questions error_2063: value: code: 2063 message: Pulse(NPS) Survey can only contain radio, text, textarea(paragraph), rating and nps type questions error_2064: value: code: 2064 message: First page of the survey must contain atleast one question except review question error_2065: value: code: 2065 message: There cannot be more than 3 sourceIds for review question error_2066: value: code: 2066 message: BusinessIds passed in the location type question are invalid error_2067: value: code: 2067 message: One of the locations passed in the request is not present error_2068: value: code: 2068 message: The locationIds are Non-Parseable error_2069: value: code: 2069 message: surveyName is Mandatory error_2070: value: code: 2070 message: Question Type cannot be blank error_2071: value: code: 2071 message: Invalid ownerEmailId error_2072: value: code: 2072 message: Choice cannot be a blank string error_2073: value: code: 2073 message: Logic type is Invalid! error_2074: value: code: 2074 message: Cannot contain a logic error_2092: value: code: 2092 message: Invalid Logic! error_2076: value: code: 2076 message: Value of the logic is not present in the choices of Question error_2077: value: code: 2077 message: Value of a questionLogic field cannot be blank error_2091: value: code: 2091 message: Operator Invalid error_2079: value: code: 2079 message: Only one Skip logic is allowed for text and textarea type questions error_2080: value: code: 2080 message: Display Logic Invalid! error_2081: value: code: 2081 message: Skip Logic Invalid! error_2082: value: code: 2082 message: The API returned an empty response. error_2083: value: code: 2083 message: Source is not integrated with the business error_2084: value: code: 2084 message: Opeartor must be present for logics other than the first display logic error_2085: value: code: 2085 message: Condition cannot be null! error_2086: value: code: 2086 message: Question Number cannot be null error_2087: value: code: 2087 message: Duplicate contact sub type question is present error_2088: value: code: 2088 message: Review Source already present error_2094: value: code: 2094 message: ReviewSources passed are invalid error_2095: value: code: 2095 message: ownerEmailId cannot be null examples: response: value: code: 2044 message: Survey already completed '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1380Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1380: value: code: 1380 message: Api key or session token missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Survey operationId: createSurvey description: |- Create Survey API helps create a new survey for the required question structure and further displays it on the survey list page. Please go through this document for a detailed explanation of request body fields tags: - Survey parameters: - name: businessId in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: surveyName: type: string thankYouMessage: type: string surveyType: type: string ownerEmailId: type: string pages: type: array items: type: object properties: questions: type: array items: type: object properties: title: type: string type: type: string required: type: boolean choices: type: array items: type: string minLabel: type: string maxLabel: type: string maxValue: oneOf: - type: number - type: string showTime: type: boolean showDate: type: boolean interval: type: number minValue: type: string contactRows: type: array items: type: object properties: required: type: boolean title: type: string type: type: string required: - required - title - type rows: type: array items: type: string contactUsMessage: type: string reviewSources: type: array items: type: string required: - title - type - choices - minLabel - required - maxValue - maxLabel - rows title: type: string required: - questions - title example: surveyName: Experience Survey thankYouMessage: Thank you for taking the survey! surveyType: traditional ownerEmailId: testmail@gmail.com pages: - questions: - title: Text1 type: text - title: Paragraph type: textarea - title: Page 2-optional questions: - title: Questionnumber1 type: checkbox required: true choices: - Choice 1 - Choice 2 - Choice 3 - title: Q2 type: dropdown choices: - Dropdown 1 - Dropdown 2 - Dropdown 3 - title: ratingQn type: rating minLabel: Strongly Disagree maxLabel: Strongly Agree maxValue: 10 - questions: - title: P3-Q1-Radio type: radio choices: - radio 1 - radio 2 - radio 3 - title: npsQn type: nps minLabel: Strongly Disagree - questions: - title: Datetime question type: datetime required: true showTime: true showDate: true interval: 60 minValue: '12' maxValue: '36' - title: Please enter your contact information type: contact required: true contactRows: - required: true title: First name type: text - required: true title: Email type: email - required: true title: Phone type: phone - title: Page 4 questions: - title: P4-Q1 type: matrixrating minLabel: Strongly Disagree maxLabel: Strongly Agree maxValue: 5 rows: - Row label 1 - Row label 2 - title: P4-Q2 type: matrixradio required: true choices: - c1 - c2 - c3 rows: - Row 1 - Row2 - title: p4-Q3 type: matrixdropdown required: true choices: - c1 - c2 - c3 rows: - Row label 1 - Row label 2 - title: Label type ques type: label - questions: - title: please review us on one of these sites type: review required: true contactUsMessage: ContactUs test message reviewSources: - Google - Facebook - CitySearch example: surveyName: Experience Survey thankYouMessage: Thank you for taking the survey! surveyType: traditional ownerEmailId: testmail@gmail.com pages: - questions: - title: Text1 type: text - title: Paragraph type: textarea - title: Page 2-optional questions: - title: Questionnumber1 type: checkbox required: true choices: - Choice 1 - Choice 2 - Choice 3 - title: Q2 type: dropdown choices: - Dropdown 1 - Dropdown 2 - Dropdown 3 - title: ratingQn type: rating minLabel: Strongly Disagree maxLabel: Strongly Agree maxValue: 10 - questions: - title: P3-Q1-Radio type: radio choices: - radio 1 - radio 2 - radio 3 - title: npsQn type: nps minLabel: Strongly Disagree - questions: - title: Datetime question type: datetime required: true showTime: true showDate: true interval: 60 minValue: '12' maxValue: '36' - title: Please enter your contact information type: contact required: true contactRows: - required: true title: First name type: text - required: true title: Email type: email - required: true title: Phone type: phone - title: Page 4 questions: - title: P4-Q1 type: matrixrating minLabel: Strongly Disagree maxLabel: Strongly Agree maxValue: 5 rows: - Row label 1 - Row label 2 - title: P4-Q2 type: matrixradio required: true choices: - c1 - c2 - c3 rows: - Row 1 - Row2 - title: p4-Q3 type: matrixdropdown required: true choices: - c1 - c2 - c3 rows: - Row label 1 - Row label 2 - title: Label type ques type: label - questions: - title: please review us on one of these sites type: review required: true contactUsMessage: ContactUs test message reviewSources: - Google - Facebook - CitySearch "/v1/survey/{surveyId}/settings/update": post: responses: '200': description: OK content: application/json: example: surveyId: 1234 suveySettingId: 12345 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1011Model" x-apiary-response-models: - "$ref": "#/components/schemas/1011Model" - "$ref": "#/components/schemas/1315Model" - "$ref": "#/components/schemas/2037Model" - "$ref": "#/components/schemas/2042Model" - "$ref": "#/components/schemas/2040Model" - "$ref": "#/components/schemas/2090Model" - "$ref": "#/components/schemas/2043Model" - "$ref": "#/components/schemas/2039Model" - "$ref": "#/components/schemas/2038Model" - "$ref": "#/components/schemas/2041Model" - "$ref": "#/components/schemas/2096Model" x-apiary-response-examples: error_1011: value: code: 1011 message: Business id is invalid error_1315: value: code: 1315 message: Invalid survey. error_2037: value: code: 2037 message: The survey doesn't belong to the account. error_2042: value: code: 2042 message: Received no valid inputs in request body! error_2040: value: code: 2040 message: Invalid value of progress bar position, expected Bottom or Top error_2090: value: code: 2090 message: Invalid value of showLogo, accepted values are ON, OFF error_2043: value: code: 2043 message: Invalid value of showTitle, accepted values are CUSTOM, LOCATION, OFF error_2039: value: code: 2039 message: User email is missing in user access request! error_2038: value: code: 2038 message: Invalid value of role, expected editor, viewer or no-access error_2041: value: code: 2041 message: Can't modify owner or existing owner's access! error_2096: value: code: 2096 message: Detected conflicting user-access request! examples: response: value: code: 1011 message: Business id is invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1380Model" x-apiary-response-models: - "$ref": "#/components/schemas/1380Model" - "$ref": "#/components/schemas/89Model" x-apiary-response-examples: error_1380: value: code: 1380 message: Api key or session token missing error_89: value: code: 89 message: Rate limit exceeded examples: response: value: code: 1380 message: Api key or session token missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1175Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1175: value: code: 1175 message: No business found with the given id examples: response: value: code: 1161 message: Invalid API key summary: Update Survey Settings operationId: updateSurveySettings description: |- Update Survey Settings helps update the survey page appearance settings like Logo, Title, ProgessBar setting, Theme Colour, User Acess, and many more. > __Note__ > - _In user-access request, if multiple entries are detected for a user, they will be assigned the highest role among all the different roles specified. If the entries are conflicting (e.g. delete + update), the API will return with exception_ tags: - Survey parameters: - name: surveyId in: path description: Survey ID required: true example: '123' schema: type: integer - name: businessId in: query description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateSurveySettings_Request" example: surveySettings: showSurveyTitle: false showQuestionNumber: false showProgressBar: false progressbarPosition: Bottom showLogo: 'ON' showTitle: CUSTOM customTitle: Welcome to Tennessee! themeColor: "#1976d2" themeTextColor: "#ffffff" subject: Thank you for taking the survey message: "Hi , \nThank you for taking the time to give your inputs on the survey." signature: "Sincerely, \nBMW_Survey \n" enableThankyouEmail: true accessControl: userAccessList: - userEmail: abc@test.com role: viewer - userEmail: def@test.com delete: true surveyAccess: role: editor "/v1/business/{businessNumber}/upload/media": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_addMedia_Response200" example: media: - mediaId: '987654321123' url: https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2 mediaCategory: TEAMS description: Image of the team mediaFormat: PHOTO - mediaId: '7654321123' url: https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4 mediaCategory: ADDITIONAL description: Introductory video mediaFormat: VIDEO '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2174Model" x-apiary-response-models: - "$ref": "#/components/schemas/2174Model" - "$ref": "#/components/schemas/2180Model" - "$ref": "#/components/schemas/2181Model" - "$ref": "#/components/schemas/2171Model" - "$ref": "#/components/schemas/2175Model" x-apiary-response-examples: error_2174: value: code: 2174 message: Unsupported media format error_2180: value: code: 2180 message: The recommended Image size for Google media image is 250 pixels wide and 250 pixels tall. error_2181: value: code: 2181 message: Supported video format is MP4. error_2171: value: code: 2171 message: URL is invalid error_2175: value: code: 2175 message: Provided media category is not supported examples: response: value: code: 2174 message: Unsupported media format '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1011Model" x-apiary-response-models: - "$ref": "#/components/schemas/1011Model" - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1011: value: code: 1011 message: Business id is invalid error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Add Media operationId: addMedia description: API to upload the Business Media. tags: - Business Media parameters: - name: businessNumber in: path description: Location Number, in case of SMB it will be Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_addMedia_Request" example: media: - url: https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2 mediaCategory: TEAMS description: Image of the team mediaFormat: PHOTO - url: https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4 mediaCategory: ADDITIONAL description: Introductory video mediaFormat: VIDEO "/v1/business/{businessNumber}/media/get": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getMedia_Response200" example: media: - mediaId: '987654321123' url: https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2 mediaCategory: TEAMS description: Image of the team mediaFormat: PHOTO - mediaId: '7654321122' url: https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4 mediaCategory: ADDITIONAL description: Introductory video mediaFormat: VIDEO '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1011Model" x-apiary-response-models: - "$ref": "#/components/schemas/1011Model" - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1011: value: code: 1011 message: Business id is invalid error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Media operationId: getMedia description: API to get the Business Media details. tags: - Business Media parameters: - name: businessNumber in: path description: Location Number, in case of SMB it will be Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/{businessNumber}/update/media/{mediaId}": put: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2174Model" x-apiary-response-models: - "$ref": "#/components/schemas/2174Model" - "$ref": "#/components/schemas/2270Model" - "$ref": "#/components/schemas/2176Model" - "$ref": "#/components/schemas/2177Model" x-apiary-response-examples: error_2174: value: code: 2174 message: Unsupported media format error_2270: value: code: 2270 message: Unsupported Media Category for the business error_2176: value: code: 400 message: Category can not be empty error_2177: value: code: 400 message: Invalid media id examples: response: value: code: 2174 message: Unsupported media format '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Media operationId: updateMedia description: API to update the Business Media. tags: - Business Media parameters: - name: businessNumber in: path description: Location Number, in case of SMB it will be Business Number. required: true example: '169744180007807' schema: type: string - name: mediaId in: path description: Id of the media item. required: true example: '62185029212' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateMedia_Request" example: mediaCategory: INTERIOR "/v1/business/{businessNumber}/media/delete": delete: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2177Model" examples: response: value: code: 400 message: Invalid media id '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1011Model" x-apiary-response-models: - "$ref": "#/components/schemas/1011Model" - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1011: value: code: 1011 message: Business id is invalid error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Media operationId: deleteMedia description: API to delete the Business Medias. tags: - Business Media parameters: - name: businessNumber in: path description: Location Number, in case of SMB it will be Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: mediaIds: type: array description: List of Media Ids to be deleted. items: {} required: - mediaIds example: mediaIds: - '987654321123' - '7654321123' example: mediaIds: - '987654321123' - '7654321123' "/v1/social/{accountNumber}/schedule": post: responses: '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5556Model" x-apiary-response-models: - "$ref": "#/components/schemas/5556Model" - "$ref": "#/components/schemas/5557Model" x-apiary-response-examples: error_5556: value: code: 5556 message: One or few BusinessIds are Invalid error_5557: value: code: 5557 message: Requested Business Ids are empty. examples: response: value: code: 5556 message: One or few BusinessIds are Invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Schedule Social Post operationId: scheduleSocialPost description: This API allows users to schedule or immediately post content on supported social sites. Users can specify the content, media, and schedule a specific time for the post. Supported social sites include Google Business Profile, Facebook, Instagram, LinkedIn, and Twitter. tags: - Social parameters: - name: accountNumber in: path description: Id of the Account. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_scheduleSocialPost_Request" example: text: Check out the latest collection socialSite: GOOGLEMYBUSINESS subBusinessNumbers: - 123456780 - 123456781 scheduleTimestamp: 1677759962528 media: - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png additionalMetaData: callToActionType: LEARN_MORE callToActionUrl: https://app.birdeye.com/ "/v1/social/post/public/scheduled/edit/{accountNumber}": post: responses: '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5556Model" x-apiary-response-models: - "$ref": "#/components/schemas/5556Model" - "$ref": "#/components/schemas/5557Model" x-apiary-response-examples: error_5556: value: code: 5556 message: One or few BusinessIds are Invalid error_5557: value: code: 5557 message: Requested Business Ids are empty. examples: response: value: code: 5556 message: One or few BusinessIds are Invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Edit Scheduled Social Post operationId: editScheduledSocialPost description: |- This api will edit a scheduled post created through public api. Users can specify the content, media, and schedule a specific time for the post. Supported social sites include Google Business Profile, Facebook, Instagram and LinkedIn. If extra locations are included in subBusinessNumbers, the post will also be scheduled for those locations. If subBusinessNumbers now contains fewer locations than before, the post will be unscheduled from any locations that are no longer listed. tags: - Social parameters: - name: accountNumber in: path description: Id of the Account. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_editScheduledSocialPost_Request" example: trackingId: 4ece211b82162d1101d2d82a24876a92 text: Check out the latest collection socialSite: GOOGLEMYBUSINESS subBusinessNumbers: - 123456780 - 123456781 scheduleTimestamp: 1677759962528 media: - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png additionalMetaData: callToActionType: LEARN_MORE callToActionUrl: https://app.birdeye.com/ "/v1/social/post/public/published/edit/{accountNumber}": post: responses: '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5556Model" x-apiary-response-models: - "$ref": "#/components/schemas/5556Model" - "$ref": "#/components/schemas/5557Model" x-apiary-response-examples: error_5556: value: code: 5556 message: One or few BusinessIds are Invalid error_5557: value: code: 5557 message: Requested Business Ids are empty. examples: response: value: code: 5556 message: One or few BusinessIds are Invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Edit Published social Post operationId: editPublishedSocialPost description: 'This api will edit a published post created through public api. Only text can be updated for a published post. Editing published post is only supported for these channels: Facebook, Google and LinedIn.' tags: - Social parameters: - name: accountNumber in: path description: Id of the Account. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_editPublishedSocialPost_Request" example: trackingId: 4ece211b82162d1101d2d82a24876a92 text: Check out the latest collection socialSite: GOOGLEMYBUSINESS subBusinessNumbers: - 123456780 - 123456781 "/v1/social/post/public/delete/{accountNumber}": post: responses: '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/5556Model" x-apiary-response-models: - "$ref": "#/components/schemas/5556Model" - "$ref": "#/components/schemas/5557Model" x-apiary-response-examples: error_5556: value: code: 5556 message: One or few BusinessIds are Invalid error_5557: value: code: 5557 message: Requested Business Ids are empty. examples: response: value: code: 5556 message: One or few BusinessIds are Invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete public social Post operationId: deletePublicSocialPost description: 'This api will delete a post created through public api. It can delete both scheduled and published posts. Deleting published post is only supported for these channels: Facebook, Google, LinedIn' tags: - Social parameters: - name: accountNumber in: path description: Id of the Account. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: trackingId: type: string description: Tracking id received when post was created through public api. subBusinessNumbers: type: array description: List of location ids for which this post should be deleted. If list contains a location which is not part of the post, then no action will be taken for that location. items: {} required: - trackingId - subBusinessNumbers example: trackingId: 4ece211b82162d1101d2d82a24876a92 subBusinessNumbers: - 123456780 - 123456781 example: trackingId: 4ece211b82162d1101d2d82a24876a92 subBusinessNumbers: - 123456780 - 123456781 "/v1/social/{accountNumber}/post/track/{trackingId}": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_trackSocialPost_Response200" '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Track Social Post operationId: trackSocialPost description: This API allows users to track the status of a social post that was previously scheduled or published using the Schedule Social Post API. By providing the trackingId from the response of the scheduling API, users can query the status and details of the post across different social sites. tags: - Social parameters: - name: accountNumber in: path description: Id of the Account. required: true example: '12345678' schema: type: number - name: trackingId in: path description: |- The tracking ID to track the status of the post. + Error message: Tracking Id not present in System required: true example: abcdefdhs schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/social/open-url/performance/report": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_socialOpenUrlPerformanceReport_Response200" example: summary: actual: impressions: 11363 engagements: 1421 engRate: 12.51 postCount: 4479 channelWiseData: tiktok: totalPost: 0 engagements: 321 impressions: 9194 engRate: 3.49 instagram: totalPost: 4479 engagements: 1100 impressions: 2169 engRate: 50.71 totalRecords: 6 postCountGrowthPercent: 100.0 engRateGrowthPercent: 100.0 engagementGrowthPercent: 100.0 compare: impressions: 0 engagements: 0 engRate: 0.0 postCount: 0 channelWiseData: {} totalRecords: 0 dataPoints: - actual: label: nesh startDate: 02/03/2021 endDate: 02/10/2026 locationId: 407984 businessNumber: 151378841664132 externalReferenceId: '1104900901' channelWiseData: tiktok: totalPost: 0 engagements: 143 impressions: 3902 engRate: 3.66 compare: label: nesh startDate: 02/03/2021 endDate: 02/10/2026 locationId: 407984 businessNumber: 151378841664132 externalReferenceId: '1104900901' channelWiseData: tiktok: totalPost: 0 engagements: 143 impressions: 3902 engRate: 3.66 - actual: label: Business startDate: 02/03/2021 endDate: 02/10/2026 locationId: 948224 businessNumber: 166063705866724 externalReferenceId: '1104900901' channelWiseData: instagram: totalPost: 3669 engagements: 836 impressions: 618 engRate: 135.28 compare: label: Business startDate: 02/03/2021 endDate: 02/10/2026 locationId: 948224 businessNumber: 166063705866724 externalReferenceId: '1104900901' channelWiseData: instagram: totalPost: 3669 engagements: 836 impressions: 618 engRate: 135.28 - actual: label: vulk loc ag startDate: 02/03/2021 endDate: 02/10/2026 locationId: 972854 businessNumber: 166520715464268 channelWiseData: tiktok: totalPost: 0 engagements: 178 impressions: 5292 engRate: 3.36 compare: {} '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2177Model" examples: response: value: code: 400 message: Invalid media id '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Social Open URL Performance Report operationId: socialOpenUrlPerformanceReport description: Social Open URL Performance Report API returns channel-level social performance metrics with optional comparison data for the selected date range. tags: - Social parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Business number of the location. required: false example: "[Required] Business number of the location." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_socialOpenUrlPerformanceReport_Request" example: startDate: 02/03/2021 endDate: 02/10/2026 sourceNames: - Instagram - Tiktok - Facebook - Linkedin businessNumbers: [] comparisonFilter: startDate: 01/01/2020 endDate: 01/10/2020 page: 1 size: 50 "/v1/social/post/public/media/upload": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_uploadSocialMedia_Response200" example: batch_id: e0de3eeb-1f52-45bd-9110-fb6b5cb966ad accepted_count: 1 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1011Model" x-apiary-response-models: - "$ref": "#/components/schemas/1011Model" x-apiary-response-examples: empty_urls: value: code: 1011 message: media_urls cannot be empty too_many_urls: value: code: 1011 message: media_urls cannot exceed 50 items unsupported_type: value: code: 1011 message: "Unsupported media type for URL: https://example.com/video.mp4.. Only image and video URLs are supported." examples: response: value: code: 1011 message: media_urls cannot be empty '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Upload Social Media operationId: uploadSocialMedia description: Accepts a batch of publicly accessible image or video URLs and queues them for asynchronous upload to the Birdeye media library. Returns a batch_id immediately; poll the Track Upload Status endpoint to retrieve per-item results. Accepts 1–50 URLs per request. Supported image formats — .jpg, .jpeg, .png, .gif, .webp. Supported video formats — .mp4, .mov, .avi, .mkv, .webm, .wmv. tags: - Social parameters: - name: x-api-key in: header description: Business API key. required: true example: your-api-key-here schema: type: string - name: x-business-number in: header description: Business identifier. required: true example: '151378841664132' schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: true example: application/json schema: type: string default: application/json requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/Apiary_uploadSocialMedia_Request" examples: single_url: summary: Single URL value: media_urls: - https://example.com/video.mp4 multiple_urls: summary: Multiple URLs (image + video) value: media_urls: - https://example.com/image.jpg - https://example.com/video.mp4 with_folder_id: summary: With optional folder_id value: media_urls: - https://example.com/video.mp4 folder_id: 1527 "/v1/social/post/public/media/track/{batch_id}": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_trackSocialMediaUpload_Response200" x-apiary-response-examples: completed: value: batch_id: e0de3eeb-1f52-45bd-9110-fb6b5cb966ad status: COMPLETED accepted_count: 1 success_count: 1 failed_count: 0 pending_count: 0 items: - source_url: https://example.com/video.mp4 status: SUCCESS asset_id: 3457963 cdn_url: https://ddjkm7nmu27lx.cloudfront.net/.../video.mp4 failed: value: batch_id: 030ec908-2c2d-4e2c-a9d6-654b27f63cca status: FAILED accepted_count: 1 success_count: 0 failed_count: 1 pending_count: 0 items: - source_url: https://example.com/image.jpg status: FAILED failure_reason: Source URL is not accessible or could not be downloaded partially_completed: value: batch_id: 6c32243f-ce5f-4400-9988-06bd6f4c4080 status: PARTIALLY_COMPLETED accepted_count: 2 success_count: 1 failed_count: 1 pending_count: 0 items: - source_url: https://example.com/image.jpg status: FAILED failure_reason: Source URL is not accessible or could not be downloaded - source_url: https://example.com/video.mp4 status: SUCCESS asset_id: 3457963 cdn_url: https://ddjkm7nmu27lx.cloudfront.net/.../video.mp4 eu_completed: value: batch_id: 1e2e088b-7b9d-4d9d-833b-ad506d5a7323 status: COMPLETED accepted_count: 1 success_count: 1 failed_count: 0 pending_count: 0 items: - source_url: https://drive.google.com/file/d/... status: SUCCESS asset_id: 2144734 cdn_url: https://d25nuexi6ta4v6.cloudfront.net/.../video.mp4 example: batch_id: e0de3eeb-1f52-45bd-9110-fb6b5cb966ad status: COMPLETED accepted_count: 1 success_count: 1 failed_count: 0 pending_count: 0 items: - source_url: https://example.com/video.mp4 status: SUCCESS asset_id: 3457963 cdn_url: https://ddjkm7nmu27lx.cloudfront.net/.../video.mp4 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Track Social Media Upload operationId: trackSocialMediaUpload description: Returns the current processing status for a media upload batch submitted via the Upload Social Media endpoint. Poll until pending_count reaches 0 or the batch status is no longer PENDING. The asset_id returned for successfully uploaded items should be used when attaching media to a Social Post. tags: - Social parameters: - name: batch_id in: path description: The batch ID returned from the Upload Social Media endpoint. required: true example: e0de3eeb-1f52-45bd-9110-fb6b5cb966ad schema: type: string format: uuid - name: x-api-key in: header description: Business API key. required: true example: your-api-key-here schema: type: string - name: x-business-number in: header description: Business identifier. required: true example: '151378841664132' schema: type: string "/v1/employee/{businessId}": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getDetailsOfEmployees_Response200" example: - firstName: sachin lastName: birdeye emailId: sachin@birdeye.com phone: '' imageUrl: '' - firstName: Kailash lastName: Yadav emailId: kailash12121@gmail.com phone: "(989) 898-9898" imageUrl: employees/574549fb79cff9.54677638.jpg - firstName: Kailash lastName: Yadav emailId: 1213@gmail.com phone: "(989) 898-9898" imageUrl: http://d2xt3xymj142xp.cloudfront.net/169830616/573db5844e0e66.08202399.png '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get details of Employees operationId: getDetailsOfEmployees description: Get details of Employees is a lite version API that retrieves a sorted list of all active employees for an account. tags: - Employee parameters: - name: businessId in: path description: Id of the Business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/messenger/export": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_listConversations_Response200" example: totalConversations: 1 totalMessages: 2 conversations: - id: 127490 contact: id: 80768826 name: S G firstName: S lastName: G phone: "(650) 492-3456" emailId: createdDate: '2020-05-04 17:20:14' updatedDate: '2020-05-18 15:22:57' team: Harshit locationId: 155911960965004 messages: - sentAt: 1588612840000 id: '124776' text: hi message_date: May 04, 2020 10:20 AM PDT attachments: direction: SEND channel: SMS - sentAt: 1588612814000 id: '124775' text: Hello message_date: May 04, 2020 10:20 AM PDT attachments: direction: RECEIVE channel: LIVE_CHAT conversation_start_date: May 04, 2020 10:20 AM PDT last_message_received_on: May 04, 2020 10:20 AM PDT status: OPEN last_used_channel: SMS assigned_to: id: -100000 name: '' type: T emailId: hasMore: false '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1246Model" examples: response: value: code: 1246 message: Customer email or phone number is required. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: List Conversations operationId: listConversations description: List Conversations retrieves conversations for a business. tags: - Conversation parameters: - name: Accept in: header description: Preferred response media type. required: false example: application/json schema: type: string default: application/json - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumber: type: number description: The business number for which the details to be fetched, it can be either enterprise or location business number. apiKey: type: string description: Partner specific API key provided by Birdeye for data exchange. startDate: type: string description: Start fetching messages from this date in MM/DD/YYYY format. endDate: type: string description: Fetch messages till this date in MM/DD/YYYY format. offset: type: number description: Message offset,the start index. size: type: number description: Number of messages return in the response. contact: type: object properties: phone: type: string description: Phone number of the contact. email: type: string description: Email Id of the contact. description: Contact details excludeCampaignMessages: type: number description: If passed with value 1, It will exclude campaign messages from API response. required: - businessNumber - apiKey example: businessNumber: '755009344' apiKey: abcdefgh startDate: 04/06/2020 endDate: 05/30/2020 offset: '0' size: '100' contact: phone: "(650)492-3456" email: abc@test.com excludeCampaignMessages: 1 example: businessNumber: '755009344' apiKey: abcdefgh startDate: 04/06/2020 endDate: 05/30/2020 offset: '0' size: '100' contact: phone: "(650)492-3456" email: abc@test.com excludeCampaignMessages: 1 "/v1/subscriptions/subscribe": post: responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string message: type: string example: id: abcchdguweUGBSK16789278 message: 'You have successfully subscribed to : https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65' examples: response: value: id: abcchdguweUGBSK16789278 message: 'You have successfully subscribed to : https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65' '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create subscription operationId: createSubscription description: Create webhook subscription listens to subscribed webhook events on a specific passed URL. tags: - Subscription parameters: - name: businessId in: query description: Account business number. required: true example: '1234567890' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createSubscription_Request" example: webhookUrl: https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65 emails: - test@xyz.com eventName: APPOINTMENT_BOOKED auth: username: testUser password: userpassword "/v1/subscriptions/unsubscribe/{subscriptionId}": get: responses: '200': description: OK content: application/json: schema: type: object properties: message: type: string example: message: This Subscription has been Unsubscribed examples: response: value: message: This Subscription has been Unsubscribed '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded '500': description: Internal Server Error content: application/json: schema: type: object properties: code: type: number message: type: string example: code: 1005 message: Subscription Not found for Particular Id examples: response: value: code: 1005 message: Subscription Not found for Particular Id summary: Unsubscribe subscription operationId: unsubscribeSubscription description: Delete webhook subscription to stop listening to subscribed webhook events on the subscribed url. tags: - Subscription parameters: - name: subscriptionId in: path description: '' required: true example: tyhjwvbtys56782hbjsAGH schema: type: string - name: businessId in: query description: Account business number. required: true example: '1234567890' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/messenger/webhook/event": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getEvents_Response200" example: - eventId: 1 eventName: conversation.created - eventId: 2 eventName: conversation.updated - eventId: 3 eventName: message.added - eventId: 4 eventName: conversation.closed summary: Get events operationId: getEvents description: List webhook events get events via webhook on multiple activities, whether the conversation is open, updated, closed, or a new message has been added. tags: - Webhook parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json "/v1/messenger/subscribe/webhook/event": post: responses: '200': description: OK content: application/json: schema: type: object properties: subscriptionId: type: number description: Event Id. events: type: array description: A list of event names that should trigger this webhook. items: {} businessId: type: number description: A unique ID generated by the Birdeye platform that identifies this business. required: - events example: subscriptionId: 2 businessId: 755009344 events: - conversation.created - conversation.updated - message.added - conversation.closed '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create webhook subscription operationId: createWebhookSubscription description: Create webhook subscription listens to webhook events on a specific passed URL. tags: - Webhook parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createWebhookSubscription_Request" example: businessNumber: '755009344' apiKey: 92bcd6e0-c102-43fd-8a67-1a7be5258451 events: - conversation.created - conversation.updated - message.added - message.closed endpoint: https://webhook.site/0c27e14d-f833-4589-b201-86b41a651464 "/v1/business/{EnterpriseBusinessNumber}/child": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getCompetitorBusiness_Response200" example: - id: 768996864 name: Environmental Pest Management competitorId: 2398456 alias: Environmental Pest Management - Westerville, OH - id: 144670708364016 name: Sub-reseller competitorId: 4598762 alias: Sub-reseller - id: 144670708364322 name: Holiday Inn competitorId: 9876567 alias: Holiday Inn '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Competitor Business operationId: getCompetitorBusiness description: Competitor of Enterprise Business retrieves list of all competitor businesses for an enterprise. tags: - Competitor parameters: - name: EnterpriseBusinessNumber in: path description: Enterprise Business id. required: true example: '231123123' schema: type: string - name: isCompetitor in: query description: True for get competitor business of Enterprise Business and False for get Child Business of Enterprise Business. required: true example: 'true' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/{EnterpriseCompetitorBusinessId}/child": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getCompetitorChildBusiness_Response200" example: - id: 986031488 name: Central Ohio Endodontics alias: Central Ohio Endodontics - Dublin, OH address: address1: 5152 Blazer Memorial Pkwy address2: Ste 102 city: Dublin state: OH zip: '43017' countryCode: US countryName: United States of America phone: "(614) 896-2801" type: Business status: active createdOn: Dec 04, 2013 compAccountId: 7876807 - id: 768996864 name: Environmental Pest Management alias: Environmental Pest Management - Westerville, OH address: address1: 200 Hoff Rd address2: Unit P city: Westerville state: OH zip: '43082' countryCode: US countryName: United States of America phone: "(614) 771-8605" type: Business status: active createdOn: Dec 05, 2013 compAccountId: 4567893 - id: 144670708364016 name: Sub-reseller alias: Sub-reseller status: active createdOn: Nov 05, 2013 type: Reseller childCount: 1 - id: 144670708364322 name: Holiday Inn alias: Holiday Inn status: active createdOn: Nov 01, 2013 type: Enterprise-Location childCount: 2 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Competitor Child Business operationId: getCompetitorChildBusiness description: Get Competitor Child Business retrieves all child locations. tags: - Competitor parameters: - name: isCompetitor in: query description: True for get competitor business of Enterprise Business and False for get Child Business of Enterprise Business. required: true example: 'true' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/business/{businessId}/competitors": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getBusinessCompetitors_Response200" example: - enterpriseId: 144679606934805 enterpriseName: taj businessCompetitors: - businessId: 144681844334495 name: texas location: address1: 44/5 address2: II-street city: San Jose state: CA zip: '102634' countryCode: US countryName: lat: lng: - enterpriseId: 144679577771476 enterpriseName: pullman businessCompetitors: - businessId: 144974367274032 name: paris location: address1: b/t 24th St address2: Mission city: San Francisco state: CA zip: '90011' countryCode: countryName: lat: lng: '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Business Competitors operationId: getBusinessCompetitors description: Get Business Competitors retrieves competitor’s details for an enterprise. tags: - Competitor parameters: - name: businessId in: path description: Account Business Number. required: true example: '986031488' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/signup/competitor/{businessNumber}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_createNewCompetitorEnterprise_Response200" example: competitorId: 100037739 templateid: 0 isAggregationRequired: 1 type: Enterprise-Location-Competitor businessNumber: 161295237142347 businessAlreadyPresent: false '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create New Competitor Enterprise operationId: createNewCompetitorEnterprise description: Create New Competitor Enterprise creates a new competitor for an enterprise. tags: - Competitor parameters: - name: businessNumber in: path description: Account Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createNewCompetitorEnterprise_Request" example: businessName: Location_compca userEmailId: ron@test.com countryCode: CA phone: 408-234-5272 zip: '95035' competitorId: 100037693 type: Product "/v1/signup/competitor/{businessId}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_createNewChildBusinessInCompetitorEnterprise_Response200" example: competitorId: 100037701 templateid: 0 isAggregationRequired: 0 type: Product businessNumber: 161278371646396 compAccountId: 1795 businessAlreadyPresent: true '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create New Child Business in Competitor Enterprise operationId: createNewChildBusinessInCompetitorEnterprise description: Create New Child Business in Competitor Enterprise creates a new child business for a competitor enterprise. tags: - Competitor parameters: - name: businessId in: path description: Account Business Number. required: true example: '986031488' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/aggregation/competitor/{compAccountId}/{businessNumber}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_addNewCompetitorAggregationUrl_Response200" examples: response: value: id: 237030543 sourceAlias: citysearch sourceName: Citysearch sourceUrl: http://www.citysearch.com/biz/maria sourceId: 2 compAccountId: 1765 Body: '' '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Add new Competitor Aggregation URL operationId: addNewCompetitorAggregationUrl description: Add new Competitor Aggregation URL adds an aggregation URL for a competitor location. tags: - Competitor parameters: - name: businessNumber in: path description: Id of the business. required: true example: '169744180007807' schema: type: number - name: compAccountId in: path description: Competitor Account Id. required: true example: '234567' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Add_aggregation_URLBody" content: application/json: example: sourceAlias: 'citysearch ' url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco "/v1/review/businessId/{CompetitorEnterpriseBusinessId}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getCompetitorReviews_Response200" example: - reviewId: '3947127516862' rating: 4 comments: Our water polo team stayed there for 4 nights while in for a tournament. It fit our needs perfectly. The rooms were squeaky clean and comfortable. The housekeeping staff was super efficient and k... title: reviewer: firstName: lastName: nickName: Jen C. thumbnailUrl: http://d3cnqzq0ivprch.cloudfront.net/demo/css/images/default-profile.png emailId: facebookId: city: Ann Arbor state: MI reviewUrl: http://www.citysearch.com/not_recommended_reviews/Knzq0i-RsFqWRaNKNWOQbw sourceType: citysearch reviewDate: Aug 01, 2014 response: responseDate: featured: 1 businessId: '755009344' uniqueReviewUrl: https://birdeye.com/websiter-755009344/review/3947127516862 businessName: Websiter businessType: Location - reviewId: '3947077656849' rating: 4 comments: Was scared when I saw that is was more if a motel the hotel, but for one night we would give it a try. The rooms were clean and the desk help was also good. It was a little noise but I fell aslee... title: reviewer: firstName: lastName: nickName: Stella S. thumbnailUrl: http://d2xt3xymj142xp.cloudfront.net/reviewer/4b7339a2c966485ab58ceaf7ae49e91e.jpeg emailId: facebookId: city: Diamond Bar state: CA reviewUrl: http://www.citysearch.com/biz/holiday-inn-express-san-jose-central-city-san-jose?hrid=mJpfRj7QaZzxaaLFRfR48w&nb=1 sourceType: citysearch reviewDate: Jul 31, 2014 response: responseDate: featured: 0 businessId: '755009344' uniqueReviewUrl: https://birdeye.com/websiter-755009344/review/3942327516353 businessName: Websiter businessType: Location '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1163Model" x-apiary-response-models: - "$ref": "#/components/schemas/1163Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1186Model" - "$ref": "#/components/schemas/1187Model" - "$ref": "#/components/schemas/1227Model" - "$ref": "#/components/schemas/1228Model" x-apiary-response-examples: error_1163: value: code: 1163 message: Invalid start index value error_1167: value: code: 1167 message: API key is missing error_1186: value: code: 1186 message: Invalid from date. Allowed format is "MM/dd/yyyy". error_1187: value: code: 1187 message: Invalid to date. Allowed format is "MM/dd/yyyy". error_1227: value: code: 1227 message: Invalid updated from date. Allowed format is MM/dd/yyyy error_1228: value: code: 1228 message: Invalid updated to date. Allowed format is MM/dd/yyyy examples: response: value: code: 1163 message: Invalid start index value '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1164Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1164: value: code: 1164 message: Invalid result count value examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Competitor Reviews operationId: getCompetitorReviews description: Get Competitor Review returns the list of review(s) of competitors for an account. tags: - Competitor parameters: - name: sindex in: query description: Start index of the reviews. required: true example: '10' schema: type: integer - name: count in: query description: Number of reviews to query. required: true example: '30' schema: type: integer - name: isCompetitor in: query description: True for Competitor Review. required: true example: 'false' schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: fromDate: type: string description: Review date (start) in UTC format. toDate: type: string description: Review date (end) in UTC format. updateFromDate: type: string description: Review updated date (start) in UTC format. updateToDate: type: string description: Review updated date (end) in UTC format. sources: type: string description: 'Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.' ratings: type: array description: Review rating Possible values 0,1,2,3,4,5. items: {} searchStr: type: string description: String that is contained by review. subBusinessIds: type: array description: BusinessIds under enterprise account. items: {} statuses: type: array description: Review status. Valid values are "published","parked","all". Default is "published" only. Status “published” refers to featured reviews, while “parked” refers to non-featured reviews. items: {} example: fromDate: 04/01/2013 toDate: 05/3/2015 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 searchStr: test string subBusinessIds: - 145308764185002 - 145308769721320 - 145308702026610 statuses: - published - parked example: fromDate: 04/01/2013 toDate: 05/3/2015 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 searchStr: test string subBusinessIds: - 145308764185002 - 145308769721320 - 145308702026610 statuses: - published - parked "/v1/competitors/competitive-insight/categories/{businessNumber}": post: responses: '200': description: OK content: application/json: example: cats: - catId: 16643 catName: ambience catStats: - entId: 398331 entName: Social Stress competitor: false grade: A colorCode: "#32661d" avgScr: 4.4 ct: 3146 subCats: - catId: 16644 catName: xyx catStats: - entId: 398331 entName: Social Stress competitor: false grade: A colorCode: "#32661d" avgScr: 4.1 ct: 1173 - catId: 15299 catName: test1 catStats: - entId: 398331 entName: Social Stress competitor: false grade: B+ colorCode: "#a0cfa2" avgScr: 3.7 ct: 2249 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Score operationId: getScore description: Get Score retrieves Insights category details for a competitor. tags: - Competitor parameters: - name: businessNumber in: path description: Account Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getScore_Request" "/v1/competitors/competitive-insight/themes/{businessNumber}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getThemeStatistics_Response200" example: id: 398331 name: Social Stress themes: - your money occr: 3 avgScore: 1.0 pPrct: 0.0 nPrct: 0.047169812 prct: 0.0063035805 pCt: 30707 nCt: 6360 ct: 47592 themeStats: - theme: your money adj: your kw: money pCt: 0 nCt: 3 ct: 3 score: 3 scr: 1.0 - theme: wrong vehicle adj: wrong kw: vehicle pCt: 4 nCt: 4 ct: 14 score: 4 scr: 1.0 competitors: - id: 530846 name: Social 1 themes: - your money occr: 0 avgScore: 0.0 pPrct: 0.0 nPrct: 0.0 prct: 0.0 pCt: 41 nCt: 67 ct: 132 themeStats: - theme: young lady adj: young kw: lady pCt: 0 nCt: 1 ct: 2 score: 1 scr: 1.0 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Theme Statistics operationId: getThemeStatistics description: Get Theme Statistics retrieves Insights topic details for a competitor. tags: - Competitor parameters: - name: businessNumber in: path description: Account Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getThemeStatistics_Request" example: sourceType: review sources: - google - citysearch startDate: 11/02/2020 endDate: 01/06/2021 competitors: - competitorId: 530846 compAccountIds: - 162426 - 144352 - competitorId: 720708 compAccountIds: - 165432 topThm: 25 orderBy: occurrence sentiment: -1 "/v1/competitors/competitive-insight/keywords/{businessNumber}": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getKeywordStatistics_Response200" example: id: 119468 name: Social Stress keywords: - experience ct: 27159 avgScr: 1.0 keywordStats: - keyword: experience occurences: 27158 score: 1.0 scr: 27158 - keyword: lady occurences: 2186 score: 1.0 scr: 2186 negKWAdjectives: - adjective: horrible occurences: 4137 avgScore: 1.0 prcnt: 15.232519 competitors: - id: 159180 name: Online Competitors keywords: - experience ct: 1176 avgScr: 1.0 keywordStats: - keyword: problem occurences: 2972 score: 1.0 scr: 2972 negKWAdjectives: - adjective: bad occurences: 340 avgScore: 1.0 prcnt: 28.911564 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Keyword Statistics operationId: getKeywordStatistics description: Get Keyword Statistics retrieves Insights keywords details for a competitor. tags: - Competitor parameters: - name: businessNumber in: path description: Account Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getKeywordStatistics_Request" example: sourceType: review sources: - google - citysearch startDate: 11/02/2020 endDate: 01/06/2021 competitors: - competitorId: 530846 compAccountIds: - 162426 - 144352 - competitorId: 720708 compAccountIds: - 165432 topKW: 25 topAd: 10 orderBy: ztoa sentiment: -1 "/v1/competitors/review": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_retrieveCompetitorReviews_Response200" example: - businessLocations: - businessId: 100031493 name: Dieci Lifestyle Spa1 alias: ST businessNumber: 157984189025195 phone: "(973) 716-0102" address: 90 W Mount Pleasant Ave competitorLocation: C1 competitorBrand: B1 source: Google rating: 4 reviewComment: Great experience reviewerName: Allen reviewDate: '2024-07-01' reply: Thanks for the review - businessLocations: - businessId: 100033957 name: Raghav_l businessNumber: 159116903548016 phone: "(202) 555-0175" competitorLocation: Dental Dreams competitorBrand: Dental Dreams - 60620 source: Yelp rating: 5 reviewComment: Excellent service! reviewerName: Maria reviewDate: '2024-07-03' reply: We appreciate your feedback! '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Retrieve Competitor Reviews operationId: retrieveCompetitorReviews description: This API retrieves competitor review data for specified business numbers and date ranges. tags: - Competitor AI parameters: - name: startIndex in: query description: The starting index for pagination (0-based). Default is 0. required: false example: '0' schema: type: number - name: pageSize in: query description: 'Number of records to return per page (max recommended: 100). Default is 25.' required: false example: '25' schema: type: number - name: sortOrder in: query description: 'Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 1.' required: false example: '1' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} fromDate: type: string description: Start date for the analysis period. toDate: type: string description: End date for the analysis period. sources: type: array description: Aggregation sources. items: {} brandIds: type: array description: Filter by specific competitor brand id. items: {} competitorLocationIds: type: array description: Filter by specific competitor location IDs. items: {} example: businessNumbers: [] fromDate: 04/01/2024 toDate: '08/03/2025' sources: [] brandIds: [] competitorLocationIds: [] example: businessNumbers: [] fromDate: 04/01/2024 toDate: '08/03/2025' sources: [] brandIds: [] competitorLocationIds: [] "/v1/competitors/review/metrics": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_retrieveCompetitorReviewMetrics_Response200" example: - businessLocations: - businessId: 100031493 name: Dieci Lifestyle Spa1 alias: ST businessNumber: 157984189025195 phone: "(973) 716-0102" address: 90 W Mount Pleasant Ave competitorLocation: Nuvia Dental Implant Center competitorBrand: Nuvia Dental Implant Center source: Google overallRating: 4.9 reviewCount: 1654 - businessLocations: - businessId: 100031493 name: Dieci Lifestyle Spa1 alias: ST businessNumber: 157984189025195 phone: "(973) 716-0102" address: 90 W Mount Pleasant Ave competitorLocation: Aspen Dental - El Paso, TX competitorBrand: Aspen Dental - El Paso, TX - 79912 source: Google overallRating: 4.7 reviewCount: 21 - businessLocations: - businessId: 100033957 name: Raghav_l businessNumber: 159116903548016 phone: "(202) 555-0175" competitorLocation: Monroe Dental Office competitorBrand: Monroe Dental Office - 10950 source: Google overallRating: 4.9 reviewCount: 740 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Retrieve Competitor Review metrics operationId: retrieveCompetitorReviewMetrics description: This API retrieves competitor metrics review data (average rating and total reviews) for specified business numbers and date ranges. tags: - Competitor AI parameters: - name: startIndex in: query description: The starting index for pagination (0-based). Default is 0. required: false example: '0' schema: type: number - name: pageSize in: query description: 'Number of records to return per page (max recommended: 100). Default is 25.' required: false example: '25' schema: type: number - name: sortOrder in: query description: 'Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 0.' required: false example: '0' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} fromDate: type: string description: Start date for the analysis period. toDate: type: string description: End date for the analysis period. sources: type: array description: Aggregation sources. items: {} brandIds: type: array description: Filter by specific competitor brand IDs. Maximum 5 brand IDs are allowed. items: {} competitorLocationIds: type: array description: Filter by specific competitor location IDs. items: {} example: businessNumbers: [] fromDate: 04/01/2024 toDate: '08/03/2025' sources: [] brandIds: [] competitorLocationIds: [] example: businessNumbers: [] fromDate: 04/01/2024 toDate: '08/03/2025' sources: [] brandIds: [] competitorLocationIds: [] "/v1/insight/experience/scoreBenchmark": post: responses: '200': description: OK content: application/json: schema: type: object properties: actual: type: object properties: sentimentScore: type: number description: Actual sentiment score reputationScore: type: number description: Actual reputation score experienceScore: type: number description: Actual experience score listingScore: type: number description: Actual listing score industrySentimentScore: type: number description: Industry benchmark sentiment score industryReputationScore: type: number description: Industry benchmark reputation score industryExperienceScore: type: number description: Industry benchmark experience score description: Current performance metrics compare: type: object properties: sentimentScore: type: number description: Comparison sentiment score reputationScore: type: number description: Comparison reputation score experienceScore: type: number description: Comparison experience score listingScore: type: number description: Comparison listing score description: Comparison period metrics example: actual: sentimentScore: 83.2 reputationScore: 73.2 experienceScore: 68.9 listingScore: 36.5 industrySentimentScore: 89.7 industryReputationScore: 86.0 industryExperienceScore: 87.8 compare: sentimentScore: 80.0 reputationScore: 72.8 experienceScore: 67.7 listingScore: 36.5 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2003Model" examples: response: value: code: 2003 message: businessNumbers are mandatory '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Insight Experience Score Benchmark operationId: getInsightExperienceScoreBenchmark description: Insight Experience Score Benchmark API retrieves benchmark scores comparing actual performance against industry standards and specified comparison periods for sentiment, reputation, experience, and listing metrics. tags: - Insight AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber. required: false example: "[Required] User associated businessNumber." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: List of business numbers (max 100). items: type: integer startDate: type: string description: Start date in MM/DD/YYYY format. endDate: type: string description: End date in MM/DD/YYYY format. reviewSources: type: array description: Review sources to include (e.g. Google, Facebook). items: type: string ratings: type: array description: Rating values to filter (e.g. "1", "2", "3", "4", "5"). items: type: string required: - businessNumbers - startDate - endDate example: reviewSources: - Google - Facebook - CitySearch ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 "/v1/insight/experience/over-time": post: responses: '200': description: OK content: application/json: schema: type: object properties: groupByType: type: string dataPoints: type: array items: type: object properties: startDate: type: string endDate: type: string label: type: string shortLabel: type: string experienceScore: type: number sentiment: type: object properties: score: type: number nullable: true reputation: type: object properties: score: type: number nullable: true listing: type: object properties: score: type: number nullable: true call: type: object properties: score: type: number nullable: true example: groupByType: month dataPoints: - startDate: 04/30/2026 endDate: 04/30/2026 label: Apr 2026 shortLabel: Apr '26 experienceScore: 0.0 sentiment: score: null reputation: score: 0.0 listing: score: 0.0 call: score: null - startDate: 05/01/2026 endDate: 05/31/2026 label: May 2026 shortLabel: May '26 experienceScore: 87.3 sentiment: score: null reputation: score: 90.0 listing: score: 84.5 call: score: null - startDate: 06/01/2026 endDate: 06/30/2026 label: Jun 2026 shortLabel: Jun '26 experienceScore: 86.7 sentiment: score: null reputation: score: 92.5 listing: score: 80.9 call: score: null - startDate: 07/01/2026 endDate: 07/31/2026 label: Jul 2026 shortLabel: Jul '26 experienceScore: 84.8 sentiment: score: null reputation: score: 88.8 listing: score: 80.9 call: score: null - startDate: 08/01/2026 endDate: 08/01/2026 label: Aug 2026 shortLabel: Aug '26 experienceScore: 0.0 sentiment: score: null reputation: score: 0.0 listing: score: 0.0 call: score: null '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2150Model" examples: response: value: code: 2150 message: Not a valid reseller/enterprise id. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/2151Model" examples: response: value: code: 2151 message: Not a valid reseller/enterprise id. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/1027Model" examples: response: value: code: 1027 message: Invalid business number. summary: Get Insight Experience Over Time operationId: getInsightExperienceOverTime description: The Insight Experience Over Time API provides a time-series view of experience scores at the account level. It aggregates sentiment, reputation, listing, and call scores across configurable time intervals — day, week, month, quarter, or year — enabling trend analysis and performance tracking over custom date ranges. tags: - Insight AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber. required: false example: "[Required] User associated businessNumber." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: List of business numbers (max 100). items: type: integer startDate: type: string description: Start date in MM/DD/YYYY format. endDate: type: string description: End date in MM/DD/YYYY format. reviewSources: type: array description: Review sources to include (e.g. Google, Facebook). items: type: string ratings: type: array description: Rating values to filter (e.g. "1", "2", "3", "4", "5"). items: type: string hierarchyNodeData: type: array description: List of hierarchy nodes to filter by level. items: type: object properties: levelId: type: string description: The hierarchy level identifier (e.g. Region). levelNames: type: array description: List of level names to filter. items: type: string groupBy: type: string description: Time interval to group results by (e.g. day, week, month, quarter, year). required: - businessNumbers - startDate - endDate example: reviewSources: - Google - Facebook - CitySearch ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 hierarchyNodeData: - levelId: Region levelNames: - Region1 - Region2 groupBy: month "/v1/insight/experience/locationInfo": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getInsightExperienceLocationInfo_Response200" example: totalCount: 2 dataPoints: - id: 149546078883527 name: 194 - Greywolf Veterinary Hospital experienceScore: 93.1 listingScore: 86.7 sentimentScore: 96.2 reputationScore: 93.8 experienceDeltaScore: 93 listingDeltaScore: 86 sentimentDeltaScore: 96 reputationDeltaScore: 93 experienceDelta: 0.1 listingDelta: 0.7 reputationDelta: 0.8 sentimentDelta: 0.2 - id: 149546078886677 name: The animal hospital experienceScore: 93.1 listingScore: 86.7 sentimentScore: 96.2 reputationScore: 93.8 experienceDeltaScore: 93 listingDeltaScore: 86 sentimentDeltaScore: 96 reputationDeltaScore: 93 experienceDelta: 0.1 listingDelta: 0.7 reputationDelta: 0.8 sentimentDelta: 0.2 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2150Model" x-apiary-response-models: - "$ref": "#/components/schemas/2150Model" - "$ref": "#/components/schemas/2003Model" x-apiary-response-examples: error_2150: value: code: 2150 message: Not a valid reseller/enterprise id. error_2003: value: code: 2003 message: businessNumbers are mandatory examples: response: value: code: 2150 message: Not a valid reseller/enterprise id. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1167Model" examples: response: value: code: 1167 message: API key is missing '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/2151Model" examples: response: value: code: 2151 message: Not a valid reseller/enterprise id. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/1027Model" examples: response: value: code: 1027 message: Invalid business number. summary: Get Insight Experience Location Info operationId: getInsightExperienceLocationInfo description: Insight Experience Location Info API retrieves location-wise experience metrics including sentiment, reputation, experience, and listing scores along with delta comparisons for specified business locations and date ranges. tags: - Insight AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber. required: false example: "[Required] User associated businessNumber." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: List of business numbers (max 100). items: type: integer startDate: type: string description: Start date in MM/DD/YYYY format. endDate: type: string description: End date in MM/DD/YYYY format. reviewSources: type: array description: Review sources to include (e.g. Google, Facebook). items: type: string ratings: type: array description: Rating values to filter (e.g. "1", "2", "3", "4", "5"). items: type: string hierarchyNodeData: type: array description: List of hierarchy nodes to filter by level. items: type: object properties: levelId: type: string description: The hierarchy level identifier (e.g. Region). levelNames: type: array description: List of level names to filter. items: type: string groupByLevel: type: string description: The level to group results by (e.g. Region). userEmail: type: string description: Email of the user performing the request. required: - businessNumbers - startDate - endDate - userEmail example: reviewSources: - Google - Facebook - CitySearch ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 hierarchyNodeData: - levelId: Region levelNames: - Region1 - Region2 groupByLevel: Region userEmail: example@birdeye.com "/v1/qna/question/create": post: responses: '200': description: OK content: application/json: schema: type: object properties: question_id: type: number description: unique question identifier example: question_id: 2892 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Question operationId: createQuestion description: |- Create a new question and associated answer > __Best practise__ > - _Please ensure that a business appropriate question and associated answer is created. Recommendation is to create typical FAQ like questions._ tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: question: type: string description: text of the question to be posted on Google Q&A profile ; minimum 3 word and 10 characters ; maximum 4096 characters answer: type: string description: text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character ; maximum 4096 characters required: - question - answer example: question: Enter question here answer: Enter answer here example: question: Enter question here answer: Enter answer here "/v1/qna/answer/create": post: responses: '200': description: OK content: application/json: schema: type: object properties: answer_id: type: string description: unique answer identifier example: answer_id: 2893 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" - "$ref": "#/components/schemas/2461Model" - "$ref": "#/components/schemas/2462Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words error_2461: value: code: 2461 message: No question found with provided request error_2462: value: code: 2462 message: Owner answer already added please edit answer examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Answer operationId: createAnswer description: |- Add an answer to an existing question. Owner can add only one answer per question. This API would be needed when you wish to answer a third party raised question. In this use case, you would need to do a GET all Q&A API call, identify the unanswered Q’s and then use this Create Answer API to answer the same. tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: questionId: type: number description: unique question identifier answer: type: string description: text of the question to be posted on Google Q&A profile ; minimum 1 one non-space character ; maximum 4096 characters required: - questionId - answer example: questionId: 7812 answer: Enter answer here example: questionId: 7812 answer: Enter answer here "/v1/qna/question/update": put: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" - "$ref": "#/components/schemas/2461Model" - "$ref": "#/components/schemas/2480Model" - "$ref": "#/components/schemas/2482Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words error_2461: value: code: 2461 message: No question found with provided request error_2480: value: code: 2480 message: Cannot modify non owner Q&A error_2482: value: code: 2482 message: Question Id is Invalid examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Question operationId: updateQuestion description: Update an existing question. You can edit/ update an existing question posted / created by you. Google does not allow you to edit/ update a third party posted Question. tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: questionId: type: number description: unique question identifier question: type: string description: text of the question to be posted on Google Q&A profile ; minimum 3 word and 10 characters ; maximum 4096 characters required: - questionId - question example: questionId: 7812 question: Enter question here example: questionId: 7812 question: Enter question here "/v1/qna/answer/update": put: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" - "$ref": "#/components/schemas/2461Model" - "$ref": "#/components/schemas/2480Model" - "$ref": "#/components/schemas/2482Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words error_2461: value: code: 2461 message: No question found with provided request error_2480: value: code: 2480 message: Cannot modify non owner Q&A error_2482: value: code: 2482 message: Question Id is Invalid examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Answer operationId: updateAnswer description: Update an answer to an existing question. You can edit/ update an existing answer posted / created by you. Google does not allow you to edit/ update a third party posted answer tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: questionId: type: number description: unique question identifier answerId: type: number description: unique answer identifier answer: type: string description: text of the answer to be posted on Google Q&A profile ; minimum 1 one non-space character ; maximum 4096 characters required: - questionId - answerId - answer example: questionId: 7812 answerId: 7813 question: Enter answer here example: questionId: 7812 answerId: 7813 question: Enter answer here "/v1/qna/question/delete": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" - "$ref": "#/components/schemas/2461Model" - "$ref": "#/components/schemas/2480Model" - "$ref": "#/components/schemas/2482Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words error_2461: value: code: 2461 message: No question found with provided request error_2480: value: code: 2480 message: Cannot modify non owner Q&A error_2482: value: code: 2482 message: Question Id is Invalid examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Question operationId: deleteQuestion description: |- Delete existing questions. Only those questions can be deleted which are created by the owner. > __Note__ > - _Associated answers with the question will also be deleted._ tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: questionId: type: number description: unique question identifier required: - questionId example: questionId: 7812 example: questionId: 7812 "/v1/qna/answer/delete": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" - "$ref": "#/components/schemas/2461Model" - "$ref": "#/components/schemas/2480Model" - "$ref": "#/components/schemas/2482Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words error_2461: value: code: 2461 message: No question found with provided request error_2480: value: code: 2480 message: Cannot modify non owner Q&A error_2482: value: code: 2482 message: Question Id is Invalid examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Answer operationId: deleteAnswer description: Delete answers to existing questions. Only that answer can be deleted which is posted by the owner. tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Delete_AnswerBody" content: application/json: example: questionId: 7812 answerId: 7813 "/v1/qna/question/deleteAll": delete: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2478Model" - "$ref": "#/components/schemas/2479Model" - "$ref": "#/components/schemas/2481Model" - "$ref": "#/components/schemas/2485Model" - "$ref": "#/components/schemas/2483Model" - "$ref": "#/components/schemas/2461Model" - "$ref": "#/components/schemas/2480Model" - "$ref": "#/components/schemas/2482Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2478: value: code: 2478 message: Question is required error_2479: value: code: 2479 message: Answer is required error_2481: value: code: 2481 message: Q&A cannot be more than 4096 characters error_2485: value: code: 2485 message: Questions should be 10 characters minimum error_2483: value: code: 2483 message: Question should have minimum 3 words error_2461: value: code: 2461 message: No question found with provided request error_2480: value: code: 2480 message: Cannot modify non owner Q&A error_2482: value: code: 2482 message: Question Id is Invalid examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete All Questions and Answers operationId: deleteAllQuestionsAndAnswers description: Delete all Q&A on the businessId provided. tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Delete_AnswerBody" content: application/json: example: questionId: 7812 answerId: 7813 "/v1/qna/get": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllQuestionsAndAnswers_Response200" example: totalCount: 1 questionsAndAnswers: - questionId: 5107 answeredByOwner: true askedByOwner: true question: This is dummy question updatedBy: John time: 10:52 PM updatedOn: Apr 10, 2024 userProfileLogoUrl: https://logo.png userCategory: MERCHANT locationName: XYZ noOfAnswers: 1 answers: - answerId: 5108 answer: This is dummy answer updatedBy: John updatedOn: Apr 10, 2024 answeredByOwner: true userCategory: MERCHANT time: 10:52 PM userProfileLogoUrl: https://logo.png '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2466Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2466: value: code: 2466 message: Invalid input request examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get All Questions and Answers operationId: getAllQuestionsAndAnswers description: Get all Questions and Answers for a Location tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Get_All_Questions_and_AnswersBody" content: application/json: example: startIndex: 0 pageSize: 25 "/v1/qna/unanswered/get": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllUnansweredQuestionsAndAnswers_Response200" example: totalCount: 1 questionsAndAnswers: - questionId: 5107 answeredByOwner: false askedByOwner: false question: This is dummy question updatedBy: John time: 10:52 PM updatedOn: Apr 10, 2024 userProfileLogoUrl: https://logo.png userCategory: MERCHANT locationName: XYZ noOfAnswers: 1 answers: - answerId: 5108 answer: This is dummy answer updatedBy: John updatedOn: Apr 10, 2024 answeredByOwner: false userCategory: MERCHANT time: 10:52 PM userProfileLogoUrl: https://logo.png '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/2466Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_2466: value: code: 2466 message: Invalid input request examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get All Unanswered Questions and Answers operationId: getAllUnansweredQuestionsAndAnswers description: Get all Unanswered Questions and Answers for a Location tags: - Google Q&A parameters: - name: businessId in: query description: Id of the business. required: true example: '12345678' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Get_All_Questions_and_AnswersBody" content: application/json: example: startIndex: 0 pageSize: 25 "/v1/google-services/service/create": post: responses: '200': description: OK content: application/json: schema: type: object properties: serviceId: type: string description: Unique service identifier example: serviceId: SERV10021056 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2486Model" x-apiary-response-models: - "$ref": "#/components/schemas/2486Model" - "$ref": "#/components/schemas/2487Model" - "$ref": "#/components/schemas/2488Model" - "$ref": "#/components/schemas/2489Model" - "$ref": "#/components/schemas/2490Model" - "$ref": "#/components/schemas/2491Model" - "$ref": "#/components/schemas/2492Model" - "$ref": "#/components/schemas/2493Model" x-apiary-response-examples: error_2486: value: code: 2486 message: Business Id missing or invalid error_2487: value: code: 2487 message: Invalid input request data error_2488: value: code: 2488 message: Invalid GBP Service name error_2489: value: code: 2489 message: Invalid GBP Service description error_2490: value: code: 2490 message: Invalid GBP Service price type error_2491: value: code: 2491 message: Invalid GBP Service price error_2492: value: code: 2492 message: Invalid GBP Service currency code error_2493: value: code: 2493 message: Duplicate Google Service is not allowed examples: response: value: code: 2486 message: Business Id missing or invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Service operationId: createService description: |- Create a new service for the account > __Best practise__ > - _Please ensure that a business appropriate service is created._ tags: - Google Services parameters: - name: businessId in: query description: Id of the account required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: name: type: string description: Service name (1–140 characters) currencyCode: type: string description: currency code of the paid service price: type: number description: price of the paid service description: type: string description: Max 300 characters group: type: string description: 'A logical grouping label for related services ; Used internally to categorize services under a common group name ; if not provided ; the service will remain uncategorized ; Note: This field is not synced to Google ; minimum 3 character ; maximum 64 characters' duration: type: number description: 'The expected length of time for the service ; expressed in minutes ; Used internally ; Optional ; if not provided ; no default duration will be set. Note: This field is not synced to Google; minimum 1 ; maximum 9999 minutes' required: - name example: name: Customer Service currencyCode: USD price: 100.5 description: We provide 24x7 customer service group: Hair Care duration: 90 example: name: Customer Service currencyCode: USD price: 100.5 description: We provide 24x7 customer service group: Hair Care duration: 90 "/v1/google-services/services": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllServices_Response200" example: services: - serviceId: SERV10021056 name: Customer Service currencyCode: USD price: 100.5 description: We provide 24x7 customer service group: Hair Care duration: 90 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2486Model" examples: response: value: code: 2486 message: Business Id missing or invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get All Services operationId: getAllServices description: Get all services for an account tags: - Google Services parameters: - name: businessId in: query description: Id of the account required: true example: '169744180007807' schema: type: number - name: startIndex in: query description: start index; default 0 required: true example: '0' schema: type: number - name: pageSize in: query description: page size; default 25 required: true example: '25' schema: type: number - name: sortBy in: query description: '"updated", "name" or "price"; default : updated' required: true example: updated schema: type: string - name: sortOrder in: query description: '"asc" or "desc"; default: desc' required: true example: desc schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: search: type: string description: search phrase for the service. This could be service Id or name phrase, e.g. "1002", "Customer". example: search: Customer Service example: search: Customer Service "/v1/google-services/service/update": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2486Model" x-apiary-response-models: - "$ref": "#/components/schemas/2486Model" - "$ref": "#/components/schemas/2487Model" - "$ref": "#/components/schemas/2488Model" - "$ref": "#/components/schemas/2489Model" - "$ref": "#/components/schemas/2490Model" - "$ref": "#/components/schemas/2491Model" - "$ref": "#/components/schemas/2492Model" - "$ref": "#/components/schemas/2493Model" - "$ref": "#/components/schemas/2494Model" x-apiary-response-examples: error_2486: value: code: 2486 message: Business Id missing or invalid error_2487: value: code: 2487 message: Invalid input request data error_2488: value: code: 2488 message: Invalid GBP Service name error_2489: value: code: 2489 message: Invalid GBP Service description error_2490: value: code: 2490 message: Invalid GBP Service price type error_2491: value: code: 2491 message: Invalid GBP Service price error_2492: value: code: 2492 message: Invalid GBP Service currency code error_2493: value: code: 2493 message: Duplicate Google Service is not allowed error_2494: value: code: 2494 message: Invalid GBP Service Id examples: response: value: code: 2486 message: Business Id missing or invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Service operationId: updateService description: |- Update an existing service of an account. > __Note__ > - _Any change in service will be reflected across all the locations mapped to the service._ tags: - Google Services parameters: - name: businessId in: query description: Id of the account required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: serviceId: type: string description: unique service identifier name: type: string description: text of the service name posted on Google Services profile; name cannot be altered. currencyCode: type: string description: text of the paid service currency code to be posted on Google Services profile; This is a mandatory field in case of paid service ; 'USD', 'GBP', 'CAD', 'AUD', 'NZD', 'EUR', 'MXN', 'INR', 'AED', 'CHF', 'CNY', 'CZK', 'EGP', 'HKD', 'HUF', 'IDR', 'ILS', 'JPY', 'KES', 'KRW', 'LKR', 'MAD', 'MOP', 'MYR', 'PHP', 'PLN', 'RON', 'RUB', 'ZAR', 'SEK', 'SGD', 'THB', 'TRY', 'TWD', 'VND', 'SAR', 'KHR', 'MNT', 'NOK' or 'DKK' value price: type: number description: amount of the paid service price to be posted on Google Services profile; This is a mandatory field in case of paid service ; minimum amount 0.10 ; maximum amount 2147483647 description: type: string description: text of the service description to be posted on Google Services profile ; minimum 0 character ; maximum 300 characters group: type: string description: 'A logical grouping label for related services ; Used internally to categorize services under a common group name ; if not provided ; the service will remain uncategorized ; Note: This field is not synced to Google ; minimum 3 character ; maximum 64 characters' duration: type: number description: 'The expected length of time for the service ; expressed in minutes ; Used internally ; Optional ; if not provided ; no default duration will be set. Note: This field is not synced to Google ; minimum 1 ; maximum 9999 minutes' required: - serviceId - name example: serviceId: SERV10021056 name: Customer Service currencyCode: USD price: 100.5 description: We provide 24x7 customer service group: Hair Care duration: 90 example: serviceId: SERV10021056 name: Customer Service currencyCode: USD price: 100.5 description: We provide 24x7 customer service group: Hair Care duration: 90 "/v1/google-services/service/delete": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2486Model" x-apiary-response-models: - "$ref": "#/components/schemas/2486Model" - "$ref": "#/components/schemas/2495Model" x-apiary-response-examples: error_2486: value: code: 2486 message: Business Id missing or invalid error_2495: value: code: 2495 message: Invalid GBP Service Id examples: response: value: code: 2486 message: Business Id missing or invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Services operationId: deleteServices description: |- Delete existing services of an account > __Note__ > - _Any change in service will be reflected across all the locations mapped to the service._ tags: - Google Services parameters: - name: businessId in: query description: Id of the account required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: serviceIds: type: array description: List of unique service identifier items: {} required: - serviceIds example: serviceIds: - SERV10021056 - SERV10021057 example: serviceIds: - SERV10021056 - SERV10021057 "/v1/google-services/service/location-mapping": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getLocationMapping_Response200" example: Marketing: - serviceId: SERV10021056 name: Customer Service currencyCode: USD price: 100.5 description: We provide 24x7 customer service group: Hair Care duration: 90 - serviceId: SERV10021057 name: Marketing Service description: We provide 24x7 marketing service Advertisement: - serviceId: SERV10021058 name: Advertising Service currencyCode: USD price: 100.5 description: We provide advertising service across various platforms group: Hair Care duration: 90 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2486Model" examples: response: value: code: 2486 message: Business Id missing or invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Location Mapping operationId: getLocationMapping description: Get location level service - category mapping tags: - Google Services parameters: - name: businessId in: query description: Id of the business required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string "/v1/google-services/services/location-mapping": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2486Model" x-apiary-response-models: - "$ref": "#/components/schemas/2486Model" - "$ref": "#/components/schemas/2487Model" - "$ref": "#/components/schemas/2496Model" - "$ref": "#/components/schemas/2493Model" - "$ref": "#/components/schemas/2494Model" x-apiary-response-examples: error_2486: value: code: 2486 message: Business Id missing or invalid error_2487: value: code: 2487 message: Invalid input request data error_2496: value: code: 2496 message: Missing GBP category for given location error_2493: value: code: 2493 message: Duplicate Google Service is not allowed error_2494: value: code: 2494 message: Invalid GBP Service Id examples: response: value: code: 2486 message: Business Id missing or invalid '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Location Mapping operationId: updateLocationMapping description: |- Map services to categories at location level > __Note__ > - _Any change will impact the service mapped to all the locations._ tags: - Google Services parameters: - name: businessId in: query description: Id of the business required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: category_name: type: string description: name of the GMB category service_id: type: array description: List of unique service identifier items: {} required: - category_name - service_id example: Marketing: - SERV10021056 - SERV10021057 example: Marketing: - SERV10021056 - SERV10021057 "/v1/quero/external/get-all-qna": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllQna_Response200" example: qnAs: - question: text: What payment options does RetailPrime platform support? updatedDate: '2026-01-15T09:00:00.000+0000' answers: - text: RetailPrime supports credit card, debit card, and PayPal payments. allLocations: true source: AI sourceType: FILE sourceValue: sample.txt businessNumbers: - 123456789123456 - 987654321987654 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1167Model" x-apiary-response-models: - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/5008Model" - "$ref": "#/components/schemas/5043Model" x-apiary-response-examples: error_1167: value: code: 1167 message: API key is missing error_5008: value: code: 5008 message: RequestBody not found error_5043: value: code: 5043 message: Contact not found for the given request examples: response: value: code: 1167 message: API key is missing '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1532Model" examples: response: value: code: 1532 message: Business id is missing or invalid. '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get All QnA operationId: getAllQna description: Customers can fetch a paginated, ordered list of all QnA entries available for a business. tags: - FAQ parameters: - name: sIndex in: query description: The starting index for the records to fetch. Default is 0 if not specified. required: false example: '0' schema: type: number - name: count in: query description: The number of QnA records to return.Default is 25 if not specified. required: false example: '25' schema: type: number - name: order in: query description: The ordering in which records should be returned by last updated date (0 for ascending, 1 for descending).Default is 1 if not specified. required: false example: '1' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange.. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange.." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber required: false example: "[Required] User associated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: "[OPTIONAL] Business numbers of locations under enterprise. If not assigned, all valid QnA assigned in the enterprise will be selected." items: {} example: businessNumbers: - 175009059995828 - 169028735563867 - 166609110899853 - 164873686901155 - 164863775654389 - 164847076003414 example: businessNumbers: - 175009059995828 - 169028735563867 - 166609110899853 - 164873686901155 - 164863775654389 - 164847076003414 "/v1/listing/fix": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Fix Listing operationId: fixListing description: Fix Listing publishes information on online listing sources. We post presence information on more than 50 online directories. tags: - Listing parameters: - name: b_id in: query description: Id of the business. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Fix_ListingBody" content: application/json: example: {} "/v1/listing/status/location": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getLocationStatusReport_Response200" example: businessName: FLTLT - Tulip Cremation Tampa activationStatus: active lastUpdated: Mon Jun 10 09:49:30 GMT 2024 locationStatus: Published publishListings: Please initiate Publish for this locations listings. errors: - The selected address is invalid or not supported. - The business description needs to be longer than 200 characters. - Please activate your demo location. totalSites: 44 syncedCount: 30 submittedCount: 13 needUpdatesCount: 0 optedOutCount: 0 notConnectedCount: 1 syncedPercentage: 68.18% submittedPercentage: 29.55% needUpdatesPercentage: 0.00% optedOutPercentage: 0.00% notConnectedPercentage: 2.27% sites: - siteId: 2 siteName: Google Maps status: Action Required errors: - The geographic coordinates and the address you provided do not match. Make sure that the address line and zip code are correct. url: https://maps.google.com/maps?cid=17209435735184138870 - siteId: 110 siteName: Facebook status: Connect - siteId: 226 siteName: Bing status: In Progress url: https://www.bing.com/maps?ss=ypid.YN377x6765823 - siteId: 100 siteName: Birdeye status: Synced url: https://birdeye.com/farm-bureau-insurance-163944578027442 - siteId: 381 siteName: Apple Maps status: Action Required errors: - Apple Category for the business is not available - siteId: 142 siteName: Opendi status: Action Required errors: - We’re unable to update your listing as there is a 'Claim Listing' issue which requires release of management of listings from the previous listings management provider. Please contact support for assistance. url: https://columbia-la.opendi.us/10046961.html '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/3333Model" examples: response: value: code: 1043 message: Business should be either SMB or Enterprise sub account '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Location Status Report operationId: getLocationStatusReport description: A detailed view of the listings status at location level tags: - Listing parameters: - name: businessNumber in: query description: Id of the business. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/insights": post: responses: '200': description: OK content: application/json: schema: type: object properties: mapViewTotalCount: type: number example: 2868 description: Business impressions on Google Maps on Desktop and mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression on Google. searchViewTotalCount: type: number example: 2868 description: Business impressions on Google Search on Desktop and mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression on Google. websiteVisitsTotalCount: type: number example: 2868 description: The number of times the business profile website was clicked on Google. getDirectionsTotalCount: type: number description: The number of times a direction request was requested to the business location on Google. callsTotalCount: type: number example: 2868 description: The number of times the business profile call button was clicked on Google. usersReachedTotalCount: type: number description: The number of times your business appeared in search results and other services on Facebook. usersEngagedTotalCount: type: number description: The number of times users have engaged with your business through reactions, comments, shares and more on Facebook. impressionCountTotalCount: type: number description: The number of users who saw the activity from your page including posts, check-ins, and ads on Bing. bingWebsiteVisitsTotalCount: type: number example: 2868 description: The number of times the business profile website was clicked on Bing. bingDirectionsTotalCount: type: number description: The number of times a direction request was requested to the business location on Bing. bingCallsTotalCount: type: number example: 2868 description: The number of times the business profile call button was clicked on Bing. liveCount: type: number example: 10 description: Total no of synched sites for a business. entityCount: type: number example: 1 description: Total businesses count. example: mapViewTotalCount: 2868 searchViewTotalCount: 2868 websiteVisitsTotalCount: 2868 getDirectionsTotalCount: 0 callsTotalCount: 2868 usersReachedTotalCount: 0 usersEngagedTotalCount: 0 impressionCountTotalCount: 0 bingWebsiteVisitsTotalCount: 2868 bingDirectionsTotalCount: 0 bingCallsTotalCount: 2868 liveCount: 10 entityCount: 1 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Listings Insights operationId: listingsInsights description: Insights/Analytics for Google Listings of a given business. tags: - Listing parameters: - name: businessId in: query description: Id of the account. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_listingsInsights_Request" example: businessNumbers: - 156387109031976 startDate: '2010-02-01' endDate: '2022-02-01' viewMode: - Mobile - Desktop "/v1/listing/report/{reportType}/datapoints": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_listingsInsightsDatapoints_Response200" example: - label: 02/01/2020 wsiteVisitsCount: 670 directionsCount: 670 callsCount: 670 - label: 01/01/2021 wsiteVisitsCount: 730 directionsCount: 730 callsCount: 730 - label: 01/01/2022 wsiteVisitsCount: 730 directionsCount: 730 callsCount: 730 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Listings Insights Datapoints operationId: listingsInsightsDatapoints description: Datapoints of report graph is date/label mapped to value/data of a given business. tags: - Listing parameters: - name: reportType in: path description: Report type, Possible values [google_view_search_map, gmb_customer_actions_map, fb_users_reached,fb_users_engaged, bing_impression_count,bing_customer_actions] required: true example: google_view_search_map schema: type: string - name: businessId in: query description: Id of the account. required: true example: '12345678' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_listingsInsightsDatapoints_Request" example: businessNumbers: - 156387109031976 startDate: '2010-02-01' endDate: '2022-02-01' groupByType: year viewMode: - Mobile - Desktop "/v1/listing/{businessNumber}/gmb-attributes-list": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getGmbAttributes_Response200" example: Accessibility: - attributeId: has_wheelchair_accessible_restroom valueType: BOOL displayName: Wheelchair accessible restroom groupDisplayName: Accessibility valueMetadata: - value: 'true' displayName: Wheelchair accessible restroom - value: 'false' displayName: No wheelchair accessible restroom - attributeId: has_wheelchair_accessible_seating valueType: BOOL displayName: Wheelchair accessible seating groupDisplayName: Accessibility valueMetadata: - value: 'true' displayName: Wheelchair accessible seating - value: 'false' displayName: No wheelchair accessible seating Crowd: - attributeId: welcomes_lgbtq valueType: BOOL displayName: LGBTQ+ friendly groupDisplayName: Crowd valueMetadata: - value: 'true' displayName: LGBTQ+ friendly - attributeId: is_transgender_safespace valueType: BOOL displayName: Transgender safespace groupDisplayName: Crowd valueMetadata: - value: 'true' displayName: Transgender safespace Planning: - attributeId: requires_appointments valueType: BOOL displayName: Appointment required groupDisplayName: Planning valueMetadata: - value: 'true' displayName: Appointment required '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/4011Model" x-apiary-response-models: - "$ref": "#/components/schemas/4011Model" - "$ref": "#/components/schemas/4012Model" - "$ref": "#/components/schemas/4013Model" - "$ref": "#/components/schemas/2521Model" - "$ref": "#/components/schemas/2522Model" x-apiary-response-examples: error_4011: value: code: 400 message: Category Id not found error_4012: value: code: 400 message: Country code not found error_4013: value: code: 400 message: Invalid country code error_2521: value: code: 2285 message: Invalid text message number error_2522: value: code: 2286 message: Invalid whatsapp business link examples: response: value: code: 400 message: Category Id not found '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get GMB Attributes operationId: getGmbAttributes description: The Get GMB Attributes API fetches the list of applicable GMB attributes for the selected GMB category ID tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: categoryId in: query description: Category id. required: true example: gcid:electrical_installation_service schema: type: string - name: countryCode in: query description: Code of the country, Possible values are US,CA,AU,PR,NZ,MX,IN,UK,FR,IT. required: true example: US schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/{businessNumber}/apple-location-attributes-list": get: responses: '200': description: OK content: application/json: schema: type: object properties: Accessibility: type: array items: {} description: This is dynamic field. Depends upon request inputs. example: crossbusiness.family_kids: - attributeId: kidsclub description: Kids club is the facility that a business or establishment has where various social and recreational activities are available for children's entertainment. crossbusiness.goodfor: - attributeId: groups description: Good for groups refer that the establishment is good for people in groups. - attributeId: singles description: Good for singles refer that the establishment is good for people who are single. crossbusiness.barservice: - attributeId: no_alcohol description: Business that does not serve alcohol. - attributeId: bar_lounge description: The bar lounge is the facility where non-alcoholic, alcoholic drinks and other condiments are available in a room with comfortable tables and sittings. crossbusiness.cellphone_rental: [] '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/4011Model" x-apiary-response-models: - "$ref": "#/components/schemas/4011Model" - "$ref": "#/components/schemas/4012Model" - "$ref": "#/components/schemas/4013Model" x-apiary-response-examples: error_4011: value: code: 400 message: Category Id not found error_4012: value: code: 400 message: Country code not found error_4013: value: code: 400 message: Invalid country code examples: response: value: code: 400 message: Category Id not found '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Apple Attributes operationId: getAppleAttributes description: 'The Get Apple Attributes API fetches the list of applicable Apple attributes. An attribute is typically something that helps describe your location better. E.g.: You provide paid parking or that your location is kid friendly etc.' tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/{businessNumber}/apple-action-links": get: responses: '200': description: OK content: application/json: schema: type: object properties: Accessibility: type: array items: {} description: This is dynamic field. Depends upon request inputs. example: - id: quicklinks.parking_available_parking name: Parking - id: quicklinks.parking_reserve_parking name: Reserve - id: quicklinks.restaurant_join_waitlist name: Waitlist - id: quicklinks.restaurant_order_delivery name: Delivery - id: quicklinks.restaurant_order_food name: Order - id: quicklinks.restaurant_pickup name: Pickup '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/4011Model" x-apiary-response-models: - "$ref": "#/components/schemas/4011Model" - "$ref": "#/components/schemas/4012Model" - "$ref": "#/components/schemas/4013Model" x-apiary-response-examples: error_4011: value: code: 400 message: Category Id not found error_4012: value: code: 400 message: Country code not found error_4013: value: code: 400 message: Invalid country code examples: response: value: code: 400 message: Category Id not found '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Apple Action Links operationId: getAppleActionLinks description: The Get Apple Action Links fetches the list of applicable Apple Action Link Types. Apple action links are the click throughs that are displayed in the action row on your Apple Maps listings also known as the Apple Maps Placecard. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/{businessNumber}/category-list": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getCategoryList_Response200" '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/4014Model" x-apiary-response-models: - "$ref": "#/components/schemas/4014Model" - "$ref": "#/components/schemas/4012Model" - "$ref": "#/components/schemas/4013Model" - "$ref": "#/components/schemas/4015Model" x-apiary-response-examples: error_4014: value: code: 400 message: Source name not found error_4012: value: code: 400 message: Country code not found error_4013: value: code: 400 message: Invalid country code error_4015: value: code: 400 message: Invalid Source Name examples: response: value: code: 400 message: Source name not found '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Category List operationId: getCategoryList description: The Get Category List API fetches the list of category values for the selected source. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: sourceName in: query description: Source name for which category data needs to be fetched. Possible values are BING, HEALTHCARE, GMB, VENDOR, FACEBOOK, APPLE. required: true example: BING schema: type: string - name: countryCode in: query description: Code of the country, Possible values are US,CA,AU,PR,NZ,MX,IN,UK,FR,IT. required: true example: US schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/{businessNumber}/create": post: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2296Model" x-apiary-response-models: - "$ref": "#/components/schemas/2296Model" - "$ref": "#/components/schemas/2297Model" - "$ref": "#/components/schemas/2290Model" - "$ref": "#/components/schemas/3334Model" - "$ref": "#/components/schemas/3335Model" - "$ref": "#/components/schemas/3336Model" - "$ref": "#/components/schemas/3337Model" - "$ref": "#/components/schemas/3348Model" - "$ref": "#/components/schemas/2511Model" - "$ref": "#/components/schemas/2512Model" - "$ref": "#/components/schemas/2513Model" - "$ref": "#/components/schemas/2514Model" - "$ref": "#/components/schemas/2515Model" - "$ref": "#/components/schemas/2516Model" - "$ref": "#/components/schemas/2517Model" - "$ref": "#/components/schemas/2518Model" - "$ref": "#/components/schemas/2519Model" - "$ref": "#/components/schemas/2520Model" - "$ref": "#/components/schemas/2521Model" - "$ref": "#/components/schemas/2522Model" - "$ref": "#/components/schemas/6000Model" - "$ref": "#/components/schemas/6001Model" x-apiary-response-examples: error_2296: value: code: 2296 message: Invalid Food Delivery link error_2297: value: code: 2297 message: Invalid Food Takeout link error_2290: value: code: 2290 message: Food Takeout/Food Delivery not supported for gmb primary category error_3334: value: code: 2503 message: Primary category can not be included in additional category. error_3335: value: code: 2276 message: Please add upto 9 GBP additional categories only. error_3336: value: code: 2277 message: Duplicate GBP categories are not allowed. error_3337: value: code: 2278 message: Primary GBP category is not allowed in additional GBP categories. error_3348: value: code: 2162 message: Reopen date should not be less than current date. error_2511: value: code: 2511 message: Cannot update business status when listing is already fixed. error_2512: value: code: 2512 message: Cannot update opening soon date when listing is already fixed. error_2513: value: code: 2513 message: Opened On date can not be in future. error_2514: value: code: 2514 message: Opening Soon date is mandatory when business is marked as Opening soon. error_2515: value: code: 2515 message: Reopen date is not supported for this date. error_2516: value: code: 2516 message: Opening Soon Date can not be more than 1 year from now. error_2517: value: code: 2517 message: Opening Soon date should not be less than current date. error_2518: value: code: 2518 message: Business Status is mandatory to pass with reopen, opened on and opening soon date. error_2519: value: code: 2519 message: Third party categories change for opening soon business is not allowed. error_2520: value: code: 2520 message: Open Date is not supported for this date error_2521: value: code: 2285 message: Invalid text message number error_2522: value: code: 2286 message: Invalid whatsapp business link error_6000: value: code: 6000 message: The 'sub_locality' field is mandatory for addresses in New Zealand. error_6001: value: code: 6001 message: The 'sub_locality' field cannot exceed 80 characters. examples: response: value: code: 2296 message: Invalid Food Delivery link '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Listing operationId: createListing description: Create Listing API publishes information on online listing sources. We post presence information on more than 50+ online directories. You can use this API to not just create your detailed listing but also fix/ publish/ sync/ make live at the same time. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createListing_Request" "/v1/listing/{businessNumber}/update": put: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2296Model" x-apiary-response-models: - "$ref": "#/components/schemas/2296Model" - "$ref": "#/components/schemas/2297Model" - "$ref": "#/components/schemas/2290Model" - "$ref": "#/components/schemas/3334Model" - "$ref": "#/components/schemas/3335Model" - "$ref": "#/components/schemas/3336Model" - "$ref": "#/components/schemas/3337Model" - "$ref": "#/components/schemas/3348Model" - "$ref": "#/components/schemas/2511Model" - "$ref": "#/components/schemas/2512Model" - "$ref": "#/components/schemas/2513Model" - "$ref": "#/components/schemas/2514Model" - "$ref": "#/components/schemas/2515Model" - "$ref": "#/components/schemas/2516Model" - "$ref": "#/components/schemas/2517Model" - "$ref": "#/components/schemas/2518Model" - "$ref": "#/components/schemas/2519Model" - "$ref": "#/components/schemas/2520Model" - "$ref": "#/components/schemas/2521Model" - "$ref": "#/components/schemas/2522Model" - "$ref": "#/components/schemas/6000Model" - "$ref": "#/components/schemas/6001Model" x-apiary-response-examples: error_2296: value: code: 2296 message: Invalid Food Delivery link error_2297: value: code: 2297 message: Invalid Food Takeout link error_2290: value: code: 2290 message: Food Takeout/Food Delivery not supported for gmb primary category error_3334: value: code: 2503 message: Primary category can not be included in additional category. error_3335: value: code: 2276 message: Please add upto 9 GBP additional categories only. error_3336: value: code: 2277 message: Duplicate GBP categories are not allowed. error_3337: value: code: 2278 message: Primary GBP category is not allowed in additional GBP categories. error_3348: value: code: 2162 message: Reopen date should not be less than current date. error_2511: value: code: 2511 message: Cannot update business status when listing is already fixed. error_2512: value: code: 2512 message: Cannot update opening soon date when listing is already fixed. error_2513: value: code: 2513 message: Opened On date can not be in future. error_2514: value: code: 2514 message: Opening Soon date is mandatory when business is marked as Opening soon. error_2515: value: code: 2515 message: Reopen date is not supported for this date. error_2516: value: code: 2516 message: Opening Soon Date can not be more than 1 year from now. error_2517: value: code: 2517 message: Opening Soon date should not be less than current date. error_2518: value: code: 2518 message: Business Status is mandatory to pass with reopen, opened on and opening soon date. error_2519: value: code: 2519 message: Third party categories change for opening soon business is not allowed. error_2520: value: code: 2520 message: Open Date is not supported for this date error_2521: value: code: 2285 message: Invalid text message number error_2522: value: code: 2286 message: Invalid whatsapp business link error_6000: value: code: 6000 message: The 'sub_locality' field is mandatory for addresses in New Zealand. error_6001: value: code: 6001 message: The 'sub_locality' field cannot exceed 80 characters. examples: response: value: code: 2296 message: Invalid Food Delivery link '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Listing operationId: updateListing description: The Update Listing API will update the location details on all your listings sites. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateListing_Request" "/v1/listing/{businessNumber}/get": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getListing_Response200" examples: response: value: businessInfo: name: Dieci Lifestyle Spa phone: "(973) 716-0007" websiteUrl: http://www.diecispa.org/ emailId: example@birdeye.com isAddressHidden: 'No' isServiceAreaProvider: 'No' mainBusinessDescription: A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos serviceAreas: - description: Van An, Berryessa Road, San Jose, CA, USA - description: Santa Clara, CA, USA location: address1: 90 W Mount Pleasant Ave address2: "(btwn Preston Dr. & N. Mitchell Ave.)" subLocality: Auckland CBD city: Livingston state: NJ zip: '07039' countryCode: US additionalInfo: establishedYear: '2022' timezone: America/Los_Angeles languages: - English - Hindi moreHours: Dinner: - day: 0 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 1 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 2 isOpen: 1 workingHours: - startHour: 32400 endHour: '20:10' - day: 3 isOpen: 1 workingHours: - startHour: 32400 endHour: '11:30' - day: 4 isOpen: 1 workingHours: - startHour: '9:00' endHour: '11:30' - day: 5 isOpen: 1 workingHours: - startHour: 32400 endHour: '11:30' - day: 6 isOpen: 1 workingHours: - startHour: 0 endHour: '20:30' Delivery: - day: 0 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 1 isOpen: 1 workingHours: - startHour: '7:00' endHour: 34200 - day: 2 isOpen: 1 workingHours: - startHour: 7200 endHour: 34200 - day: 3 isOpen: 1 workingHours: - startHour: 0 endHour: '11:30' - day: 4 isOpen: 1 workingHours: - startHour: 0 endHour: '11:30' - day: 5 isOpen: 1 workingHours: - startHour: 0 endHour: '11:30' - day: 6 isOpen: 1 workingHours: - startHour: '1:00' endHour: '1:00' appleMoreHours: Dining Hours: - day: 0 isOpen: 1 workingHours: - startHour: '10:00' endHour: '16:00' - day: 1 isOpen: 1 workingHours: - startHour: '10:00' endHour: '16:00' - day: 2 isOpen: 1 workingHours: - startHour: '10:00' endHour: '16:00' - day: 3 isOpen: 1 workingHours: - startHour: '10:00' endHour: '16:00' - day: 4 isOpen: 1 workingHours: - startHour: '10:00' endHour: '16:00' - day: 5 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 6 isOpen: 0 workingHours: - startHour: '' endHour: '' wholeWeekOperating: 0 hoursOfOperations: - day: 0 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' - day: 1 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' - day: 2 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' - day: 3 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' - day: 4 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' - day: 5 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '19:00' - day: 6 isOpen: 1 workingHours: - startHour: 32400 endHour: '13:30' - startHour: '14:30' endHour: '18:00' specialHours: - specialDate: 12/31/2020 startHour: 32400 endHour: '12:00' isOpen: 0 - specialDate: 01/01/2021 startHour: '' endHour: '' isOpen: 1 businessStatus: Open reopenDate: 01/01/2021 keywords: HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists services: BeautySalon,HairSpa products: LivingProofDryShampoo,KevinMurphyBlondeAngelWash appointmentLink: http://www.gmail.com reservationLink: http://www.gmail.com menuLink: http://www.gmail.com orderAheadLink: http://www.gmail.com impressum: Thisissampleimpressum paymentTypes: - China Union Pay - Bitcoin - Cash Accepted - MasterCard - PayPal - Check / Cheque - Contactless Payment - Debit Card - Diners Club - JCB - Financing - Visa - American Express - Cash Only - Rupay - Credit Card - Discover additionalPaymentTypes: Visa,MasterCard,AmericanExpress,DebitCards,Check localPhoneNumber: "(973)716-0102" tollFreePhoneNumber: '' iosAppURL: http://www.gmail.com androidAppURL: http://www.gmail.com media: logoUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png coverImageUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg gmbCover: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg facebookCover: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg optOut: gmbCoverOptOut: true gmbLogoOptOut: true fbCoverOptOut: false fbLogoOptOut: false gmbProfileOptOut: false businessProfileOptOut: false covidInfo: postDescription: SampleCovidDesc covid19SupportLink: http://www.covidInfo.com virtualCareLink: http://www.covidInfo.com bingListing: primaryCategoryBing: Art Restoration Service bingDescription: Sample Bing Description bingCategories: - Art Restoration Service bingPhoneNumber: "(415) 673-0868" internalListing: description: ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic category: Beauty subCategories: - Eyelash Service - Nail Salons displayCategory: Eyelash Service facebookListing: facebookDescription: This is sample facebook description facebookPhoneNumber: "(415) 673-0868" categories: - Science - Sports thirdPartyListing: thirdPartyCategory: Towing Service thirdPartySubCategories: - Car Dealer - Auto Glass Shop gmbListing: googleWebsiteUrl: http://www.gmail.com googleStoreId: '1232133' googlePhoneNumber: "(973) 716-0007" primaryCategoryGmb: Fast Food Restaurant googleDescription: This is sample description for google additionalCategories: - Snack bar attributes: Accessibility: - attributeId: has_wheelchair_accessible_elevator attributeName: Wheelchair accessible elevator value: false Crowd: - attributeId: welcomes_families attributeName: Family-friendly value: true hotelAttributes: business: business: meetingRoomsCount: attributeId: meetingRoomsCount attributeName: Number of meeting rooms value: 20 policies: policies: checkinTime: attributeId: checkinTime attributeName: Check-In Time value: "14:00" checkoutTime: attributeId: checkoutTime attributeName: Check-Out Time value: "11:00" property: property: builtYear: attributeId: builtYear attributeName: Built Year value: 2010 services: services: frontDesk: attributeId: frontDesk attributeName: Front desk value: true giftShop: attributeId: giftShop attributeName: Gift shop value: false languagesSpoken: attributeId: languagesSpoken attributeName: Languages Spoken value: English,Spanish,French foodDelivery: https://www.ubereats.com foodTakeout: https://www.ubereats.com whatsappBusinessLink: https://wa.me/9737160007 textMessageNumber: 973716-0007 appleListing: primaryCategory: health_care.dentistry.dental_clinic.dentist primaryCategoryName: Dentist appleWebsiteUrl: https://www.apple.com additionalCategories: - health_care.dentistry.dental_clinic.dentist.oral_surgeon additionalCategoriesNames: - Oral Surgeon appleLocationAttributes: crossbusiness.accessibility_features: - attributeId: accessible_elevator crossbusiness.family_kids: - attributeId: kidsclub - attributeId: parents_waitingarea appleActionLinks: - id: quicklinks.schedule_appointment deepLinkUrl: https://www.google.com appStoreUrl: https://apps.apple.com/your_apps_store_url phoneNumber: "+1 201-819-7989" appleBusinessName: This is sample business name appleBusinessDescription: This is sample business description socialProfileURLs: googleUrl: http://www.google.com/123 facebookUrl: http://www.facebook.com/123 twitterUrl: http://www.twitter.com/123 youTubeUrl: http://www.youtube.com/12 linkedinUrl: http://www.linkedin.com/12 instagramUrl: http://www.instagram.com/12 pintrestUrl: http://www.pinterest.com/12 bbbUrl: http://www.bbb.org/12 lendingtreeUrl: http://www.lendingtree.com/12 healthcare: doctorCategories: - Allergist-Immunologist > Allergy - Allergist-Immunologist > General - Addiction Medicine Specialist > General isProvider: true practiceName: General Medicine firstName: John middleName: Jack surName: Doe npi: '1245319599' credentials: MD university: Sample text hospitalAffiliations: Sample text insurancesAccepted: Sample text '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Listing operationId: getListing description: The Get Listing API will get the listing information for the given business number/ ID. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/{businessNumber}/more-hours-type": get: responses: '200': description: OK content: application/json: schema: type: array items: {} '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/4014Model" x-apiary-response-models: - "$ref": "#/components/schemas/4014Model" - "$ref": "#/components/schemas/4012Model" - "$ref": "#/components/schemas/4013Model" - "$ref": "#/components/schemas/4015Model" x-apiary-response-examples: error_4014: value: code: 400 message: Source name not found error_4012: value: code: 400 message: Country code not found error_4013: value: code: 400 message: Invalid country code error_4015: value: code: 400 message: Invalid Source Name examples: response: value: code: 400 message: Source name not found '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get More Hours Type operationId: getMoreHoursType description: Get supported more hours type for a location. This will depend on the country and gmb primary category for the particular location. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: channel in: query description: Source name for which more hours type needs to be fetched. Possible values are gmb, apple. Default value will be gmb if not passed required: true example: gmb schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string "/v1/listing/{businessNumber}/gmb/keywords": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getGoogleKeywordsCount_Response200" example: data: - label: Total frequency: 50909 - label: prom dresses near me frequency: 19156 - label: prom dresses frequency: 6168 - label: david's bridal prom dresses frequency: 3642 - label: davids bridal prom dresses frequency: 1005 - label: prom dresses nearby frequency: 825 totalKeywordCount: 734 '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2457Model" x-apiary-response-models: - "$ref": "#/components/schemas/2457Model" - "$ref": "#/components/schemas/2458Model" x-apiary-response-examples: error_2457: value: code: 2457 message: Invalid sortby value. Allowed values are 'frequency' or 'keyword' error_2458: value: code: 2458 message: Invalid order value. Allowed values are 'asc' or 'desc'. examples: response: value: code: 2457 message: Invalid sortby value. Allowed values are 'frequency' or 'keyword' '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Google Keywords Count operationId: getGoogleKeywordsCount description: |- Get’s Google keywords count for an account. Google keyword: Top keywords searched for which your business is ranked. tags: - Listing parameters: - name: businessNumber in: path description: Account Business Number. required: true example: '169744180007807' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. - Partner specific API key provided by Birdeye for data exchange. required: false example: "- Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: selectedMonth: type: array description: Filter months for which keyword data is required items: {} selectedkeywords: type: array description: 'Gives you keyword count for the selected keywords. keywordsSearch: To search by keywords that may also exist in search phrases, including the keyword itself.' items: {} keywordsSearch: type: string description: To search by keywords that may also exist in search phrases, including the keyword itself. limit: type: number description: Specify number of records to return. startIndex: type: number description: Index to start search from. Default value 0. sortby: type: string description: Possible values “frequency” or “keyword”. order: type: string description: Possible values “asc” or “desc”. businessNumbers: type: array description: list of the unique business ids associated with a business. items: {} required: - selectedMonth example: businessNumbers: - 147286063579104 - 147286063579108 selectedMonth: - Oct 2023 - Sep 2023 - Nov 2023 limit: 25 startIndex: 0 selectedkeywords: - prom sortby: frequency order: desc keywordsSearch: prom dresses example: businessNumbers: - 147286063579104 - 147286063579108 selectedMonth: - Oct 2023 - Sep 2023 - Nov 2023 limit: 25 startIndex: 0 selectedkeywords: - prom sortby: frequency order: desc keywordsSearch: prom dresses "/v1/listing/{businessNumber}/deactivate": post: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Deactivate Listing operationId: deactivateListing description: |- Deactivate Listing API stops publishing any information on the given online directories/ listings sites (as per your plan/ package chosen). > __Note__ > - If you want to reactivate posting to / update your listing sites after you have deactivated, you will need to use either of create Listings or Fix Listings API. tags: - Listing parameters: - name: businessNumber in: path description: Business Number. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json "/v1/listing/menu-details": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_retrieveMenuDetails_Response200" example: - id: abc123 businessNumber: 1210543123123 accountNumber: 1191304123 menuDetails: name: Restaurant Name error: menus: - cuisines: - Italian - Continental labels: - displayName: Main Menu description: Our signature dishes languageCode: en sections: - labels: - displayName: Appetizers description: Starters languageCode: en items: - labels: - displayName: Bruschetta description: Toasted bread with toppings languageCode: en attributes: price: currencyCode: USD units: 7 nanos: 500000000 allergen: - Gluten dietaryRestriction: - Vegetarian nutritionFacts: calories: 150 fatContent: 5g proteinContent: 3g carbohydrateContent: 20g ingredients: - name: Bread - name: Tomato servesNumPeople: 2 preparationMethods: - Grilled portionSize: amount: 150 unit: grams mediaKeys: [] options: - labels: - displayName: Extra Cheese description: languageCode: en attributes: price: currencyCode: USD units: 2 nanos: 0 businessNumber: 1210543 correlationId: xyz-456 createdAt: '2025-07-23T07:51:56.889Z' updatedAt: '2025-07-24T10:11:22.456Z' crmName: BirdeyeCRM '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2457Model" x-apiary-response-models: - "$ref": "#/components/schemas/2457Model" - "$ref": "#/components/schemas/2458Model" x-apiary-response-examples: error_2457: value: code: 2457 message: Invalid sortby value. Allowed values are 'frequency' or 'keyword' error_2458: value: code: 2458 message: Invalid order value. Allowed values are 'asc' or 'desc'. examples: response: value: code: 2457 message: Invalid sortby value. Allowed values are 'frequency' or 'keyword' '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Retrieve Menu Details operationId: retrieveMenuDetails description: This API retrieves structured menu information for specified business numbers. tags: - Listing parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber required: false example: "[Required] User associated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} example: businessNumbers: - 175009059995828 - 169028735563867 - 166609110899853 - 164873686901155 - 164863775654389 - 164847076003414 example: businessNumbers: - 175009059995828 - 169028735563867 - 166609110899853 - 164873686901155 - 164863775654389 - 164847076003414 "/v1/listing/get/hotel-attributes": get: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getHotelAttributes_Response200" example: hotelAttributes: services: services: frontDesk: attributeId: frontDesk attributeName: Front desk possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20001 attributeValueType: BOOLEAN twentyFourHourFrontDesk: attributeId: twentyFourHourFrontDesk attributeName: Twenty four hour front desk possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20002 attributeValueType: BOOLEAN giftShop: attributeId: giftShop attributeName: Gift shop possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20011 attributeValueType: BOOLEAN languagesSpoken: attributeId: languagesSpoken attributeName: Languages Spoken possibleValues: - value: Arabic name: Arabic - value: English name: English - value: French name: French - value: Spanish name: Spanish columnId: 20170 attributeValueType: MULTI_SELECT policies: policies: checkinTime: attributeId: checkinTime attributeName: Check-In Time possibleValues: [] columnId: 20173 attributeValueType: TIME checkoutTime: attributeId: checkoutTime attributeName: Check-Out Time possibleValues: [] columnId: 20174 attributeValueType: TIME parking: parking: parkingAvailable: attributeId: parkingAvailable attributeName: Parking available possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20097 attributeValueType: BOOLEAN freeParking: attributeId: freeParking attributeName: Free parking possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20098 attributeValueType: BOOLEAN business: business: meetingRooms: attributeId: meetingRooms attributeName: Meeting rooms possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20088 attributeValueType: BOOLEAN meetingRoomsCount: attributeId: meetingRoomsCount attributeName: Number of meeting rooms possibleValues: [] columnId: 20172 attributeValueType: INTEGER sustainability: energyEfficiency: energyConservationProgram: attributeId: energyConservationProgram attributeName: Energy conservation program possibleValues: - value: true name: Available - value: false name: Not Available columnId: 20134 attributeValueType: BOOLEAN property: property: builtYear: attributeId: builtYear attributeName: Built Year possibleValues: [] columnId: 20177 attributeValueType: YEAR lastRenovatedYear: attributeId: lastRenovatedYear attributeName: Last Renovated Year possibleValues: [] columnId: 20178 attributeValueType: YEAR roomsCount: attributeId: roomsCount attributeName: Rooms Count possibleValues: [] columnId: 20179 attributeValueType: INTEGER floorsCount: attributeId: floorsCount attributeName: Floors Count possibleValues: [] columnId: 20180 attributeValueType: INTEGER '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/2521Model" x-apiary-response-models: - "$ref": "#/components/schemas/2521Model" - "$ref": "#/components/schemas/2522Model" x-apiary-response-examples: error_2521: value: code: 2285 message: Invalid text message number error_2522: value: code: 2286 message: Invalid whatsapp business link examples: response: value: code: 2285 message: Invalid text message number '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Hotel Attributes operationId: getHotelAttributes description: The Get Hotel Attributes API fetches the list of applicable hotel attributes configured for the selected business. tags: - Listing parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] Business Number for which hotel attributes are to be fetched. required: false example: "[Required] Business Number for which hotel attributes are to be fetched." schema: type: string "/v1/listing/public/product/setup/googleMerchant": post: responses: '200': description: OK content: application/json: schema: type: object properties: code: type: number message: type: string example: code: 200 message: String '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Onboard Google Merchant Account operationId: onboardGoogleMerchantAccount description: Onboards/connects a Google Merchant account for products listing. tags: - GMB Products parameters: - name: merchantId in: query description: Google Merchant Center account ID. required: true example: '1234567' schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Fix_ListingBody" content: application/json: example: {} "/v1/listing/public/product": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_createProductListing_Response200" '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create Product Listing operationId: createProductListing description: Creates a product listing on the Google Merchant account linked to the Birdeye account. tags: - GMB Products parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createProductListing_Request" example: businessNumbers: - 145308764185002 - 145308769721320 title: Dental Implant description: The dental procedure for replacing missing teeth using implants. imageLink: https://example.com/images/dental-implant-main.jpg additionalImageLinks: - https://example.com/images/dental-implant-side.jpg - https://example.com/images/dental-implant-closeup.jpg brandName: SmileCare googleProductCategoryId: '123' price: amount: '1500.00' currencyCode: USD salePrice: amount: '1200.00' currencyCode: USD productSku: DENTAL-IMPLANT-001 productTypes: - Dental Services - Implants - Cosmetic Dentistry productUrl: https://example.com/products/dental-implant status: PUBLISH "/v1/listing/public/product/{productId}": put: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateProductListing_Response200" example: code: 2565 message: Product request validation failure data: errorAttributes: - type: title message: Product name is missing in the request '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update Product Listing operationId: updateProductListing description: Operations related to update a product listing. tags: - GMB Products parameters: - name: productId in: path description: Unique identifier of the product to update. required: true example: 68767cb39ebf51000815ab39 schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} title: type: string description: Product title. description: type: string imageLink: type: string description: Publicly accessible image URL. additionalImageLinks: type: array description: Additional public image URLs. items: {} brandName: type: string googleProductCategoryId: type: string description: Google product taxonomy ID. price: type: object properties: amount: type: string description: Decimal string. currencyCode: type: string description: ISO 4217 code. required: - amount - currencyCode salePrice: type: object properties: amount: type: string currencyCode: type: string required: - amount - currencyCode productTypes: type: array description: Product categorization keywords. items: {} productUrl: type: string description: implant (string, optional) status: type: string description: 'Accepted values: `PUBLISH`, `DRAFT`.' required: - title - imageLink - googleProductCategoryId - price - status example: businessNumbers: - 145308764185002 - 145308769721320 title: Dental Implant description: The dental procedure for replacing missing teeth using implants. imageLink: https://example.com/images/dental-implant-main.jpg additionalImageLinks: - https://example.com/images/dental-implant-side.jpg - https://example.com/images/dental-implant-closeup.jpg brandName: SmileCare googleProductCategoryId: '123' price: amount: '1500.00' currencyCode: USD salePrice: amount: '1200.00' currencyCode: USD productTypes: - Dental Services - Implants - Cosmetic Dentistry productUrl: https://example.com/products/dental-implant status: PUBLISH example: businessNumbers: - 145308764185002 - 145308769721320 title: Dental Implant description: The dental procedure for replacing missing teeth using implants. imageLink: https://example.com/images/dental-implant-main.jpg additionalImageLinks: - https://example.com/images/dental-implant-side.jpg - https://example.com/images/dental-implant-closeup.jpg brandName: SmileCare googleProductCategoryId: '123' price: amount: '1500.00' currencyCode: USD salePrice: amount: '1200.00' currencyCode: USD productTypes: - Dental Services - Implants - Cosmetic Dentistry productUrl: https://example.com/products/dental-implant status: PUBLISH "/v1/listing/public/product/{productIdentifier}": get: responses: '200': description: OK content: application/json: schema: type: object properties: productId: type: string productSku: type: string description: 3 (string) locationCount: type: number title: type: string description: type: string productUrl: type: string description: bragadiru.ro/preturi/ (string) imageLink: type: string additionalImageLinks: type: array items: {} videoUrl: type: string brandName: type: string googleProductCategoryId: type: string price: type: object properties: amount: type: string currencyCode: type: string productTypes: type: array items: {} salePrice: type: object properties: amount: type: string currencyCode: type: string status: type: string updatedOn: type: string description: Display value or timestamp depending on environment. updatedBy: type: string code: type: number description: Error code. Present on validation failure. message: type: string description: Error message. Present on validation failure. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Product Listing operationId: getProductListing description: Operations related to get a product listing. tags: - GMB Products parameters: - name: productIdentifier in: path description: Product identifier. required: true example: 68767cb39ebf51000815ab39 schema: type: string - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string "/v1/listing/public/product/deleteProduct": post: responses: '200': description: OK content: application/json: schema: type: object properties: code: type: number description: Error code. Present on validation failure. message: type: string description: Error message. Present on validation failure. example: code: 2561 message: Products are not found with given criteria '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Delete Product Listings operationId: deleteProductListings description: Deletes products from Google Merchant Center and Birdeye for the provided product IDs. tags: - GMB Products parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: productIds: type: array description: IDs to delete. items: {} required: - productIds example: productIds: - 68767cb39ebf51000815ab39 - 68767cb39ebf51000815ab39 example: productIds: - 68767cb39ebf51000815ab39 - 68767cb39ebf51000815ab39 "/v1/listing/public/product/getList": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getListProductListing_Response200" example: response: - productId: 689af8f4f198dfbdfc88f05c productSku: '7654749435' locationCount: 2 title: Family Dental Plan description: Use this product to purchase the family dental plan for 3 visits/year for a family of 4 productUrl: https://dentist-bragadiru.ro/preturi/ imageLink: https://shopping.googleusercontent.com/image?q=AJqGhtVeXk2QAlVze5sxdIkrJqvnVzU_ApEvuPtiqXtE5slPUnd8ev_mctvrSvvwkcw6EYPn-6JoCfGyi1yp additionalImageLinks: - https://shopping.googleusercontent.com/image?q=AJqGhtWrkvUc_hlewjdruW0_pE94O2KroiTvT9Iyvoq8rEo31Tdn0v4FYhxTsUbt2I-lu2Y2-8JVBA8P2flC videoUrl: '' brandName: SDR Clinic googleProductCategoryId: '5823' price: amount: '3500000000' currencyCode: INR productTypes: - FamilyDentalHelath salePrice: amount: '2500000000' currencyCode: INR status: PUBLISH updatedOn: 1754993514625 updatedBy: XYZ totalCount: 100 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get List Product Listing operationId: getListProductListing description: Returns paginated product listings for the account/locations based on search and filters. tags: - GMB Products parameters: - name: pageSize in: query description: Number of records per page. Default 50. required: false example: '50' schema: type: number - name: pageNumber in: query description: 0-based page index. Default 0. required: false example: '0' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: search: type: string description: Regex/contains on title. status: type: array description: Filter by status. items: {} businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} example: search: Dental status: - DRAFT - PUBLISH businessNumbers: [] example: search: Dental status: - DRAFT - PUBLISH businessNumbers: [] "/v1/listing/public/product/addProduct": post: responses: '200': description: OK content: application/json: schema: type: object properties: code: type: number message: type: string example: code: 2564 message: Product not or Partial found with given productId List '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Add Products On a Location operationId: addProductsOnALocation description: Adds products (by IDs) to the Google profile of the business provided in headers. tags: - GMB Products parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Add_Products_On_a_LocationBody" content: application/json: example: productIds: - 68767cb39ebf51000815ab39 - 68767cb39ebf51000815ab39 "/v1/listing/public/product/removeProduct": post: responses: '200': description: OK content: application/json: schema: type: object properties: code: type: number message: type: string example: code: 2564 message: Product not or Partial found with given productId List '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1011Model" examples: response: value: code: 1011 message: Business id is invalid '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Remove Products On a Location operationId: removeProductsOnALocation description: Removes products (by IDs) to the Google profile of the business provided in headers. tags: - GMB Products parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User assosiated businessNumber required: false example: "[Required] User assosiated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Add_Products_On_a_LocationBody" content: application/json: example: productIds: - 68767cb39ebf51000815ab39 - 68767cb39ebf51000815ab39 "/v1/listing/searchAi/public/account-setup": get: responses: '200': description: OK content: application/json: schema: type: object properties: frequency: type: string quota: type: number billingType: type: string themes: type: array items: type: object properties: theme: type: string prompts: type: array items: type: string required: - theme - prompts example: frequency: Monthly quota: 1200 billingType: CREDIT_SYSTEM themes: - theme: dental implants prompts: - Find dental clinics near me that specialize in affordable dental implants and offer consultations. - Search for providers offering full mouth dental implants or All-on-4 solutions in my area. - Locate dental offices that provide transparent pricing for dental implants and flexible financing options. - theme: teeth whitening prompts: - Find dental clinics near me offering professional teeth whitening services. - Who provides the best in-office teeth whitening treatments in my area? - Local dentists with advanced teeth whitening options and kits for purchase. - theme: dental crowns prompts: - Find dental clinics near me that specialize in dental crown procedures. - Where can I get affordable zirconia dental crowns from reputable dentists? - Locate dental offices offering same-day dental crown services and consultations. - theme: tooth extractions prompts: - Find dental clinics near me that offer professional tooth extraction services, including same-day tooth extraction and implant placement. - Search for dentists specializing in wisdom tooth extraction and post-extraction care in my area. - Locate private dental practices offering affordable tooth extraction with transparent pricing and quick appointments. - theme: dental bridges prompts: - Find dental clinics near me that offer dental bridges and provide detailed pricing information. - Looking for experienced dentists specializing in dental bridge procedures and consultations. - Best dental practices for dental bridge installation and aftercare services in my area. examples: response: value: frequency: Monthly quota: 1200 billingType: CREDIT_SYSTEM themes: - theme: dental implants prompts: - Find dental clinics near me that specialize in affordable dental implants and offer consultations. - Search for providers offering full mouth dental implants or All-on-4 solutions in my area. - Locate dental offices that provide transparent pricing for dental implants and flexible financing options. - theme: teeth whitening prompts: - Find dental clinics near me offering professional teeth whitening services. - Who provides the best in-office teeth whitening treatments in my area? - Local dentists with advanced teeth whitening options and kits for purchase. - theme: dental crowns prompts: - Find dental clinics near me that specialize in dental crown procedures. - Where can I get affordable zirconia dental crowns from reputable dentists? - Locate dental offices offering same-day dental crown services and consultations. - theme: tooth extractions prompts: - Find dental clinics near me that offer professional tooth extraction services, including same-day tooth extraction and implant placement. - Search for dentists specializing in wisdom tooth extraction and post-extraction care in my area. - Locate private dental practices offering affordable tooth extraction with transparent pricing and quick appointments. - theme: dental bridges prompts: - Find dental clinics near me that offer dental bridges and provide detailed pricing information. - Looking for experienced dentists specializing in dental bridge procedures and consultations. - Best dental practices for dental bridge installation and aftercare services in my area. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Search AI Configuration operationId: getSearchAiConfiguration description: Retrieves the Search AI configuration for the specified business. tags: - Search AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string "/v1/listing/searchAi/public/available-runs": get: responses: '200': description: OK content: application/json: schema: type: object properties: availableRuns: type: array items: type: object properties: runDate: type: string themes: type: array items: type: string required: - runDate - themes example: availableRuns: - runDate: 15-MAR-2026 themes: - dental implants - runDate: 14-MAR-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 13-MAR-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 13-FEB-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 13-JAN-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 30-DEC-2025 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 18-NOV-2025 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions examples: response: value: availableRuns: - runDate: 15-MAR-2026 themes: - dental implants - runDate: 14-MAR-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 13-MAR-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 13-FEB-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 13-JAN-2026 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 30-DEC-2025 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions - runDate: 18-NOV-2025 themes: - dental implants - teeth whitening - dental bridges - dental crowns - tooth extractions '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Search AI Available Runs operationId: getSearchAiAvailableRuns description: Retrieves the Search AI available runs for the specified business. tags: - Search AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber required: false example: "[Required] User associated businessNumber" schema: type: string "/v1/listing/searchAi/public/citations": post: responses: '200': description: OK content: application/json: schema: type: object properties: citations: type: array items: type: object properties: theme: type: string prompt: type: string aiModel: type: string businessNumber: type: number processedDate: type: string citations: type: array items: type: object properties: url: type: string title: type: string description: type: string brandPresent: type: boolean required: - url - title - description - brandPresent required: - theme - prompt - aiModel - businessNumber - processedDate - citations total: type: number example: citations: - theme: Dental implants prompt: Best dental implants near me aiModel: CHATGPT businessNumber: 67348934989 processedDate: 10-Mar-2026 citations: - url: https://www.healthline.com/health/dental-and-oral-health/dental-implants title: 'Dental Implants: Procedure, Benefits, and Risks' description: A complete guide to dental implants including procedure, cost, and recovery. brandPresent: false - url: https://www.exampleclinic.com/dental-implants title: Affordable Dental Implants at Example Clinic description: Get high-quality dental implants with experienced dentists. brandPresent: true - theme: Dental implants prompt: Cost of dental implants in India aiModel: GEMINI businessNumber: 327349434334 processedDate: 15-Mar-2026 citations: - url: https://www.practo.com/healthfeed/dental-implant-cost-in-india-45910/post title: Dental Implant Cost in India description: Overview of dental implant pricing across major cities in India. brandPresent: false - url: https://www.dentalcareplus.in/implants title: Advanced Dental Implant Solutions description: State-of-the-art dental implant services with modern technology. brandPresent: true - theme: Dental implants prompt: Are dental implants safe? aiModel: CHATGPT businessNumber: 278237892323 processedDate: 20-Mar-2026 citations: - url: https://www.webmd.com/oral-health/guide/dental-implants title: 'Dental Implants: What You Should Know' description: Learn about the safety, benefits, and risks of dental implants. brandPresent: false total: 3 examples: response: value: citations: - theme: Dental implants prompt: Best dental implants near me aiModel: CHATGPT businessNumber: 67348934989 processedDate: 10-Mar-2026 citations: - url: https://www.healthline.com/health/dental-and-oral-health/dental-implants title: 'Dental Implants: Procedure, Benefits, and Risks' description: A complete guide to dental implants including procedure, cost, and recovery. brandPresent: false - url: https://www.exampleclinic.com/dental-implants title: Affordable Dental Implants at Example Clinic description: Get high-quality dental implants with experienced dentists. brandPresent: true - theme: Dental implants prompt: Cost of dental implants in India aiModel: GEMINI businessNumber: 327349434334 processedDate: 15-Mar-2026 citations: - url: https://www.practo.com/healthfeed/dental-implant-cost-in-india-45910/post title: Dental Implant Cost in India description: Overview of dental implant pricing across major cities in India. brandPresent: false - url: https://www.dentalcareplus.in/implants title: Advanced Dental Implant Solutions description: State-of-the-art dental implant services with modern technology. brandPresent: true - theme: Dental implants prompt: Are dental implants safe? aiModel: CHATGPT businessNumber: 278237892323 processedDate: 20-Mar-2026 citations: - url: https://www.webmd.com/oral-health/guide/dental-implants title: 'Dental Implants: What You Should Know' description: Learn about the safety, benefits, and risks of dental implants. brandPresent: false total: 3 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Search AI Citations operationId: getSearchAiCitations description: Retrieves Search AI citations for the specified business, including sources referenced by AI models for given prompts and themes. tags: - Search AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Get_Search_AI_CitationsBody" "/v1/listing/searchAi/public/business": post: responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object properties: theme: type: string prompt: type: string aiModel: type: string businessNumber: type: number processedDate: type: string businesses: type: array items: type: object properties: name: type: string phone: type: string postalCode: type: string address: type: string city: type: string websiteUrl: type: string required: - name - phone - postalCode - address - city - websiteUrl required: - theme - prompt - aiModel - businessNumber - processedDate - businesses total: type: number example: data: - theme: Dental implants prompt: Best dental implant clinics near me aiModel: CHATGPT businessNumber: 67348934989 processedDate: 13-Mar-2026 businesses: - name: SmileCare Dental Clinic phone: "+91-9876543210" postalCode: '700091' address: Salt Lake Sector V, Bidhannagar city: Kolkata websiteUrl: https://www.smilecaredental.in - name: Apollo Dental Clinic phone: "+91-9831123456" postalCode: '700020' address: Park Street, Near Metro Station city: Kolkata websiteUrl: https://www.apollodentalclinics.com - theme: Dental implants prompt: Affordable dental implants in India aiModel: GEMINI businessNumber: 327349434334 processedDate: 23-Mar-2026 businesses: - name: Clove Dental phone: "+91-9999030303" postalCode: '110001' address: Connaught Place, Block A city: New Delhi websiteUrl: https://www.clovedental.in - name: 32 Smile Dental Clinic phone: "+91-9823456789" postalCode: '411001' address: MG Road, Camp Area city: Pune websiteUrl: https://www.32smile.in - theme: Dental implants prompt: Top rated dental implant specialists aiModel: CHATGPT businessNumber: 278237892323 processedDate: 25-Mar-2026 businesses: - name: Axiss Dental Clinic phone: "+91-9619944444" postalCode: '400050' address: Linking Road, Bandra West city: Mumbai websiteUrl: https://www.axissdental.com total: 3 examples: response: value: data: - theme: Dental implants prompt: Best dental implant clinics near me aiModel: CHATGPT businessNumber: 67348934989 processedDate: 13-Mar-2026 businesses: - name: SmileCare Dental Clinic phone: "+91-9876543210" postalCode: '700091' address: Salt Lake Sector V, Bidhannagar city: Kolkata websiteUrl: https://www.smilecaredental.in - name: Apollo Dental Clinic phone: "+91-9831123456" postalCode: '700020' address: Park Street, Near Metro Station city: Kolkata websiteUrl: https://www.apollodentalclinics.com - theme: Dental implants prompt: Affordable dental implants in India aiModel: GEMINI businessNumber: 327349434334 processedDate: 23-Mar-2026 businesses: - name: Clove Dental phone: "+91-9999030303" postalCode: '110001' address: Connaught Place, Block A city: New Delhi websiteUrl: https://www.clovedental.in - name: 32 Smile Dental Clinic phone: "+91-9823456789" postalCode: '411001' address: MG Road, Camp Area city: Pune websiteUrl: https://www.32smile.in - theme: Dental implants prompt: Top rated dental implant specialists aiModel: CHATGPT businessNumber: 278237892323 processedDate: 25-Mar-2026 businesses: - name: Axiss Dental Clinic phone: "+91-9619944444" postalCode: '400050' address: Linking Road, Bandra West city: Mumbai websiteUrl: https://www.axissdental.com total: 3 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Search AI Businesses operationId: getSearchAiBusinesses description: Retrieves Search AI business results for the specified business, including businesses identified by AI models for given prompts and themes. tags: - Search AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber required: false example: "[Required] User associated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: "$ref": "#/components/requestBodies/Get_Search_AI_CitationsBody" "/v1/listing/searchAi/public/aio-details?page-size=100&start-index=0": post: responses: '200': description: OK content: application/json: schema: type: object properties: total: type: number hasNext: type: boolean data: type: object properties: '177337970010644': type: object properties: '2025-12-30': type: object properties: CHATGPT: type: object properties: businessName: type: string fullAddress: type: string phone: type: string hoursOfOperation: type: string website: type: string GEMINI: type: object properties: businessName: type: string fullAddress: type: string phone: type: string hoursOfOperation: type: string PERPLEXITY: type: object properties: businessName: type: string fullAddress: type: string phone: type: string hoursOfOperation: type: string website: type: string example: total: 4 hasNext: false data: '177337970010644': '2025-12-30': CHATGPT: businessName: ProHEALTH Dental - Astoria fullAddress: 29-14 Ditmars Blvd, Astoria, NY 11105, United States phone: "(718) 524-3677" hoursOfOperation: |- Monday: Closed Tuesday: Closed Wednesday: Closed Thursday: Closed Friday: Closed Saturday: Closed Sunday: Closed website: phdental.com GEMINI: businessName: ProHEALTH Dental - Astoria fullAddress: 29-14 Ditmars Blvd, Astoria, NY 11105, United States phone: 718-524-3677 hoursOfOperation: |- Monday: Closed Tuesday: Closed Wednesday: Closed Thursday: Closed Friday: Closed Saturday: Closed Sunday: Closed PERPLEXITY: businessName: ProHEALTH Dental - Astoria fullAddress: 29-14 Ditmars Blvd, Astoria, NY 11105, United States phone: 718-524-3677 hoursOfOperation: |- Monday: Closed Tuesday: Closed Wednesday: Closed Thursday: Closed Friday: Closed Saturday: Closed Sunday: Closed website: https://www.phdental.com/locations/prohealth-dental/astoria-ny/ examples: response: value: total: 4 hasNext: false data: '177337970010644': '2025-12-30': CHATGPT: businessName: ProHEALTH Dental - Astoria fullAddress: 29-14 Ditmars Blvd, Astoria, NY 11105, United States phone: "(718) 524-3677" hoursOfOperation: |- Monday: Closed Tuesday: Closed Wednesday: Closed Thursday: Closed Friday: Closed Saturday: Closed Sunday: Closed website: phdental.com GEMINI: businessName: ProHEALTH Dental - Astoria fullAddress: 29-14 Ditmars Blvd, Astoria, NY 11105, United States phone: 718-524-3677 hoursOfOperation: |- Monday: Closed Tuesday: Closed Wednesday: Closed Thursday: Closed Friday: Closed Saturday: Closed Sunday: Closed PERPLEXITY: businessName: ProHEALTH Dental - Astoria fullAddress: 29-14 Ditmars Blvd, Astoria, NY 11105, United States phone: 718-524-3677 hoursOfOperation: |- Monday: Closed Tuesday: Closed Wednesday: Closed Thursday: Closed Friday: Closed Saturday: Closed Sunday: Closed website: https://www.phdental.com/locations/prohealth-dental/astoria-ny/ '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Accuracy Report operationId: getAccuracyReport description: Provides an accuracy report for the specified business, highlighting how consistent and reliable the business information is across platforms. tags: - Search AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. - Long Business Number required: false example: "- Long Business Number" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAccuracyReport_Request" "/v1/listing/searchAi/public/swot-details?page-size=100&start-index=0": post: responses: '200': description: OK content: application/json: schema: type: object properties: total: type: number hasNext: type: boolean data: type: object properties: '177337970010644': type: object properties: '2026-03-17': type: object properties: PERPLEXITY: type: object properties: strengths: type: array items: type: object properties: title: type: string description: type: string required: - title - description weaknesses: type: array items: type: object properties: title: type: string description: type: string required: - title - description oppurtunities: type: array items: type: object properties: title: type: string description: type: string required: - title - description threats: type: array items: type: object properties: title: type: string description: type: string required: - title - description CHATGPT: type: object properties: strengths: type: array items: type: object properties: title: type: string description: type: string required: - title - description weaknesses: type: array items: type: object properties: title: type: string description: type: string required: - title - description oppurtunities: type: array items: type: object properties: title: type: string description: type: string required: - title - description threats: type: array items: type: object properties: title: type: string description: type: string required: - title - description example: total: 4 hasNext: false data: '177337970010644': '2026-03-17': PERPLEXITY: strengths: - title: Affiliation with Reputable Network description: Part of Sutter Health, bringing award-winning care to Solvang neighborhood with established oncology and infusion services. - title: Convenient Extended Hours description: Open Monday through Thursday until 6 PM, accommodating local working professionals in the Viborg Specialty Building. - title: Positive Patient Experiences description: Local customers highlight excellent professional care, compelling first-time reviews for the facility. weaknesses: - title: Limited Operating Days description: Closed Fridays, Saturdays, Sundays, and major holidays, reducing accessibility for Solvang residents needing weekend care. - title: Lunchtime Closure description: Daily closure from 12-1 PM restricts same-day urgent infusion or oncology visits during peak hours. - title: Sparse Specific Feedback description: Few reviews directly address infusion services, with most feedback general to the care center. oppurtunities: - title: Proximity to Diagnostics description: Co-located with Quest Diagnostics in the same building, enabling seamless lab integration for Solvang patients. - title: Cancer Care Demand description: Ridley-Tree Cancer Center presence supports expanding infusion services amid local oncology needs. - title: Tourist Community Growth description: Solvang's popularity as a tourist destination offers potential to serve seasonal visitors requiring infusion therapy. threats: - title: Competitor Overlap description: Nearby Sansum Clinic departments at the same address create internal competition for specialized care. - title: Seasonal Traffic Fluctuations description: Solvang's heavy tourist traffic on Viborg Road may cause access issues during peak events. - title: Regional Healthcare Shifts description: Potential changes in Sutter Health or local regulations could impact infusion center operations. CHATGPT: strengths: - title: Highly qualified staff description: Patients appreciate the knowledgeable and friendly staff who provide exceptional care. - title: Collaborations with local healthcare description: Strong ties with local healthcare providers increase trust and referral rates. - title: Convenient location description: Located conveniently for residents, with easy access from different parts of the neighborhood. weaknesses: - title: Limited parking space description: Some patients report challenges in finding parking during peak hours. - title: Wait times during peak hours description: Occasional increased wait times have been noted, particularly during busy periods. - title: Restricted operating hours description: Operating hours may not accommodate everyone, especially those needing evening appointments. oppurtunities: - title: Expansion of services description: Potential to add more services to cater to a broader range of infusion needs. - title: Partnership with more local clinics description: Building more partnerships could further solidify its local presence and patient base. - title: Community outreach programs description: Engaging in more community health events could raise awareness and attract new patients. threats: - title: Increased competition description: Emerging local clinics could present competition, potentially affecting market share. - title: Economic fluctuations description: Local and national economic changes could affect healthcare funding and patient affordability. - title: Regulatory changes description: Potential regulatory changes in healthcare practices could impact operations and compliance. examples: response: value: total: 4 hasNext: false data: '177337970010644': '2026-03-17': PERPLEXITY: strengths: - title: Affiliation with Reputable Network description: Part of Sutter Health, bringing award-winning care to Solvang neighborhood with established oncology and infusion services. - title: Convenient Extended Hours description: Open Monday through Thursday until 6 PM, accommodating local working professionals in the Viborg Specialty Building. - title: Positive Patient Experiences description: Local customers highlight excellent professional care, compelling first-time reviews for the facility. weaknesses: - title: Limited Operating Days description: Closed Fridays, Saturdays, Sundays, and major holidays, reducing accessibility for Solvang residents needing weekend care. - title: Lunchtime Closure description: Daily closure from 12-1 PM restricts same-day urgent infusion or oncology visits during peak hours. - title: Sparse Specific Feedback description: Few reviews directly address infusion services, with most feedback general to the care center. oppurtunities: - title: Proximity to Diagnostics description: Co-located with Quest Diagnostics in the same building, enabling seamless lab integration for Solvang patients. - title: Cancer Care Demand description: Ridley-Tree Cancer Center presence supports expanding infusion services amid local oncology needs. - title: Tourist Community Growth description: Solvang's popularity as a tourist destination offers potential to serve seasonal visitors requiring infusion therapy. threats: - title: Competitor Overlap description: Nearby Sansum Clinic departments at the same address create internal competition for specialized care. - title: Seasonal Traffic Fluctuations description: Solvang's heavy tourist traffic on Viborg Road may cause access issues during peak events. - title: Regional Healthcare Shifts description: Potential changes in Sutter Health or local regulations could impact infusion center operations. CHATGPT: strengths: - title: Highly qualified staff description: Patients appreciate the knowledgeable and friendly staff who provide exceptional care. - title: Collaborations with local healthcare description: Strong ties with local healthcare providers increase trust and referral rates. - title: Convenient location description: Located conveniently for residents, with easy access from different parts of the neighborhood. weaknesses: - title: Limited parking space description: Some patients report challenges in finding parking during peak hours. - title: Wait times during peak hours description: Occasional increased wait times have been noted, particularly during busy periods. - title: Restricted operating hours description: Operating hours may not accommodate everyone, especially those needing evening appointments. oppurtunities: - title: Expansion of services description: Potential to add more services to cater to a broader range of infusion needs. - title: Partnership with more local clinics description: Building more partnerships could further solidify its local presence and patient base. - title: Community outreach programs description: Engaging in more community health events could raise awareness and attract new patients. threats: - title: Increased competition description: Emerging local clinics could present competition, potentially affecting market share. - title: Economic fluctuations description: Local and national economic changes could affect healthcare funding and patient affordability. - title: Regulatory changes description: Potential regulatory changes in healthcare practices could impact operations and compliance. '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" examples: response: value: code: 1161 message: Invalid API key '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get Sentiment Report operationId: getSentimentReport description: Returns the sentiment report for the specified business, providing insights into customer sentiment across supported platforms. tags: - Search AI parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: x-business-number in: header description: e.g. [Required] User associated businessNumber required: false example: "[Required] User associated businessNumber" schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getSentimentReport_Request" "/v1/ticket/{businessNumber}/create-ticket": put: responses: '200': description: OK content: application/json: schema: type: object properties: ticketId: type: number example: 882382 description: Id of the new ticket created. example: ticketId: 882382 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Create ticket operationId: createTicket description: Create reviews, untagged, and survey responses tickets. tags: - Ticketing parameters: - name: businessNumber in: path description: Business number of the location on which we want to create a ticket. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_createTicket_Request" example: externalId: 3943351204239963055 assignedTo: pranav.singh@birdeye.com ticketType: review customer: emailId: test+4@yopmail.com firstName: Steve lastName: Smith location: city: Dallas state: Texas phone: '' description: Issue with the Store service sourceType: internal "/v1/ticket/{businessNumber}/comment-activity": post: responses: '200': description: OK content: application/json: schema: type: object properties: ticketId: type: number example: 882382 description: Id of the new ticket created. example: ticketId: 882382 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Add Ticket Comments operationId: addTicketComments description: Add comment activity on tickets. tags: - Ticketing parameters: - name: businessNumber in: path description: Business number of the location. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: comment: type: string description: Comment to be added on ticket. ticketId: type: number description: Id of the ticket. userEmail: type: string description: EmailId of the user who is adding the comment. required: - comment - ticketId - userEmail example: comment: Had a chat with customer, he will visit again. ticketId: '886172' userEmail: steve@ymail.com example: comment: Had a chat with customer, he will visit again. ticketId: '886172' userEmail: steve@ymail.com "/v1/ticket/{businessNumber}/update": put: responses: '200': description: OK '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Update ticket operationId: updateTicket description: Update the ticket status or ticket assignee. tags: - Ticketing parameters: - name: businessNumber in: path description: Business number of the location. required: true example: '169744180007807' schema: type: number - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_updateTicket_Request" example: ticketUpdateMessages: - assignedTo: steve@ymail.com ticketId: '882382' ticketStatus: assigned userEmail: pranav.singh@birdeye.com "/v1/ticket/{businessNumber}/get/all?": post: responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllTicketData_Response200" example: ticketDetails: - id: 188556 status: assigned rating: 5.0 externalId: 2131605005145285326 date: '2020-02-14 00:08:00' postedOn: '2020-02-08 00:00:00' updateDate: '2020-08-11 00:00:00' created: '2020-02-14 12:08:02' description: Room was outstanding....location was also good.... activityCount: 4 assignedTo: firstName: Atul lastName: Ghainna emailId: atulkumar.ghainna@birdeye.com name: Atul Ghainna business: name: JYSK - Whitby alias: JYSK - Whitby number: 157851547625021 phone: "(905) 451-9054" source: name: Airbnb ticketType: review tags: - awesome - it was good - newtest - promoters!!! - great service - time - poor - Enjoy - newtag - test - check - good review - excellent - Dirty Car - User request no response - customer service - nice reporter: firstName: Megha lastName: '' - id: 192727 status: assigned date: '2020-02-18 00:34:00' updateDate: '2020-02-18 00:00:00' created: '2020-02-18 12:34:18' description: Apil look into it. activityCount: 2 assignedTo: firstName: April lastName: Dover emailId: aparna.dass@birdeye.com name: April Dover business: name: JYSK - Cambridge alias: JYSK - Cambridge number: 157721146574913 phone: "(905) 451-9054" source: name: phone ticketType: untagged reporter: firstName: Jerry lastName: Jacob emailId: jerry@jerry.com phone: '' - id: 199287 status: assigned date: '2020-02-27 01:28:00' postedOn: '2020-02-27 00:00:00' updateDate: '2020-10-29 00:00:00' created: '2020-02-27 01:28:14' description: |- Question: Please rate us based on your training experience Answer: 1 activityCount: 3 assignedTo: firstName: April lastName: Dover emailId: aparna.dass@birdeye.com name: April Dover business: name: JYSK - Whitby alias: JYSK - Whitby number: 157851547625021 phone: "(905) 451-9054" source: name: Training Feb 24th ticketType: survey surveyId: 15492 count: 0 totalcount: 3 '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Get All Ticket Data operationId: getAllTicketData description: Get tickets tags: - Ticketing parameters: - name: businessNumber in: path description: Business number of the account. required: true example: '169744180007807' schema: type: number - name: op in: query description: 'Possible values are: [1] will display ticket count only, [3] will display all the data of the ticket. Default value - 3.' required: true example: '3' schema: type: number - name: sIndex in: query description: Start index of the response. Default value - 0 required: true example: '0' schema: type: number - name: count in: query description: Number of tickets want to get in the response. Default value - 25 required: true example: '25' schema: type: number - name: sortBy in: query description: Sort options, Possible values [2] will sort on the basis of ticket creation date. [3] will sort on the basis of characters of business aliases. Default value 2. required: true example: '2' schema: type: number - name: sortOrder in: query description: Sort Order [0] will sort the data in ascending order. [1] this will sort the data in descending order. Default value - 1 required: true example: '1' schema: type: number - name: totalCount in: query description: false, total count would not be displayed. true, total count would be displayed along with the data of all the tickets. Default Value - false required: true example: true schema: type: boolean - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. required: false example: 2uiHKCTi8hSg35MG75aaot0B2SAokhjk (string, required) - Partner specific API key provided by Birdeye for data exchange. schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getAllTicketData_Request" example: assignees: [] businessNumbers: [] fromDate: 1581230064000 sourceAliases: - '' sourceTypes: - phone - socialmedia - chat - internal tagNames: - newReview ticketStatuses: - assigned - new ticketTypes: - review - survey - untagged toDate: 1707460464000 "/v1/integrations/add/businessintegrationmapping": put: responses: '200': description: OK '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/1422Model" examples: response: value: errorCode: 1422 errorMessage: Api call failed '401': description: Unauthorized content: application/json: schema: "$ref": "#/components/schemas/1161Model" x-apiary-response-models: - "$ref": "#/components/schemas/1161Model" - "$ref": "#/components/schemas/1167Model" - "$ref": "#/components/schemas/1033Model" x-apiary-response-examples: error_1161: value: code: 1161 message: Invalid API key error_1167: value: code: 1167 message: API key is missing error_1033: value: code: 1033 message: You are not authorized to perform this action examples: response: value: code: 1161 message: Invalid API key '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/1175Model" examples: response: value: code: 1175 message: No business found with the given id '429': description: Too Many Requests content: application/json: schema: "$ref": "#/components/schemas/89Model" examples: response: value: code: 89 message: Rate limit exceeded summary: Add locations operationId: addLocations description: Add Business Integration Mapping adds locations to integrations and set them active. tags: - Integration parameters: - name: Accept in: header description: e.g. application/json required: false example: application/json schema: type: string default: application/json - name: x-api-key in: header description: e.g. [Required] Partner specific API key provided by Birdeye for data exchange. required: false example: "[Required] Partner specific API key provided by Birdeye for data exchange." schema: type: string - name: Content-Type in: header description: Media type of the JSON request body. required: false example: application/json schema: type: string default: application/json requestBody: content: application/json: schema: type: object properties: businessNumber: type: number description: Business number. integrationGroupId: type: number description: Integration Group Id. active: type: boolean description: Active state. integrationProperties: type: object properties: {} description: Add properties in key value pair. required: - businessNumber - integrationGroupId - active example: businessNumber: 166015909542313 integrationGroupId: 12345 active: true integrationProperties: - propertyKey: property_key propertyValue: '1234567' example: businessNumber: 166015909542313 integrationGroupId: 12345 active: true integrationProperties: - propertyKey: property_key propertyValue: '1234567' tags: - name: Business description: Create and maintain your business on Birdeye. - name: Custom Fields description: Create, delete , update , associate and get custom fields easily. - name: User description: Delete and manage user profiles and permissions easily. - name: Reviews description: Consistently generate more reviews and higher ratings. - name: Contact description: Manage contacts across locations effortlessly with a robust Contact Management System. - name: Contact V2 description: Easily manage contacts across multiple locations using enhanced Contact APIs, featuring built-in support for communication preference flags. - name: Campaign description: Create a short link for review requests and set review sources in the template. - name: Aggregation description: Access your public data from 150+ review sites. - name: Report description: Various reporting data points across Birdeye modules like reviews, insights and competitors etc for all your data visualisation - name: Survey description: Engage each customer at the right time with NPS or CSAT surveys to improve your service. - name: Business Media description: |- Add, delete and manage business media. > __Supported Media Size__ > - _Photo: JPG or PNG. 720 x 720px. 10KB min._ > - _Video: 30 sec long. 720p or more upto 75MB._ > __Note__ > - _Uploaded media will be pushed to your google business profile (if connected) and other long tail directories only._ - name: Social description: Create and track Social posting for all channels. - name: Employee - name: Conversation description: Connect with customers across a range of digital channels from one unified inbox. - name: Subscription description: Subscribe or Unsubscribe multiple webhooks with different URLs or Events for a subscription and deliver real-time notifications. - name: Webhook description: Configure multiple webhooks with different URLs for a subscription and deliver real-time notifications. - name: Competitor description: Make competitive insights your unfair advantage. - name: Competitor AI description: Competitive intelligence, simplified by AI. - name: Insight AI description: Insight intelligence, simplified by AI. - name: Google Q&A description: |- > __Note__ > - _Applicable to be used only by paid listings clients, for their active locations, for the Google Q&A section, in the Google listing_ - name: Google Services description: |- > __Note__ > - _Applicable to be used only by paid listings clients, for their active locations, for the Google Services section, in the Google listing._ > - _No two services should have the same service name. It is recommended that all services created should HAVE UNIQUE service names._ > - _You CAN have the same service across two diff categories e.g.: Emergency counselling as a $100 paid service can be a service created & mapped to category A - Mental health and category B - Psychotherapy - both categories being present for the same location._ - name: FAQ description: To retrieve all Question and Answer (QnA) entries across locations using FAQ APIs, enabling smart support and knowledge features for businesses. - name: Listing description: Keep your business information accurate and consistent across 50+ websites. - name: GMB Products description: To manage products, locations, and business details through Listing GMB platform - name: Search AI description: Search AI provides a comprehensive view of your business performance across AI-powered search platforms, including data accuracy, sentiment analysis, citations, brand ranking, and overall visibility. - name: Ticketing description: Create standout customer support with ticketing across reviews, untagged, and survey responses. - name: Integration description: Birdeye integrates with various software or tools you use. - name: Change Logs description: |- * 07/03/2026 - Updated `mainBusinessDescription` and microsite `internalListing.description` fields in Create, Update and Get Listing APIs to be optional instead of required, with support for clearing the existing value by sending an empty string (V2BIRD-1690). * 06/10/2026 - Updated Get Contact API to support an optional `experienceScore` boolean field in the request body (default: false). When set to true, the response includes the customer's experience score and source. * 05/25/2026 - Added Update Custom card (PUT) and Delete Custom card (DELETE) API documentation under the Business profile custom card section. * 05/11/2026 - Added support for backdated survey responses in the POST Survey Response API. The `created` field (UTC Epoch milliseconds) is optional; if omitted, the server defaults to the current UTC timestamp. * 04/22/2026 - Provide subLocality field support in Get, Create and Update Listings APIs for NZ Locations. * 04/16/2026 - Added Archived Get Reviews API under Reviews group. * 04/06/2026 - Updated Get Reviews API documentation to improve clarity on review statuses and how to retrieve all review types. * 03/24/2026 - Added Social Open URL Performance Report API and Insight AI APIs to retrieve location-wise metrics and benchmark score. * 03/18/2026 - Added Create Custom Card Time API under custom fields section. * 03/03/2026 - Added Response Time (overtime & by-location) and Response Rate(overtime & by-location) APIs under reports section and created group for Competitor AI. * 03/02/2026 - Added sendInvite (boolean, default - true) field in Create User Signup v2 API request body and attributes. * 02/11/2026 - Updated the API key identifier for applicable APIs by moving it from a query parameter to the x-api-key request header. * 02/03/2026 - Added the "Get All QnA" API under FAQ group to enable retrieval of QnA entries across business locations, with full request and response documentation * 01/19/2026 - Added a note under the Authentication and Rate limiting section specifying that the x-api-key header is mandatory for all API requests targeting EU region business accounts. * 01/13/2026 - Added Create User (Signup) API under User module to create and invite users for a business. * 09/22/2025 - Added GMB Products APIs to onboard/connect Google Merchant accounts and manage product listing actions. * 08/21/2025 - Added Single main business description Support. * 08/19/2025 - Added competitor /raptor public APIs for reviews aggregates. * 06/26/2025 - Added Contact V2 APIs with communication preference flag support. * 12/13/2024 - Added inline reply support for GetReviews APIs. * 09/27/2024 - Added update for Google Opening Soon (BIRD-56987) * 06/25/2024 - Updated Listings Insights API (BIRDEYE-137367) * 05/29/2024 - Added Google Q&A Developers API Section * 05/13/2024 - Added epoc date support for GetReviews APIs. * 03/22/2024 - Add Update Hierarchy API (BIRD-32609) * 03/19/2024 - Added Ticket APIs Create, Get, Update APIs under Ticket module * 02/26/2024 - Updated logoUrl description in Get, Update APIs under Business module and Create, Get, Update APIs under Listing module (BIRD-29386) * 12/21/2023 - Add listing phase 2 api changes (BIRD-16589) * 11/08/2023 - Add survey changes (BIRD-11944) and listing changes (BIRD-14345) * 11/08/2023 - Added CRUD APIs for Apple chat * 10/15/2023 - Added CRUD APIs for Business Media. * 10/11/2023 - Added new APIs under Listing module, Create, Update, Get, Deactive Listings * 09/18/2023 - Added new API under Contact module i.e, Get opt-out contact data * 08/25/2023 - Added new APIs under Business and Listing modules, Get Category List API, Get GMB Attributes API & Get Timezone List * 07/21/2023 - Added new API under Business module i.e, Business Search API. * 06/30/2023 - Added support for service area based information in Get Business API and Update Business API. * 10/04/2024 - Added support to fetch ticketId associated with the survey responses in List Response API. servers: - url: https://api.birdeye.com/resources components: requestBodies: Competitive_Ranking_ReportBody: content: application/json: schema: type: object properties: startDate: type: string description: Start Date format MM/dd/YYYY. endDate: type: string description: End Date format MM/dd/YYYY. reviewSites: type: array description: List of Souce Ids. items: {} example: startDate: 10/08/2019 endDate: 01/15/2020 reviewSites: - '2' - '110' Get_Search_AI_CitationsBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_getSearchAiBusinesses_Request" Reviews_Rating_By_Location_ReportBody: content: application/json: schema: type: object properties: sourceAliases: type: array description: List of source aliases. items: {} businessNumbers: type: array description: List of business number. items: {} months: type: number description: Use to get results for last some months. example: sourceAliases: - 'citysearch ' - google businessNumbers: - '943967608' - '943476803' months: 12 Delete_AnswerBody: content: application/json: schema: type: object properties: questionId: type: number description: unique question identifier answerId: type: number description: unique answer identifier required: - questionId - answerId example: questionId: 7812 answerId: 7813 Get_opt-out_contact_dataBody: content: application/json: schema: type: object properties: start: type: number description: The start date format should be in milliseconds. If the start date is not set and the end date is provided, we will fetch data for 24 hours before the end date. If both are not provided, the latest 24 hours data will be fetched. end: type: number description: The end date format should be in milliseconds. If the end date is not set and the start date is provided, we will fetch data for 24 hours after the start date. If both are not provided, the latest 24 hours data will be fetched. subscriptionStatus: type: array description: Type of subscription update feed we want the data for. Like opted-out to get email and text optouts, and blocked for contacts getting blocked. If not provided, only opted-out updates will be returned, by default. items: {} required: - start - end - subscriptionStatus example: end: 1693657040000 start: 1693570640000 subscriptionStatus: - blocked - opted-out Get_Insight_Experience_Score_BenchmarkBody: content: application/json: schema: type: object properties: reviewSources: type: array description: Review sources to include. items: {} ratings: type: array description: Rating values to filter. items: {} businessNumbers: type: array description: List of business numbers (max 100). items: {} startDate: type: string description: Start date in MM/DD/YYYY format. endDate: type: string description: End date in MM/DD/YYYY format. hierarchyNodeData: type: array description: List of hierarchy nodes to filter by level. items: type: object properties: levelId: type: string description: The hierarchy level identifier (e.g. Region). levelNames: type: array description: List of level names to filter. items: type: string userEmail: type: string description: Email of the user performing the request. required: - businessNumbers - startDate - endDate - userEmail example: reviewSources: - Google - Facebook - CitySearch ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 hierarchyNodeData: - levelId: Region levelNames: - Region1 - Region2 userEmail: example@birdeye.com Add_aggregation_URLBody: content: application/json: schema: "$ref": "#/components/schemas/Apiary_addNewCompetitorAggregationUrl_Request" Review_Response_Rate_Over_TimeBody: content: application/json: schema: type: object properties: reviewSites: type: array description: List of review site IDs. items: {} ratings: type: array description: Ratings to include in the report. items: {} businessNumbers: type: array description: List of business numbers. items: {} startDate: type: string description: Start date in `MM/dd/YYYY` format. endDate: type: string description: End date in `MM/dd/YYYY` format. comparisonFilter: type: object properties: startDate: type: string description: Comparison start date in `MM/dd/YYYY` format. endDate: type: string description: Comparison end date in `MM/dd/YYYY` format. description: Comparison date range. example: reviewSites: - 2 - 1 - 110 - 100 ratings: - '0' - '1' - '3' - '4' - '5' businessNumbers: - 172957184851864 - 174436684666401 startDate: 02/25/2025 endDate: 02/01/2026 comparisonFilter: startDate: 01/01/2025 endDate: 01/10/2025 Get_All_Questions_and_AnswersBody: content: application/json: schema: type: object properties: startIndex: type: number description: start index pageSize: type: number description: page size required: - startIndex - pageSize example: startIndex: 0 pageSize: 25 Fix_ListingBody: content: application/json: schema: type: object properties: {} example: {} Add_Products_On_a_LocationBody: content: application/json: schema: type: object properties: productIds: type: array items: {} required: - productIds example: productIds: - 68767cb39ebf51000815ab39 - 68767cb39ebf51000815ab39 schemas: '89': {} '400': {} '1001': {} '1010': {} '1011': {} '1013': {} '1014': {} '1021': {} '1023': {} '1025': {} '1027': {} '1029': {} '1030': {} '1031': {} '1032': {} '1033': {} '1039': {} '1040': {} '1042': {} '1045': {} '1046': {} '1047': {} '1048': {} '1049': {} '1050': {} '1052': {} '1053': {} '1054': {} '1055': {} '1056': {} '1057': {} '1059': {} '1067': {} '1069': {} '1070': {} '1075': {} '1076': {} '1081': {} '1082': {} '1086': {} '1087': {} '1088': {} '1089': {} '1091': {} '1093': {} '1094': {} '1142': {} '1150': {} '1151': {} '1160': {} '1161': {} '1162': {} '1163': {} '1164': {} '1167': {} '1170': {} '1174': {} '1175': {} '1177': {} '1184': {} '1186': {} '1187': {} '1188': {} '1189': {} '1190': {} '1191': {} '1215': {} '1227': {} '1228': {} '1242': {} '1243': {} '1244': {} '1246': {} '1248': {} '1251': {} '1252': {} '1265': {} '1266': {} '1267': {} '1268': {} '1269': {} '1270': {} '1315': {} '1360': {} '1361': {} '1362': {} '1363': {} '1380': {} '1422': {} '1523': {} '1524': {} '1532': {} '1541': {} '2003': {} '2037': {} '2038': {} '2039': {} '2040': {} '2041': {} '2042': {} '2043': {} '2044': {} '2045': {} '2046': {} '2047': {} '2048': {} '2049': {} '2050': {} '2051': {} '2052': {} '2053': {} '2054': {} '2055': {} '2056': {} '2057': {} '2058': {} '2059': {} '2060': {} '2061': {} '2062': {} '2063': {} '2064': {} '2065': {} '2066': {} '2067': {} '2068': {} '2069': {} '2070': {} '2071': {} '2072': {} '2073': {} '2074': {} '2075': {} '2076': {} '2077': {} '2078': {} '2079': {} '2080': {} '2081': {} '2082': {} '2083': {} '2084': {} '2085': {} '2086': {} '2087': {} '2088': {} '2090': {} '2091': {} '2092': {} '2093': {} '2094': {} '2095': {} '2096': {} '2110': {} '2111': {} '2150': {} '2151': {} '2152': {} '2153': {} '2154': {} '2155': {} '2156': {} '2157': {} '2166': {} '2171': {} '2174': {} '2175': {} '2176': {} '2177': {} '2178': {} '2180': {} '2181': {} '2222': {} '2270': {} '2286': {} '2290': {} '2292': {} '2293': {} '2296': {} '2297': {} '2347': {} '2348': {} '2457': {} '2458': {} '2461': {} '2462': {} '2466': {} '2476': {} '2477': {} '2478': {} '2479': {} '2480': {} '2481': {} '2482': {} '2483': {} '2484': {} '2485': {} '2486': {} '2487': {} '2488': {} '2489': {} '2490': {} '2491': {} '2492': {} '2493': {} '2494': {} '2495': {} '2496': {} '2511': {} '2512': {} '2513': {} '2514': {} '2515': {} '2516': {} '2517': {} '2518': {} '2519': {} '2520': {} '2521': {} '2522': {} '3333': {} '3334': {} '3335': {} '3336': {} '3337': {} '3348': {} '4011': {} '4012': {} '4013': {} '4014': {} '4015': {} '5008': {} '5022': {} '5023': {} '5024': {} '5025': {} '5026': {} '5028': {} '5031': {} '5039': {} '5040': {} '5043': {} '5046': {} '5556': {} '5557': {} '6000': {} '6001': {} '20083': {} '20706': {} '21101': {} '21103': {} '21104': {} '21112': {} '21113': {} '21114': {} '21120': {} '21121': {} '21122': {} '40001': {} 1023Model: type: object properties: code: type: number message: type: string example: code: 1023 message: No email addresses specified 1052Model: type: object properties: code: type: number message: type: string example: code: 1052 message: User email id cannot be blank 1150Model: type: object properties: code: type: number message: type: string example: code: 1150 message: Business already associated with this reseller 1151Model: type: object properties: code: type: number message: type: string example: code: 1151 message: Business already associated with another reseller 1040Model: type: object properties: code: type: number message: type: string example: code: 1040 message: Invalid temmplate id. 1045Model: type: object properties: code: type: number message: type: string example: code: 1045 message: Business name cannot be blank 1046Model: type: object properties: code: type: number message: type: string example: code: 1046 message: Business name cannot be more than 250 characters 1047Model: type: object properties: code: type: number message: type: string example: code: 1047 message: Business name cannot be less than 3 characters 1094Model: type: object properties: code: type: number message: type: string example: code: 1094 message: Postal code cannot be blank. 1030Model: type: object properties: code: type: number message: type: string example: code: 1030 message: URL cannot be blank 1031Model: type: object properties: code: type: number message: type: string example: code: 1031 message: Source id cannot be blank 1032Model: type: object properties: code: type: number message: type: string example: code: 1032 message: Invalid source id 1039Model: type: object properties: code: type: number message: type: string example: code: 1039 message: Invalid business aggregation id 1067Model: type: object properties: code: type: number message: type: string example: code: 1067 message: URL is invalid 1075Model: type: object properties: code: type: number message: type: string example: code: 1075 message: Business location zip cannot be more than 6 numbers 1025Model: type: object properties: code: type: number message: type: string example: code: 1025 message: Invalid business type 1161Model: type: object properties: code: type: number message: type: string example: code: 1161 message: Invalid API key 1167Model: type: object properties: code: type: number message: type: string example: code: 1167 message: API key is missing 89Model: type: object properties: code: type: number message: type: string example: code: 89 message: Rate limit exceeded 1033Model: type: object properties: code: type: number message: type: string example: code: 1033 message: You are not authorized to perform this action 1175Model: type: object properties: code: type: number message: type: string example: code: 1175 message: No business found with the given id 1010Model: type: object properties: code: type: number message: type: string example: code: 1010 message: No user found with the given id 1076Model: type: object properties: code: type: number message: type: string example: code: 1176 message: Business info cannot be blank 1162Model: type: object properties: code: type: number message: type: string example: code: 1162 message: Either search string or location or both should be specified 1163Model: type: object properties: code: type: number message: type: string example: code: 1163 message: Invalid start index value 1164Model: type: object properties: code: type: number message: type: string example: code: 1164 message: Invalid result count value 1011Model: type: object properties: code: type: number message: type: string example: code: 1011 message: Business id is invalid 1380Model: type: object properties: code: type: number message: type: string example: code: 1380 message: Api key or session token missing 1048Model: type: object properties: code: type: number message: type: string example: code: 1048 message: Business email id cannot be blank. 1049Model: type: object properties: code: type: number message: type: string example: code: 1049 message: Business email id is invalid. 1050Model: type: object properties: code: type: number message: type: string example: code: 1050 message: Business email id cannot be more than 40 characters. 1055Model: type: object properties: code: type: number message: type: string example: code: 1055 message: Not a valid US phone number. 1056Model: type: object properties: code: type: number message: type: string example: code: 1056 message: Not a valid US fax number. 1069Model: type: object properties: code: type: number message: type: string example: code: 1069 message: Business description cannot be more than 4000 characters. 1070Model: type: object properties: code: type: number message: type: string example: code: 1070 message: Business keywords cannot be more than 1000 characters. 1089Model: type: object properties: code: type: number message: type: string example: code: 1089 message: Customer id is invalid. 1091Model: type: object properties: code: type: number message: type: string example: code: 1091 message: User id not authorized to view this customer. 1190Model: type: object properties: code: type: number message: type: string example: code: 1190 message: Invalid category 1184Model: type: object properties: code: type: number message: type: string example: code: 1184 message: Status change is not allowed 1191Model: type: object properties: code: type: number message: type: string example: code: 1191 message: Invalid status. 1174Model: type: object properties: code: type: number message: type: string example: code: 1174 message: Reseller can't be removed as it has child accounts. 1160Model: type: object properties: code: type: number message: type: string example: code: 1160 message: User is already associated with business. 1053Model: type: object properties: code: type: number message: type: string example: code: 1053 message: User email id is invalid 1054Model: type: object properties: code: type: number message: type: string example: code: 1054 message: User email id cannot be more than 40 characters 1014Model: type: object properties: code: type: number message: type: string example: code: 1014 message: User role cannot be blank 1013Model: type: object properties: code: type: number message: type: string example: code: 1013 message: Unknown user role 1057Model: type: object properties: code: type: number message: type: string example: code: 1057 message: First name cannot be more than 50 characters 1059Model: type: object properties: code: type: number message: type: string example: code: 1059 message: Last name cannot be more than 50 characters 1188Model: type: object properties: code: type: number message: type: string example: code: 1188 message: User is not associated with the business. 1189Model: type: object properties: code: type: number message: type: string example: code: 1189 message: User with given email id not found. 1177Model: type: object properties: code: type: number message: type: string example: code: 1177 message: User is not authorized to perform any action on any business 1081Model: type: object properties: code: type: number message: type: string example: code: 1081 message: Review comment is too long 1082Model: type: object properties: code: type: number message: type: string example: code: 1082 message: Review rating is missing 1142Model: type: object properties: code: type: number message: type: string example: code: 1142 message: Customer name cannot be blank 1086Model: type: object properties: code: type: number message: type: string example: code: 1086 message: Customer email id cannot be blank. 1087Model: type: object properties: code: type: number message: type: string example: code: 1087 message: Customer email id is invalid. 1088Model: type: object properties: code: type: number message: type: string example: code: 1088 message: Customer email id cannot be more than 40 characters. 1170Model: type: object properties: code: type: number message: type: string example: code: 1170 message: SMS Alert flag is invalid. Valid values are 0 or 1. 1242Model: type: object properties: code: type: number message: type: string example: code: 1242 message: Invalid rating value. Allowed value between 0-5. 1228Model: type: object properties: code: type: number message: type: string example: code: 1228 message: Invalid updated to date. Allowed format is MM/dd/yyyy 1227Model: type: object properties: code: type: number message: type: string example: code: 1227 message: Invalid updated from date. Allowed format is MM/dd/yyyy 1243Model: type: object properties: code: type: number message: type: string example: code: 1243 message: Invalid rating value. Allowed value between 1-5. 1244Model: type: object properties: code: type: number message: type: string example: code: 1244 message: Maximum 5 keywords can be selected for filter. 1246Model: type: object properties: code: type: number message: type: string example: code: 1246 message: Customer email or phone number is required. 1215Model: type: object properties: code: type: number message: type: string example: code: 1215 message: Invalid report month. 1251Model: type: object properties: code: type: number message: type: string example: code: 1251 message: No review to mark featured/un-featured. 1042Model: type: object properties: code: type: number message: type: string example: code: 1042 message: Invalid review id 1252Model: type: object properties: code: type: number message: type: string example: code: 1252 message: Review does not belong to the business. 1248Model: type: object properties: code: type: number message: type: string example: code: 1248 message: Allowed limit for featured reviews exceeded. 1186Model: type: object properties: code: type: number message: type: string example: code: 1186 message: Invalid from date. Allowed format is "MM/dd/yyyy". 1187Model: type: object properties: code: type: number message: type: string example: code: 1187 message: Invalid to date. Allowed format is "MM/dd/yyyy". 1265Model: type: object properties: code: type: number message: type: string example: code: 1265 message: Value for showOnFacebook is mandatory. 1266Model: type: object properties: code: type: number message: type: string example: code: 1266 message: Value for showOnProfile is mandatory. 1267Model: type: object properties: code: type: number message: type: string example: code: 1267 message: Value for showOnWebsite is mandatory. 1268Model: type: object properties: code: type: number message: type: string example: code: 1268 message: TabType is mandatory field. 1269Model: type: object properties: code: type: number message: type: string example: code: 1269 message: Max length for lable is 30. 1270Model: type: object properties: code: type: number message: type: string example: code: 1270 message: Max length for URL is 1000. 1360Model: type: object properties: code: type: number message: type: string example: code: 1360 message: Hierarchy is not supported for this parent type. 1361Model: type: object properties: code: type: number message: type: string example: code: 1361 message: Hierarchy is not supported for this child type. 1362Model: type: object properties: code: type: number message: type: string example: code: 1362 message: "{Child type} cannot be added under {Parent type}." 1363Model: type: object properties: code: type: number message: type: string example: code: 1363 message: Invalid parent child mapping. 1029Model: type: object properties: code: type: number message: type: string example: code: 1029 message: Aggregation source not found 1315Model: type: object properties: code: type: number message: type: string example: code: 1315 message: Invalid survey. 1523Model: type: object properties: code: type: number message: type: string example: code: 1523 message: The correct date format should be mm/dd/yyyy. 1524Model: type: object properties: code: type: number message: type: string example: code: 1524 message: Date entered is invalid. 2110Model: type: object properties: code: type: number message: type: string example: code: 2110 message: Your review response could not be submitted due to a temporary error on Google. Please try after some time. 21101Model: type: object properties: code: type: number message: type: string example: code: 21101 message: Google page is not integrated. Kindly integrate it first. 21103Model: type: object properties: code: type: number message: type: string example: code: 21103 message: Your review response could not be submitted due to a temporary error on Google. 21104Model: type: object properties: code: type: number message: type: string example: code: 21104 message: Sorry, We could not find this review on Google. Please go to your Google Business page and reply to this review. Thank you. 2111Model: type: object properties: code: type: number message: type: string example: code: 2111 message: Your review response could not be submitted due to a temporary error on Facebook. Please try after some time. 21113Model: type: object properties: code: type: number message: type: string example: code: 21113 message: Facebook page is not integrated. Kindly integrate it first. 21114Model: type: object properties: code: type: number message: type: string example: code: 21114 message: Sorry, We could not find this review on Facebook. Please go to your Facebook page and reply to this review. Thank you. 21112Model: type: object properties: code: type: number message: type: string example: code: 21112 message: Your review response could not be submitted due to a temporary error on Facebook. 2222Model: type: object properties: code: type: number message: type: string example: code: 2222 message: Oops! Something is off on our side. We are working on it. Please check later. 2075Model: type: object properties: code: type: number message: type: string example: code: 2075 message: Error while claiming a provider for Care Dash 20706Model: type: object properties: code: type: number message: type: string example: code: 20706 message: Error while posting a reply to Care Dash 2078Model: type: object properties: code: type: number message: type: string example: code: 2078 message: Error while posting a reply to Rent 1541Model: type: object properties: code: type: number message: type: string example: code: 1541 message: Rate Limit of API has been exceeded. 1532Model: type: object properties: code: type: number message: type: string example: code: 1532 message: Business id is missing or invalid. 5008Model: type: object properties: code: type: number message: type: string example: code: 5008 message: RequestBody not found 5043Model: type: object properties: code: type: number message: type: string example: code: 5043 message: Contact not found for the given request 2038Model: type: object properties: code: type: number message: type: string example: code: 2038 message: Invalid value of role, expected editor, viewer or no-access 2041Model: type: object properties: code: type: number message: type: string example: code: 2041 message: Can't modify owner or existing owner's access! 2039Model: type: object properties: code: type: number message: type: string example: code: 2039 message: User email is missing in user access request! 2043Model: type: object properties: code: type: number message: type: string example: code: 2043 message: Invalid value of showTitle, accepted values are CUSTOM, LOCATION, OFF 2090Model: type: object properties: code: type: number message: type: string example: code: 2090 message: Invalid value of showLogo, accepted values are ON, OFF 2040Model: type: object properties: code: type: number message: type: string example: code: 2040 message: Invalid value of progress bar position, expected Bottom or Top 2042Model: type: object properties: code: type: number message: type: string example: code: 2042 message: Received no valid inputs in request body! 2037Model: type: object properties: code: type: number message: type: string example: code: 2037 message: The survey doesn't belong to the account. 2044Model: type: object properties: code: type: number message: type: string example: code: 2044 message: Survey already completed 2093Model: type: object properties: code: type: number message: type: string example: code: 2093 message: Survey Field Type passed is unknown 2045Model: type: object properties: code: type: number message: type: string example: code: 2045 message: Invalid Survey Type 2046Model: type: object properties: code: type: number message: type: string example: code: 2046 message: Min Value is greater then Max Value 2047Model: type: object properties: code: type: number message: type: string example: code: 2047 message: Survey Fields Missing! 2048Model: type: object properties: code: type: number message: type: string example: code: 2048 message: Field Rows Missing 2049Model: type: object properties: code: type: number message: type: string example: code: 2049 message: Interval can only be 30 min or 60 min 2050Model: type: object properties: code: type: number message: type: string example: code: 2050 message: More than one location question cannot be present 2051Model: type: object properties: code: type: number message: type: string example: code: 2051 message: More than one review question cannot be present 2052Model: type: object properties: code: type: number message: type: string example: code: 2052 message: Review question should be present in the last page of the survey as a single question 2053Model: type: object properties: code: type: number message: type: string example: code: 2053 message: Contact Fields are not present 2054Model: type: object properties: code: type: number message: type: string example: code: 2054 message: Min Value out of range 2055Model: type: object properties: code: type: number message: type: string example: code: 2055 message: Max Value out of range 2056Model: type: object properties: code: type: number message: type: string example: code: 2056 message: Min and Max values can only be even numbers when the interval is 60 minutes 2057Model: type: object properties: code: type: number message: type: string example: code: 2057 message: Either one of Min and Max values is missing in datetime type question 2058Model: type: object properties: code: type: number message: type: string example: code: 2058 message: LocationIds are not present 2059Model: type: object properties: code: type: number message: type: string example: code: 2059 message: Invalid type of contact question 2060Model: type: object properties: code: type: number message: type: string example: code: 2060 message: reviewSources are not present for review type question 2061Model: type: object properties: code: type: number message: type: string example: code: 2061 message: Pickone type of survey can only contain pickone type questions 2062Model: type: object properties: code: type: number message: type: string example: code: 2062 message: Traditional type survey cannot contain these type questions 2063Model: type: object properties: code: type: number message: type: string example: code: 2063 message: Pulse(NPS) Survey can only contain radio, text, textarea(paragraph), rating and nps type questions 2064Model: type: object properties: code: type: number message: type: string example: code: 2064 message: First page of the survey must contain atleast one question except review question 2065Model: type: object properties: code: type: number message: type: string example: code: 2065 message: There cannot be more than 3 sourceIds for review question 2066Model: type: object properties: code: type: number message: type: string example: code: 2066 message: BusinessIds passed in the location type question are invalid 2067Model: type: object properties: code: type: number message: type: string example: code: 2067 message: One of the locations passed in the request is not present 2068Model: type: object properties: code: type: number message: type: string example: code: 2068 message: The locationIds are Non-Parseable 2069Model: type: object properties: code: type: number message: type: string example: code: 2069 message: surveyName is Mandatory 2070Model: type: object properties: code: type: number message: type: string example: code: 2070 message: Question Type cannot be blank 2071Model: type: object properties: code: type: number message: type: string example: code: 2071 message: Invalid ownerEmailId 2072Model: type: object properties: code: type: number message: type: string example: code: 2072 message: Choice cannot be a blank string 2073Model: type: object properties: code: type: number message: type: string example: code: 2073 message: Logic type is Invalid! 2074Model: type: object properties: code: type: number message: type: string example: code: 2074 message: Cannot contain a logic 2092Model: type: object properties: code: type: number message: type: string example: code: 2092 message: Invalid Logic! 2076Model: type: object properties: code: type: number message: type: string example: code: 2076 message: Value of the logic is not present in the choices of Question 2077Model: type: object properties: code: type: number message: type: string example: code: 2077 message: Value of a questionLogic field cannot be blank 2091Model: type: object properties: code: type: number message: type: string example: code: 2091 message: Operator Invalid 2079Model: type: object properties: code: type: number message: type: string example: code: 2079 message: Only one Skip logic is allowed for text and textarea type questions 2080Model: type: object properties: code: type: number message: type: string example: code: 2080 message: Display Logic Invalid! 2081Model: type: object properties: code: type: number message: type: string example: code: 2081 message: Skip Logic Invalid! 2082Model: type: object properties: code: type: number message: type: string example: code: 2082 message: The API returned an empty response. 2083Model: type: object properties: code: type: number message: type: string example: code: 2083 message: Source is not integrated with the business 2084Model: type: object properties: code: type: number message: type: string example: code: 2084 message: Opeartor must be present for logics other than the first display logic 2085Model: type: object properties: code: type: number message: type: string example: code: 2085 message: Condition cannot be null! 2086Model: type: object properties: code: type: number message: type: string example: code: 2086 message: Question Number cannot be null 2087Model: type: object properties: code: type: number message: type: string example: code: 2087 message: Duplicate contact sub type question is present 2088Model: type: object properties: code: type: number message: type: string example: code: 2088 message: Review Source already present 2094Model: type: object properties: code: type: number message: type: string example: code: 2094 message: ReviewSources passed are invalid 2095Model: type: object properties: code: type: number message: type: string example: code: 2095 message: ownerEmailId cannot be null 2096Model: type: object properties: code: type: number message: type: string example: code: 2096 message: Detected conflicting user-access request! 2347Model: type: object properties: code: type: number message: type: string example: code: 2347 message: Max page size allowed is 1,000 2348Model: type: object properties: code: type: number message: type: string example: code: 2348 message: Max window size allowed is 60000 for a filter selection 21122Model: type: object properties: code: type: number message: type: string example: code: 21122 message: Reseller business is not supported in this request 21120Model: type: object properties: code: type: number message: type: string example: code: 21120 message: Invalid contact type provided in the request. Valid contact types are lead or customer 21121Model: type: object properties: code: type: number message: type: string example: code: 21121 message: Invalid contact source provided in the request. 5046Model: type: object properties: code: type: number message: type: string example: code: 5046 message: The customer is blocked 1021Model: type: object properties: code: type: number message: type: string example: code: 1021 message: Invalid Phone Number. 1001Model: type: object properties: code: type: number message: type: string example: code: 1001 message: Name of the contact is too long. 1422Model: type: object properties: errorCode: type: number errorMessage: type: string example: errorCode: 1422 errorMessage: Api call failed 5556Model: type: object properties: code: type: number message: type: string example: code: 5556 message: One or few BusinessIds are Invalid 5557Model: type: object properties: code: type: number message: type: string example: code: 5557 message: Requested Business Ids are empty. 400Model: type: object properties: code: type: number message: type: string example: code: 400 message: Page size must not be less than one! 4011Model: type: object properties: code: type: number message: type: string example: code: 400 message: Category Id not found 4012Model: type: object properties: code: type: number message: type: string example: code: 400 message: Country code not found 4013Model: type: object properties: code: type: number message: type: string example: code: 400 message: Invalid country code 4014Model: type: object properties: code: type: number message: type: string example: code: 400 message: Source name not found 4015Model: type: object properties: code: type: number message: type: string example: code: 400 message: Invalid Source Name 20083Model: type: object properties: code: type: number message: type: string example: code: 20083 message: End date can't be before start date 2180Model: type: object properties: code: type: number message: type: string example: code: 2180 message: The recommended Image size for Google media image is 250 pixels wide and 250 pixels tall. 2181Model: type: object properties: code: type: number message: type: string example: code: 2181 message: Supported video format is MP4. 2174Model: type: object properties: code: type: number message: type: string example: code: 2174 message: Unsupported media format 2171Model: type: object properties: code: type: number message: type: string example: code: 2171 message: URL is invalid 2175Model: type: object properties: code: type: number message: type: string example: code: 2175 message: Provided media category is not supported 2270Model: type: object properties: code: type: number message: type: string example: code: 2270 message: Unsupported Media Category for the business 2176Model: type: object properties: code: type: number message: type: string example: code: 400 message: Category can not be empty 2457Model: type: object properties: code: type: number message: type: string example: code: 2457 message: Invalid sortby value. Allowed values are 'frequency' or 'keyword' 2458Model: type: object properties: code: type: number message: type: string example: code: 2458 message: Invalid order value. Allowed values are 'asc' or 'desc'. 2177Model: type: object properties: code: type: number message: type: string example: code: 400 message: Invalid media id 2178Model: type: object properties: code: type: number message: type: string example: code: 400 message: mediaIds can not be empty 1093Model: type: object properties: code: type: number message: type: string example: code: 1093 message: HierarchyNode is enabled for this account. 2150Model: type: object properties: code: type: number message: type: string example: code: 2150 message: Not a valid reseller/enterprise id. 2151Model: type: object properties: code: type: number message: type: string example: code: 2151 message: Not a valid reseller/enterprise id. 2152Model: type: object properties: code: type: number message: type: string example: code: 2152 message: Not a valid reseller/enterprise id. 2153Model: type: object properties: code: type: number message: type: string example: code: 2153 message: Business name should not have the word Birdeye. 2154Model: type: object properties: code: type: number message: type: string example: code: 2154 message: Business is already an active account. 2155Model: type: object properties: code: type: number message: type: string example: code: 2155 message: Business is already an in-active account. 2156Model: type: object properties: code: type: number message: type: string example: code: 2156 message: Business/Location/Product already exists 2157Model: type: object properties: code: type: number message: type: string example: code: 2157 message: Business already associated with another reseller/enterprise. 2286Model: type: object properties: code: type: number message: type: string example: code: 2286 message: Zip code is not provided for business 2166Model: type: object properties: code: type: number message: type: string example: code: 2166 message: Invalid Business Type 2292Model: type: object properties: code: type: number message: type: string example: code: 2292 message: sortby can only be 'total' or 'location' 2293Model: type: object properties: code: type: number message: type: string example: code: 2293 message: order can only be 'asc' or 'desc' 40001Model: type: object properties: code: type: number message: type: string example: code: 40001 message: invalid start date (supported format is yyyy-MM-dd) 2296Model: type: object properties: code: type: number message: type: string example: code: 2296 message: Invalid Food Delivery link 2297Model: type: object properties: code: type: number message: type: string example: code: 2297 message: Invalid Food Takeout link 2290Model: type: object properties: code: type: number message: type: string example: code: 2290 message: Food Takeout/Food Delivery not supported for gmb primary category 2476Model: type: object properties: code: type: number message: type: string example: code: 2476 message: Question Id cannot be blank 2477Model: type: object properties: code: type: number message: type: string example: code: 2477 message: Answer Id is required to update existing answer 2478Model: type: object properties: code: type: number message: type: string example: code: 2478 message: Question is required 2479Model: type: object properties: code: type: number message: type: string example: code: 2479 message: Answer is required 2480Model: type: object properties: code: type: number message: type: string example: code: 2480 message: Cannot modify non owner Q&A 2482Model: type: object properties: code: type: number message: type: string example: code: 2482 message: Question Id is Invalid 2481Model: type: object properties: code: type: number message: type: string example: code: 2481 message: Q&A cannot be more than 4096 characters 2485Model: type: object properties: code: type: number message: type: string example: code: 2485 message: Questions should be 10 characters minimum 2483Model: type: object properties: code: type: number message: type: string example: code: 2483 message: Question should have minimum 3 words 2484Model: type: object properties: code: type: number message: type: string example: code: 2484 message: Answer Id cannot be blank 2461Model: type: object properties: code: type: number message: type: string example: code: 2461 message: No question found with provided request 2462Model: type: object properties: code: type: number message: type: string example: code: 2462 message: Owner answer already added please edit answer 2466Model: type: object properties: code: type: number message: type: string example: code: 2466 message: Invalid input request 2486Model: type: object properties: code: type: number message: type: string example: code: 2486 message: Business Id missing or invalid 2487Model: type: object properties: code: type: number message: type: string example: code: 2487 message: Invalid input request data 2488Model: type: object properties: code: type: number message: type: string example: code: 2488 message: Invalid GBP Service name 2489Model: type: object properties: code: type: number message: type: string example: code: 2489 message: Invalid GBP Service description 2490Model: type: object properties: code: type: number message: type: string example: code: 2490 message: Invalid GBP Service price type 2491Model: type: object properties: code: type: number message: type: string example: code: 2491 message: Invalid GBP Service price 2492Model: type: object properties: code: type: number message: type: string example: code: 2492 message: Invalid GBP Service currency code 2493Model: type: object properties: code: type: number message: type: string example: code: 2493 message: Duplicate Google Service is not allowed 2494Model: type: object properties: code: type: number message: type: string example: code: 2494 message: Invalid GBP Service Id 2495Model: type: object properties: code: type: number message: type: string example: code: 2495 message: Invalid GBP Service Id 2496Model: type: object properties: code: type: number message: type: string example: code: 2496 message: Missing GBP category for given location 3333Model: type: object properties: code: type: number message: type: string example: code: 1043 message: Business should be either SMB or Enterprise sub account 3334Model: type: object properties: code: type: number message: type: string example: code: 2503 message: Primary category can not be included in additional category. 3335Model: type: object properties: code: type: number message: type: string example: code: 2276 message: Please add upto 9 GBP additional categories only. 3336Model: type: object properties: code: type: number message: type: string example: code: 2277 message: Duplicate GBP categories are not allowed. 3337Model: type: object properties: code: type: number message: type: string example: code: 2278 message: Primary GBP category is not allowed in additional GBP categories. 3348Model: type: object properties: code: type: number message: type: string example: code: 2162 message: Reopen date should not be less than current date. 2511Model: type: object properties: code: type: number message: type: string example: code: 2511 message: Cannot update business status when listing is already fixed. 2512Model: type: object properties: code: type: number message: type: string example: code: 2512 message: Cannot update opening soon date when listing is already fixed. 2513Model: type: object properties: code: type: number message: type: string example: code: 2513 message: Opened On date can not be in future. 2514Model: type: object properties: code: type: number message: type: string example: code: 2514 message: Opening Soon date is mandatory when business is marked as Opening soon. 2515Model: type: object properties: code: type: number message: type: string example: code: 2515 message: Reopen date is not supported for this date. 2516Model: type: object properties: code: type: number message: type: string example: code: 2516 message: Opening Soon Date can not be more than 1 year from now. 2517Model: type: object properties: code: type: number message: type: string example: code: 2517 message: Opening Soon date should not be less than current date. 2518Model: type: object properties: code: type: number message: type: string example: code: 2518 message: Business Status is mandatory to pass with reopen, opened on and opening soon date. 2519Model: type: object properties: code: type: number message: type: string example: code: 2519 message: Third party categories change for opening soon business is not allowed. 2520Model: type: object properties: code: type: number message: type: string example: code: 2520 message: Open Date is not supported for this date 2521Model: type: object properties: code: type: number message: type: string example: code: 2285 message: Invalid text message number 2522Model: type: object properties: code: type: number message: type: string example: code: 2286 message: Invalid whatsapp business link 5022Model: type: object properties: code: type: number message: type: string example: code: 5022 message: Another custom field with same name already present. 5023Model: type: object properties: code: type: number message: type: string example: code: 5023 message: Custom field request dto cannot be null. 5024Model: type: object properties: code: type: number message: type: string example: code: 5024 message: Custom field creation failed. 5025Model: type: object properties: code: type: number message: type: string example: code: 5025 message: Custom field not found. 5026Model: type: object properties: code: type: number message: type: string example: code: 5026 message: Custom field updation failed. 5028Model: type: object properties: code: type: number message: type: string example: code: 5028 message: Custom field delete failed. 5031Model: type: object properties: code: type: number message: type: string example: code: 5031 message: Method not implemented for unknown custom field type. 5039Model: type: object properties: code: type: number message: type: string example: code: 5039 message: Custom field name cannot be a reserved keyword. 5040Model: type: object properties: code: type: number message: type: string example: code: 5040 message: Max limit reached for custom fields. 1027Model: type: object properties: code: type: number message: type: string example: code: 1027 message: Invalid business number. 2003Model: type: object properties: code: type: number message: type: string example: code: 2003 message: businessNumbers are mandatory 6000Model: type: object properties: code: type: number message: type: string example: code: 6000 message: The 'sub_locality' field is mandatory for addresses in New Zealand. 6001Model: type: object properties: code: type: number message: type: string example: code: 6001 message: The 'sub_locality' field cannot exceed 80 characters. Search: {} Get: {} Update: {} Delete: {} Signup: {} Password: {} Dashboard: {} Submit: {} Subscribe: {} Unsubscribe: {} Create_Business: {} Status_Update: {} Child_Businesses: {} Public_profile_tabs: {} Get_Hierarchy: {} Update_Hierarchy: {} Get_Custom_card_details: {} Manage_Custom_card: {} Get_Timezone_List: {} Get_Birdeye_Impressions: {} Create_Custom_Fields: {} Update_Custom_Fields: {} Get_Custom_Fields: {} Get_Custom_Fields_List: {} Delete_Custom_Fields: {} Associate_Custom_Fields: {} Create_Custom_card: {} Update_User: {} Archived_Get_Reviews: {} Review_Summary: {} Review_Reply: {} Create_Tags: {} Delete_Tag: {} Fetch_Tags: {} Search_reviews_and_assign_tags: {} Search_reviews_and_remove_tags: {} Remove_tags_from_all_reviews: {} Create_or_Update_Contact: {} Get_Contact: {} Delete_Contact: {} Check_in: {} Activity_log: {} Delete_Customer: {} Subscribe_Unsubscribe_Customer: {} Contacts_list: {} Customer_or_Lead_list: {} Contact_Us: {} Get_opt-out_Contacts: {} Upsert_Contact: {} Retrieve_Contact: {} Customer_Check_in: {} Update_Communication_Preferences: {} Retrieve_Opted-Out_Contacts: {} Fetch_Request_URL: {} Set_Defaullt_Review_Sources: {} Get_source_list: {} Get_Source_List-lite: {} Add_Aggregation_Link: {} Review_conversion_report: {} Review_and_rating_over_time: {} Reviews_Rating_By_Location: {} Review_Count_Rating: {} Review_Count_Rating_By_Employee: {} Insights_Category_Report_by_location: {} Competitive_Ranking: {} NPS_Over_time: {} NPS_By_Location: {} Review_By_Source: {} Visitor_report: {} Usage_report: {} Review_Response_Rate_Over_Time: {} Review_Response_Rate_By_Location_Overview: {} Average_Response_Time_By_Location: {} Average_Response_Time_Over_Time: {} List_Responses: {} Get_All: {} Create_Survey: {} Update_Settings: {} Add_Media: {} Get_Media: {} Update_Media: {} Delete_Media: {} Schedule_Social_Post: {} Edit_scheduled_Social_Post: {} Edit_published_social_Post: {} Delete_public_social_Post: {} Track_Social_Post: {} Social_Open_URL_Performance_Report: {} List_Conversations: {} List_webhook_events: {} Create_webhook_subscription: {} Competitor_of_Enterprise_Business: {} Child_Business_of_Competitor: {} Get_Competitors: {} Create_Competitor_Enterprise: {} Create_Child_Business: {} Get_Competitor_Review: {} Competitive_Insight_Category: {} Competitive_Insight_Themes: {} Competitive_Insight_Keywords: {} Retrieve_Competitor_Reviews: {} Retrieve_Competitor_Review_Metrics: {} Insight_Experience_Score_Benchmark: {} Insight_Experience_Location_Info: {} Create_Question: {} Create_Answer: {} Update_Question: {} Update_Answer: {} Delete_Question: {} Delete_Answer: {} Delete_All_Questions_and_Answers: {} Get_All_Questions_and_Answers: {} Get_All_Unanswered_Q_A: {} Create_Service: {} Get_All_Services: {} Update_Service: {} Delete_Services: {} Get_Location_Mapping: {} Update_Location_Mapping: {} Get_All_QnA: {} Fix_Listing: {} Get_Location_Status_Report: {} Listings_Insights: {} Listings_Insights_Datapoints: {} Get_GMB_Attributes: {} Get_Apple_Attributes: {} Get_Apple_Action_Links: {} Get_Category_List: {} Create_Listing: {} Update_Listing: {} Get_Listing: {} Get_More_Hours_Type: {} Get_Google_Keywords_Count: {} Deactivate_Listing: {} Retrieve_Menu_Details: {} Get_Hotel_Attributes: {} Onboard_Google_Merchant_Account: {} Create_Product_Listing: {} Update_Product_Listing: {} Get_Product_Listing: {} Delete_Product_Listings: {} Get_List_Product_Listing: {} Add_Products_On_a_Location: {} Remove_Products_On_a_Location: {} Get_Search_AI_Configuration: {} Get_Search_AI_Available_Runs: {} Get_Search_AI_Citations: {} Get_Search_AI_Businesses: {} Get_Accuracy_Report: {} Get_Sentiment_Report: {} Create_ticket: {} Add_Ticket_Comments: {} Update_ticket: {} Get_All_Ticket_Data: {} Add_Business_Integration_Mapping: {} Apiary_createABusiness_Request: type: object properties: businessName: type: string description: Name of the Business that needs to be added zip: type: string description: Postal code of the business location type: type: string description: Type of the Business. Valid values are phone: type: number description: Phone number of the Business. entityCategory: type: string description: 'Specifies the category of the business entity being created or updated. Valid values are:' countryCode: type: string description: This field is mandatory for non US locations. aggrOptions: type: number description: Aggregation Options to enable/disable aggregations. Possible values are [0,1] required: - businessName - zip - phone example: businessName: The Business Name zip: 32323 type: Business phone: '4032365164' entityCategory: physical_location countryCode: US aggrOptions: 1 Apiary_searchBusiness_Request: type: object properties: searchStr: type: string description: Search criteria for business. This could be business name or number. sortBy: type: string description: Results can be sorted by name, createdAt, and createdBy. By default is createdAt. sortOrder: type: string description: The SORT order, Possible values "ASC" or "DESC". By default is "DESC". startIndex: type: number description: Once sorted, it defines starting from which index a page (number of specified search results) is to be created. pageSize: type: number description: Determines the number of search results in the response. Users can set a desired value to limit results, e.g., pageSize=25 shows the top 25 business listings. The Default value is 25. example: pageSize: 25 searchStr: Thurston Rosenlund sortBy: createdAt sortOrder: ASC startIndex: 0 Apiary_searchBusiness_Response200: type: object properties: totalCount: type: number description: The total number of search matches. accounts: type: array description: Search results items: type: object properties: name: type: string description: The business name status: type: string description: The business status - active, demo, paid, suspended etc. createdAt: type: string description: The date of business (or location) creation. createdBy: type: string description: Full name of the user who created the business (or location). businessNumber: type: string description: Unique number associated with every business (or location). type: type: string description: Returned in case of resellers, specifies whether account is SMB, enterprise, or reseller Apiary_getBusiness_Response200: type: object properties: businessId: type: number description: Id of the Business (Long). name: type: string description: Name of the Business/Product (Max 1000 character long). alias: type: string description: Alias, Your internal way of identifying this location. emailId: type: string description: Business Email ID. phone: type: string description: Business Phone (Required) Format is (xxx) xxx-xxxx. fax: type: string description: Fax number Format is (xxx) xxx-xxxx. websiteUrl: type: string description: Business website url. description: type: string description: Description of the business (10 to 4000 character long). services: type: string description: Services (Comma separated list of services offered; used for SEO). keywords: type: string description: Keywords (Comma separated list of keywords; Max 10 keywords; used for SEO). logoUrl: type: string description: 'Logo Image. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.' coverImageUrl: type: string description: Cover Image (Dimension should be 1296 x 367 px). gmbCover: type: string description: Google Cover Image Url. facebookCover: type: string description: Facebook Cover Image Url. timezone: type: string description: Timezone of the business. languages: type: array description: Language. items: {} isServiceAreaProvider: type: string description: 'To select whether the business is Service Area Business Type. Default value is : No. Possible values are:' serviceAreas: type: array description: Service Area information. items: type: object properties: description: type: string description: Description about the Service Area. placeId: type: string description: Place Id. payment: type: string description: Payment Type (Max 250 character long). hoursOfOperations: type: array description: Working hours of business for each day. items: type: object properties: day: type: number description: 0(Monday), 1(Tuesday), 2(Wednesday) and so on. workingHours: type: array items: type: object properties: startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) description: Working hours of the business isOpen: type: number description: 0 (Business closed today), 1 (open) comment: type: string description: Add the special instruction. working24x7: type: number description: Whether business is 24x7 open or not (0-false, 1-true). location: type: object properties: address1: type: string description: Address of the business. address2: type: string description: Address of the business. subLocality: type: string description: "(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system." city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. required: - zip description: Business address reviewCount: type: number description: Total review count of the business. avgRating: type: number description: Average rating of the business. status: type: string description: Business status. Valid values are demo, active, inactive. Default is type: type: string description: 'Business type. Valid values are "Business, Enterprise-Location, Enterprise-Product, Reseller or a existing custom hierarchy type". Default is:' category: type: string description: Category (Mapped to Google Category). socialProfileURLs: type: object properties: facebookUrl: type: string description: Facebook URL. twitterUrl: type: string description: Business Twitter URL. linkedInUrl: type: string description: Business LinkedId URL. googleUrl: type: string description: Business Google URL. youTubeUrl: type: string description: Business Youtube URL. description: Profile URLs for business on top rated social sites isSEOEnabled: type: boolean description: Enable/Disbale search engine indexing of business profile. Valid values are "true","false". Default is "true" required: - services Apiary_updateBusiness_Request: type: object properties: name: type: string description: Name of the Business/Product (Max 250 character long). alias: type: string description: Alias, Your internal way of identifying this location. isAddressHidden: type: number description: If your business doesn’t have a place for your customers to visit, then you can hide your street address. 1 -> hide, 0 -> unhide (Note that this isn’t supported by all sites). location: type: object properties: address1: type: string description: Address of the business/location. address2: type: string description: Address of the business/location. subLocality: type: string description: "(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system." city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. required: - zip description: Business address emailId: type: string description: Business Email ID. phone: type: string description: Business Phone (Required) Format is (xxx) xxx-xxxx. fax: type: string description: Fax number Format is (xxx) xxx-xxxx. websiteUrl: type: string description: Business website url. establishedYear: type: number description: Year established timezone: type: string description: Timezone of the business. languages: type: array description: Language. items: {} isServiceAreaProvider: type: string description: 'To select whether the business is Service Area Business Type. Default value is : No.' serviceAreas: type: array description: Service Area information. You can enter upto 10 service area addresses in one request items: type: object properties: description: type: string description: 'For supported service areas, Possible formats:' working24x7: type: number description: Whether business is 24x7 open or not (0-false, 1-true). hoursOfOperations: type: array description: Working hours of business for each day. items: type: object properties: day: type: number description: 0(Monday), 1(Tuesday), 2(Wednesday) and so on. workingHours: type: array items: type: object properties: startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) description: Working hours of the business isOpen: type: number description: 0 (Business closed today), 1 (open) comment: type: string description: Add the special instruction. specialHours: type: array description: Special hours of business. items: type: object properties: specialDate: type: string description: It should be "MM/DD/YYYY". startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) isOpen: type: number description: 0(Business closed today), 1 (open) businessStatus: type: string description: The business status on the listing page can be set to Open, Temporarily Closed, Permanently Closed, or Opening Soon. A Reopen Date is mandatory for 'Temporarily Closed' and 'Opening Soon' statuses, while optional for 'Open'. reopenDate: type: string description: Reopen Date is required for the 'Temporarily Closed' and 'Opening Soon' statuses, and optional for 'Open.' The date must be in the 'MM/dd/yyyy' format. services: type: string description: Services (Comma separated list of services offered; used for SEO). keywords: type: string description: Keywords about the business. Useful in SEO. Business keyword cannot be more than 1000 characters. products: type: string appointmentLink: type: string description: Let customers book appointments by redirecting them to your appointments page. reservationLink: type: string description: Let customers reserve tables by linking them to your reservations page. menuLink: type: string description: Show customers what you serve by linking them to your menu. orderAheadLink: type: string description: Let customers place delivery and pick-up orders by linking them to your ordering page. impressum: type: string description: In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence. payment: type: string description: Payment Type (Max 250 character long). localPhoneNumber: type: string description: Local phone number. tollFreePhoneNumber: type: string description: Tollfree number. androidAppURL: type: string description: Android app url. iosAppURL: type: string description: IOS app url. logoUrl: type: string description: 'Logo Image. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.' gmbLogoOptOut: type: number description: Update profile photo on your google my business page. (1-false,0-true). fbLogoOptOut: type: number description: Update profile photo on your facebook profile. (1-false,0-true). gmbCoverOptOut: type: number description: Update cover photo on your google my business page. (1-false,0-true). fbCoverOptOut: type: number description: Update cover photo on your facebook profile. (1-false,0-true). coverImageUrl: type: string description: 'Cover image URL for business displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1296 x 367px.' gmbCover: type: string description: Google Cover Image Url. facebookCover: type: string description: Facebook Cover Image Url. coverBusinessInfoLayout: type: string description: Show on your Birdeye profile. Possible value will be covidInfo: type: object properties: postDescription: type: string description: Post will be update on gmb & FB covid19SupportLink: type: string description: Should be a valid covid19 support url virtualCareLink: type: string description: Should be a valid url virtual care link description: Provide covid related update in. bingListing: type: object properties: primaryCategoryBing: type: string description: Primary category of bing. bingPhoneNumber: type: string description: You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set. categories: type: string description: You can add up to 3 categories. bingDescription: type: string description: Bing description cannot be more than 4096 characters. description: Provide bing data for listing purpose. internalListing: type: object properties: description: type: string description: Business description cannot be more than 5000 characters. category: type: string description: Primary category of business. subcategory: type: string description: You can add up to 3 subcategories. displayCategory: type: string description: Choose one of the category either from primary category or from sub categories. required: - category - subcategory description: Provide data for microsite listing purpose. facebookListing: type: object properties: category: type: string description: You can add up to 3 categories. facebookDescription: type: string description: Facebook description cannot be more than 255 characters. facebookPhoneNumber: type: string description: Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page description: Provide data for facebook listing purpose. gmbListing: type: object properties: googleWebsiteUrl: type: string description: Website url will update on google listing. googlePhoneNumber: type: string description: You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set. googleStoreId: type: string description: Store id for google. primaryCategoryGmb: type: string description: Primary category of google. additionalCategory: type: string description: You can add up to 9 subcategories. googleDescription: type: string description: Google description cannot be more than 750 characters. attributes: type: object properties: {} description: Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are foodDelivery: type: string description: Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com foodTakeout: type: string description: 'Enter the redirect URL where customers can place ''takeout'' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com' description: Provide data for gmb listing purpose. socialProfileURLs: type: object properties: facebookUrl: type: string description: Facebook URL. twitterUrl: type: string description: Business Twitter URL. linkedInUrl: type: string description: Business LinkedId URL. googleUrl: type: string description: Business Google URL. youTubeUrl: type: string description: Business Youtube URL. description: Profile URLs for business on top rated social sites isSEOEnabled: type: boolean description: Enable/Disbale search engine indexing of business profile. Valid values are "true","false". Default is "true". externalReferenceId: type: string description: It should be a unique value for location identifier. customFields: type: object properties: type: type: string description: Type of field. fieldValue: type: string description: Custom field value. fieldName: type: string description: Name of custom field (Make sure to enter the same fieldName or else the new field will be created). id: type: number description: fieldId of the custom field created earlier. required: - fieldName - id description: Custom Field To be Updated entityCategory: type: string description: 'Specifies the category of the business entity being created or updated. Valid values are:' required: - emailId - phone - services Apiary_getChildBusinesses_Response200: type: array items: type: object properties: id: type: number description: Id of the Business name: type: string description: Name of the Business/Product (Max 1000 character long). alias: type: string description: Alias, Your internal way of identifying this location. phone: type: string description: Business Phone (Required) Format is (xxx) xxx-xxxx. address: type: object properties: address1: type: string description: Address of the business. address2: type: string description: Address of the business. subLocality: type: string description: "(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system." city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. required: - zip description: Business address status: type: string description: Business status. Valid values are demo, active, inactive. Default is type: type: string description: 'Business type. Valid values are "Business, Enterprise-Location, Enterprise-Product, Reseller or a existing custom hierarchy type". Default is:' createdOn: type: string description: Business singup date. createdBy: type: string description: Full name of the user who created the business (or location). childCount: type: number description: 'Child account count. note: applicable only for Reseller, Enterprise-Location, Enterprise-Product.' Apiary_updatePublicProfileOfBusinesses_Request: type: object properties: profileTabs: type: array items: type: object properties: tabType: type: string description: Valid values are "Reviews", "Feedback", "FAQ", "Aboutus", "Map", "Appointment" or "BusinessOwner". label: type: string description: Name on the tab. Max length 30 character. showOnProfile: type: number description: Show on profile Valid values "0" or "1". showOnWebsite: type: number description: Show on website Valid values "0" or "1". showOnFacebook: type: number description: Show on Facebook Valid values "0" or "1". url: type: string description: Valid url for tab. required: - tabType - showOnProfile - showOnWebsite - showOnFacebook example: profileTabs: - tabType: map label: map location showOnProfile: 0 showOnWebsite: 1 showOnFacebook: 1 url: http://www.mapurl.com - tabType: Feedback label: Feedback showOnProfile: 0 showOnWebsite: 1 showOnFacebook: 1 url: http://www.feedback.com Apiary_getCustomCardDetails_Response200: type: object properties: customCardDetails: type: array items: type: object properties: cardId: type: number description: Id of the Card title: type: string description: Name of the card. description: type: string description: Information of the business on the card. imageURL: type: string description: Image URL imagePosition: type: string description: 'Image position value. Possible values are:' isVisible: type: number description: 'Visibility status of card on the microsite. Possible values are:' clickURL: type: string description: Redirect link for a particular website. linkText: type: string description: Enter the text you want displayed for the link. Apiary_updateCustomCard_Request: type: object properties: cardId: type: number description: Id of the custom card to update. title: type: string description: Title shown on the custom card. description: type: string description: Description/content shown on the custom card. imageURL: type: string description: Public image URL displayed on the card. imagePosition: type: string description: 'Image position value. Possible values are:' isVisible: type: number description: 'Visibility status of card on the microsite. Possible values are:' isPinOnTop: type: number description: Pin status of card on the microsite. clickURL: type: string description: Redirect URL for card click action. linkText: type: string description: Text displayed for the link. type: type: string description: Type/category of the custom card. required: - cardId - title example: cardId: 14744 title: title description: desc imageURL: https://d1py4eyp5hehj0.cloudfront.net/upload/1475208/1737886366109/Screenshot20250109040058.png imagePosition: '1' isVisible: 1 isPinOnTop: 1 clickURL: https://www.google.com/ linkText: '' type: Link type Apiary_getTimezoneList_Response200: type: object properties: timezones: type: array items: type: object properties: value: type: number description: The timezone value. label: type: string description: The timezone label. Apiary_getBirdeyeImpressions_Request: type: object properties: businessNumbers: type: string description: 'list of the unique business ids associated with a business eg: [123456789, 987656789]' startDate: type: string description: 'yyyy-MM-dd eg: "2020-11-10"' endDate: type: string description: 'yyyy-MM-dd eg: "2020-11-10"' limit: type: number description: 'page size. default: 25' startIndex: type: number description: 'default: 0' sortby: type: string description: '"location" or "total" default: total.' order: type: string description: '"asc" or "desc" default: desc' required: - businessNumbers - startDate - endDate example: businessNumbers: - 147286063579104 - 147286063579108 startDate: 2022-11-23 endDate: 2023-11-23 limit: 5 order: desc sortby: location startIndex: 0 Apiary_create_Request: type: object properties: defaultValue: type: string description: Default Value of custom field. dropDownOptions: type: array description: The list of options in custom field. items: {} fieldDescription: type: string description: Description of custom field. fieldName: type: string description: Name of custom field. filterable: type: boolean description: 'Whether the custom field will be filterable or not. Default: false' type: type: string description: Type of custom field. required: - fieldName - type example: defaultValue: Green dropDownOptions: - Blue - Green - Red fieldDescription: This custom field contains list of colours fieldName: colours filterable: 'false' type: DROPDOWN_MULTI Apiary_update_Request: type: object properties: defaultValue: type: string description: Default Value of custom field. dropDownOptions: type: array description: The list of options in custom field.The list of options in custom field items: {} fieldDescription: type: string description: Description of custom field. filterable: type: boolean description: Whether the custom field will be filterable or not. isHidden: type: boolean description: Whether the custom field will be hidden or not. example: defaultValue: Green dropDownOptions: - Blue - Green - Red fieldDescription: This custom field contains list of colours filterable: 'false' isHidden: 'false' Apiary_createUser_Request: type: object properties: firstName: type: string description: First name of the user. lastName: type: string description: Last name of the user. userEmailId: type: string description: Email Id of the user that’s being added to this business. phone: type: string description: Mobile number of the user. userRole: type: string description: User role. Valid values are "owner","admin". Default is "owner". sendInvite: type: boolean description: Whether to send invite email to the user. Default is `true`. required: - userEmailId - userRole example: firstName: Rhonda lastName: Spears userEmailId: rhonda.spears@example.com phone: 408-xxx-xxxx userRole: owner sendInvite: true Apiary_updateUser_Request: type: object properties: locationsNumberAccess: type: array description: Location Numbers list of which the user has access. Must provide full list each time, empty list grants access to all locations. items: {} user: type: object properties: firstName: type: string description: First name of the user. lastName: type: string description: The last name of the user. description: user details userRole: type: string description: Role to assign within the application. notification: type: object properties: sendReviewEmailAlert: type: number description: Flag to enable sending of review email alerts. sendDailyReviewDigest: type: number description: Flag to enable sending of daily review summary emails. dailyDigestAbsoluteTime: type: string description: Daily digest delivery time in HH:MM format. dailyDigestRunHour: type: number description: Hour component when daily digest is executed. dailyDigestRunMinute: type: number description: Minute component when daily digest is executed. sendWeeklyReviewDigest: type: number description: Flag to enable sending of weekly review summary emails. weeklyDigestAbsoluteTime: type: string description: Weekly digest delivery time in HH:MM format. weeklyDigestRunDay: type: number description: Day of the week for executing the weekly digest (0=Sunday). weeklyDigestRunHour: type: number description: Hour component when weekly digest is executed. weeklyDigestRunMinute: type: number description: Minute component when weekly digest is executed. sendReviewSmsAlert: type: number description: Flag to enable sending of review SMS alerts. sendDailySocialDigest: type: number description: Flag to enable sending of daily social media digests. sendTicketAlert: type: number description: Flag to enable sending of alerts when a new ticket is created. sendTicketStatusAlert: type: number description: Flag to enable sending of alerts when a ticket status changes. sendTicketAssigneeChangeAlert: type: number description: Flag to enable sending of alerts when ticket assignee changes. sendTicketCommentAlert: type: number description: Flag to enable sending of alerts when comments are added to tickets. sendTicketStartOrStoppedWatchingAlert: type: number description: Flag to enable sending of alerts when watching status changes for tickets. sendSurveyAlert: type: number description: Flag to enable sending of survey invitation alerts. sendReferralAlert: type: number description: Flag to enable sending of referral alerts. sendScanToolSignUpAlert: type: number description: Flag to enable sending of scan tool signup alerts. webChatEmailInterval: type: string description: Interval for web chat email notifications (e.g., "15,M"). webChatEmailAbsoluteTime: type: string description: Absolute time for web chat email notifications in HH:MM format. enableWebchat: type: number description: Flag to enable web chat notifications. enableTeamAlert: type: number description: Flag to enable team-wide alerts. reviewAlertRatings: type: array description: Array of review ratings that trigger alerts. items: {} messengerEmailConversationType: type: string description: Comma-separated conversation types for messenger email notifications. assignedToMeAlert: type: number description: Flag to enable alerts for items assigned to the current user. enableBrowserNotification: type: number description: Flag to enable browser push notifications. messengerReportEnable: type: number description: Flag to enable messenger report feature. appointmentBooking: type: number description: Flag to enable in-app appointment booking feature. appointmentFormsEnabled: type: number description: Flag to enable appointment forms. enableAIPostSuggestions: type: number description: Flag to enable AI-driven post suggestions. enablePostFailureEmail: type: number description: Flag to enable email alerts for post failures. enableDirectMessageEmail: type: number description: Flag to enable email alerts for direct messages. enablePostCommentsEmail: type: number description: Flag to enable email alerts for post comments. enableMentionsEmail: type: number description: Flag to enable email alerts when the user is mentioned. enableStoryMentionsEmail: type: number description: Flag to enable email alerts for story mentions. enableNewFollowersEmail: type: number description: Flag to enable email alerts for new followers. enableRetweetEmail: type: number description: Flag to enable email alerts when a post is retweeted. enableQuoteTweetEmail: type: number description: Flag to enable email alerts for quote tweets. enablePostFailureBrowserNotification: type: number description: Flag to enable browser notifications for post failures. paymentAlert: type: number description: Flag to enable payment-related alerts. sendBrokenIntegrationAlert: type: number description: Flag to enable in-app alerts for broken integrations. sendBrokenIntegrationEmail: type: number description: Flag to enable email alerts for broken integrations. description: user details Apiary_getReviews_Response200: type: array items: type: object properties: reviewId: type: number description: Id of the review. rating: type: number description: Overall rating for the review, in case of direct feedback and facebook recommendations it will be 0. For Facebook recommendations, value will be 1, Non recommended review will have value set as 0. comments: type: string description: User comment. reviewer: type: object properties: firstName: type: string description: Reviewer first name. lastName: type: string description: Reviewer last name. nickName: type: string description: Reviewer full name. thumbnailUrl: type: string description: Thumbnail URL description: Reviewer details sourceType: type: string description: Source of the review if it is an aggregated review. reviewURL: type: string description: Review url reviewDate: type: string description: Review posted date. response: type: string description: Review response text. responseDate: type: string description: Response date. inlineReplyEnabled: type: boolean description: If true, you can post replies through the dashboard. enableReply: type: boolean description: Whether a review reply is supported via Birdeye API or not. customerId: type: number description: Customer's Id attributed with this review (if any). extraParams: type: object description: Key value pair of custom field(s) associated with the customer attributed to the review (if any) assitedByUser: type: object properties: firstName: type: string description: Employee first name. lastName: type: string description: Employee last name. emailId: type: string description: Employee email id. phoneNum: type: string description: Employee phone number. description: Employees associated with the review Apiary_archivedGetReviews_Request: type: object properties: businessNumbers: description: List of business numbers to filter the report. If empty, all accessible business numbers are considered. type: array items: {} startDate: type: number description: Review Start date in milliseconds, pass epoch timestamp. endDate: type: number description: Review End date in milliseconds, pass epoch timestamp. sourceAlias: type: array description: List of review source aliases to include. items: {} deleteStartDate: type: number description: Review deletion start date in milliseconds, pass epoch timestamp. deleteEndDate: type: number description: Review deletion end date in milliseconds, pass epoch timestamp. ratings: type: array description: Review ratings to filter. Possible values are `0,1,2,3,4,5`. items: {} statuses: type: array description: Review status filter. Valid values are "published", "parked". If omitted, default is "published" only (featured reviews). "published" refers to featured reviews and "parked" refers to non-featured reviews. items: {} searchStr: type: string description: Free-text search term for review content. example: businessNumbers: [] startDate: 1712986782000 endDate: 1715578782000 sourceAlias: - google - facebook deleteStartDate: 1712986782000 deleteEndDate: 1715578782000 ratings: - 4 - 5 statuses: - published - parked searchStr: great service Apiary_archivedGetReviews_Response200: type: array items: type: object properties: reviewId: type: string description: Unique identifier of the archived review. rating: type: number description: Rating given in the review. comments: type: string description: Review comment text. recommended: type: number description: Recommendation flag for supported sources. status: type: string description: Review status label returned for the review record. reviewer: type: object properties: firstName: type: string description: Reviewer's first name, if available. lastName: type: string description: Reviewer's last name, if available. nickName: type: string description: Reviewer's display name, if available. thumbnailUrl: type: string description: Reviewer's profile image URL. description: Reviewer details. sourceType: type: string description: Human-readable source name. reviewDate: type: string description: Review creation date. rDate: type: number description: Review creation timestamp in milliseconds. archiveDate: type: string description: Date when the review was archived. deleteDate: type: string description: Date when the review will be deleted from archive. response: type: string description: Business response text, if available. responseDate: type: string description: Business response date, if available. businessId: type: string description: Business identifier linked to the review. businessName: type: string description: Business name linked to the review. businessType: type: string description: Business type linked to the review. customerId: type: number description: Customer identifier mapped to the review, if available. medias: type: array items: type: object properties: url: type: string description: Media URL. thumbnailUrl: type: string description: Thumbnail URL. type: type: string description: Media type. description: Media attached to the review. Apiary_getReviewsSummary_Response200: type: object properties: sources: type: array description: Source detail list. items: type: object properties: sourceName: type: string description: Name of the source. sourceAlias: type: string description: Alias of the source. avgRating: type: number description: Average rating of the source. reviewCount: type: number description: Total number of reviews. ratings: type: array items: type: object properties: rating: type: number enum: - 5 description: Review Rating. reviewCount: type: number enum: - 140 description: Number of reviews according to rating. required: - rating - reviewCount additionalProperties: false description: Review count against each possible review rating. required: - ratings Apiary_assignTagsToFilteredReviews_Request: type: object properties: reviewIds: type: array items: {} description: List of reviewIds. fromDate: type: string description: Review Start date format MM/dd/YYYY. toDate: type: string description: Review End date format MM/dd/YYYY. updateFromDate: type: string description: Review update from date format MM/dd/YYYY. updateToDate: type: string description: Review update end date format MM/dd/YYYY. sources: type: string description: List of sources. ratings: type: string description: List of Review Ratings. keywords: type: string description: List Review keywords. searchStr: type: string description: Search string. subBusinessIds: type: string description: List of location numbers. example: reviewIds: - '3901784402334' - '3901744402337' - '3902344402875' fromDate: 04/01/2013 toDate: 05/3/2015 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 keywords: - water searchStr: Awesome subBusinessIds: - 134387654345 - 134387654346 - 13438765437 Apiary_removeTagsFromFilteredReviews_Request: type: object properties: reviewIds: type: array items: {} description: List of reviewIds. fromDate: type: string description: Review Start date format MM/dd/YYYY. toDate: type: string description: Review End date format MM/dd/YYYY. updateFromDate: type: string description: Review update from date format MM/dd/YYYY. updateToDate: type: string description: Review update end date format MM/dd/YYYY. sources: type: string description: List of sources. ratings: type: string description: List of Review Ratings. keywords: type: string description: List Review keywords. searchStr: type: string description: Search string. subBusinessIds: type: string description: List of location numbers. example: reviewIds: - 3901784402334 - 3901744402337 fromDate: 04/01/2013 toDate: 05/3/2015 updateFromDate: 04/01/2013 updateToDate: 05/3/2015 sources: - google - citysearch ratings: - 1 - 2 - 3 - 4 - 5 - 0 keywords: - water searchStr: Awesome subBusinessIds: - 134387654345 - 134387654346 - 13438765437 Apiary_createOrUpdateContact_Request: type: object properties: id: type: string description: Id of enterprise customer. firstName: type: string description: First name of the customer. lastName: type: string description: Last name of the customer. email: type: string description: Email of customer, optional (if phone is provided). phone: type: string description: Phone of customer optional (if email is provided). countryCode: type: string description: Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI smsOptin: type: boolean description: SMS Opt flag. emailOptin: type: boolean description: Email Opt flag. blocked: type: boolean description: Contact block flag. businessIds: type: array description: Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained. items: {} tags: type: string description: List of tags. customFields: type: array description: List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no"). items: type: object properties: fieldName: type: string description: Field name. type: type: string description: Field type. fieldValue: type: string description: Value of field. externalId: type: string description: Unique external identifier of the contact which could be from the CRM or any external system storing your contacts. example: id: 115339282 firstName: Michael lastName: Scott email: michael@test.com phone: "(212) xxx-xxxx" countryCode: US emailOptin: true smsOptin: true blocked: false businessIds: - 161458406365307 - 161072537475129 tags: - Tag One - Tag Two customFields: - fieldName: Company type: text fieldValue: Dunder Mifflin - fieldName: Product type: text fieldValue: Paper externalId: ABC123 Apiary_getContact_Response200: type: object properties: id: type: string description: Id of enterprise customer. firstName: type: string description: First name of the customer. lastName: type: string description: Last name of the customer. email: type: string description: Email of customer, optional (if phone is provided). phone: type: string description: Phone of customer optional (if email is provided). countryCode: type: string description: Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI smsOptin: type: boolean description: SMS Opting flag. mappings: type: array description: List of locations where customer is mapped. If requested by cid, only that location's mapping is returned. items: type: object properties: cid: type: number description: Customer location id. location: type: string description: Name of the location. bid: type: number description: Location id. businessNumber: type: number description: Location Number. tags: type: string description: List of tags. customFields: type: array description: List of Custom fields. items: type: object properties: fieldName: type: string description: Field name. type: type: string description: Field type. fieldValue: type: string description: Value of field. externalId: type: string description: Unique external identifier of the contact which could be from the CRM or any external system storing your contacts. experienceScore: type: number description: Experience score of the customer. Returned only when experienceScore is true in the request. experienceScoreSource: type: string description: Source of the experience score (e.g. review, survey). Returned only when experienceScore is true in the request. Apiary_customerCheckin_Request: type: object properties: name: type: string description: Name of the customer. emailId: type: string description: Email ID of the customer (optional If business has enabled for sms, then either email or phone will be required). phone: type: string description: Phone number of the customer (optional If business has enabled for sms, then either email or phone will be required). smsEnabled: type: number description: Whether customer has opted to receive SMS request or not. Valid values are 0(false), 1(true). Default is 1. additionalParams: type: object properties: {} description: Custom tags can be added as key value pair. employees: type: array items: type: object properties: emailId: type: string description: Email Id of assisted Employee. externalId: type: string description: Unique external identifier of the contact which could be from the CRM or any external system storing your contacts. example: name: Steve Smith emailId: steves@abcd.com phone: 408-xxx-xxxx smsEnabled: 1 additionalParams: Tag Group Name 1: Tag Name 1 Tag Group Name 2: Tag Name 2 location: New York employees: - emailId: sshikha@abcd.com externalId: ABC123 Apiary_customerActivityLog_Response200: type: array items: type: object properties: type: type: string description: Activity Type. activityDate: type: string description: Activity Type. action: type: string description: Action performed on the activity type. activityTimestamp: type: number description: Epoc activity timestamp. Apiary_subscribeUnsubscribeCustomer_Request: type: object properties: permission: type: string description: Action to be taken. Valid values are both-subscribed, both-unsubscribed, sms-subscribed, and email-subscribed. email: type: array description: Customer email ids. items: {} phone: type: array description: Customer phone numbers. items: {} accountNumber: type: number description: Location id. required: - accountNumber - permission example: permission: both-unsubscribed email: - test1@mail.in phone: - '2345654326' accountNumber: 123456789876543 Apiary_contact_Response200: type: object properties: page: type: number description: The page number. size: type: number description: Maximum number of contacts return in response. totalPages: type: number description: Number of pages to query. totalCount: type: number description: Number of contacts to query. customers: type: array description: Customer list items: type: object properties: customerId: type: number description: Id of enterprise customer. name: type: string description: Name of enterprise customer. email: type: string description: Email Id of enterprise customer. phone: type: string description: Phone number of enterprise customer. lastActivityWithTime: type: string description: Last activity time. Apiary_customerOrLeadList_Response200: type: object properties: page: type: number description: Page number to request. size: type: number description: Number of records per page. totalPages: type: number description: Total number of pages. contacts: type: array description: Contact details items: type: object properties: firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. email: type: string description: Email Id of the contact. phone: type: string description: Phone number of the contact. created: type: string description: 01-06T22:25:12.000+0000 (string) - Created date of the contact. contactType: type: string description: Contact type. source: type: string description: Source of the customer/lead. mappings: type: array items: type: object properties: businessId: type: number description: Business number of the location. customerId: type: number description: Id of the customer. description: Locations customer/lead is associated with Apiary_getOptOutContactData_Response200: type: object properties: emailOptOut: type: array description: All the contacts grouped under this field, which were opted out from email in the given duration items: type: object properties: id: type: number description: id of the enterprise customer. firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. emailId: type: string description: EmailId of the contact, if exists. phone: type: string description: Phone number of the contact, if exists. Format is (xxx) xxx-xxxx. textOptOut: type: array description: All the contacts grouped under this field, which were opted out from text in the given duration items: type: object properties: id: type: number description: id of the enterprise customer. firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. emailId: type: string description: EmailId of the contact, if exists. phone: type: string description: Phone number of the contact, if exists. Format is (xxx) xxx-xxxx. blocked: type: array description: All the contacts grouped under this field, which were blockedl in the given duration. items: type: object properties: id: type: number description: id of the enterprise customer. firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. emailId: type: string description: EmailId of the contact, if exists. phone: type: string description: Phone number of the contact, if exists. Format is (xxx) xxx-xxxx. Apiary_upsertContact_Request: type: object properties: id: type: string description: Id of enterprise customer. firstName: type: string description: First name of the customer. lastName: type: string description: Last name of the customer. email: type: string description: Email of customer, optional (if phone is provided). phone: type: string description: Phone of customer optional (if email is provided). countryCode: type: string description: Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI smsOptin: type: boolean description: SMS Opt flag. blocked: type: boolean description: Contact block flag. businessIds: type: array description: Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained. items: {} tags: type: array description: List of tags items: {} customFields: type: array description: List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no"). items: type: object properties: fieldName: type: string description: Field name. type: type: string description: Field type. fieldValue: type: string description: Value of field. externalId: type: string description: Unique external identifier of the contact which could be from the CRM or any external system storing your contacts. emailPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: Email communication preference flags. smsPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: SMS communication preference flags. example: id: 115339282 firstName: Michael lastName: Scott email: michael@test.com phone: "(212) xxx-xxxx" countryCode: US smsOptin: true blocked: false businessIds: - 161458406365307 - 161072537475129 tags: - Tag One - Tag Two customFields: - fieldName: Company type: text fieldValue: Dunder Mifflin - fieldName: Product type: text fieldValue: Paper externalId: ABC123 emailPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true smsPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true Apiary_retrieveContact_Response200: type: object properties: id: type: string description: Id of enterprise customer. firstName: type: string description: First name of the customer. lastName: type: string description: Last name of the customer. email: type: string description: Email of customer, optional (if phone is provided). phone: type: string description: Phone of customer optional (if email is provided). countryCode: type: string description: Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI smsOptin: type: boolean description: SMS Opting flag. mappings: type: array description: List of locations where customer is mapped. If requested by cid, only that location's mapping is returned. items: type: object properties: cid: type: number description: Customer location id. location: type: string description: Name of the location. bid: type: number description: Location id. businessNumber: type: number description: Location Number. tags: type: string description: List of tags. customFields: type: array description: List of Custom fields. items: type: object properties: fieldName: type: string description: Field name. type: type: string description: Field type. fieldValue: type: string description: Value of field. externalId: type: string description: Unique external identifier of the contact which could be from the CRM or any external system storing your contacts. emailPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: Email communication preference flags. smsPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: SMS communication preference flags. Apiary_customerCheckinPost_Request: type: object properties: name: type: string description: Name of the customer. emailId: type: string description: Email ID of the customer (optional If business has enabled for sms, then either email or phone will be required). phone: type: string description: Phone number of the customer (optional If business has enabled for sms, then either email or phone will be required). smsEnabled: type: number description: Whether customer has opted to receive SMS request or not. Valid values are 0(false), 1(true). Default is 1. additionalParams: type: object properties: {} description: Custom tags can be added as key value pair. employees: type: array items: type: object properties: emailId: type: string description: Email Id of assisted Employee. externalId: type: string description: Unique external identifier of the contact which could be from the CRM or any external system storing your contacts. emailPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: Email communication preference flags. smsPreferences: type: object properties: marketingOptin: type: boolean description: Marketing communication. feedbackOptin: type: boolean description: Feedback communication. serviceOptin: type: boolean description: Service communication. description: SMS communication preference flags. example: name: Steve Smith emailId: steves@abcd.com phone: 408-xxx-xxxx smsEnabled: 1 additionalParams: Tag Group Name 1: Tag Name 1 Tag Group Name 2: Tag Name 2 location: New York employees: - emailId: sshikha@abcd.com externalId: ABC123 emailPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true smsPreferences: marketingOptin: true feedbackOptin: true serviceOptin: true Apiary_retrieveOptedOutContacts_Response200: type: object properties: emailOptOut: type: array description: All the contacts grouped under this field, which were opted out from email in the given duration items: type: object properties: id: type: number description: id of the enterprise customer. firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. emailId: type: string description: EmailId of the contact, if exists. phone: type: string description: Phone number of the contact, if exists. Format is (xxx) xxx-xxxx. optOutFrom: type: array items: {} description: Categories from which the contact has opted out (e.g., marketing, feedback, service). textOptOut: type: array description: All the contacts grouped under this field, which were opted out from text in the given duration items: type: object properties: id: type: number description: id of the enterprise customer. firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. emailId: type: string description: EmailId of the contact, if exists. phone: type: string description: Phone number of the contact, if exists. Format is (xxx) xxx-xxxx. optOutFrom: type: array items: {} description: Categories from which the contact has opted out (e.g., marketing, feedback, service). blocked: type: array description: All the contacts grouped under this field, which were blockedl in the given duration. items: type: object properties: id: type: number description: id of the enterprise customer. firstName: type: string description: First name of the contact. lastName: type: string description: Last name of the contact. emailId: type: string description: EmailId of the contact, if exists. phone: type: string description: Phone number of the contact, if exists. Format is (xxx) xxx-xxxx. optOutFrom: type: array items: {} description: Categories from which the contact has opted out (e.g., marketing, feedback, service). Apiary_getAllAggregationSource_Response200: type: array items: type: object properties: id: type: number description: Id of aggregation. sourceAlias: type: string description: Source alias. sourceUrl: type: string description: Source url. sourceName: type: string description: Source name. status: type: number description: 'This field indicates the status of aggregation:' Apiary_addAggregationUrl_Request: type: object properties: sourceAlias: type: string description: Source alias. url: type: string description: Source url to be added. required: - sourceAlias - url example: &1 sourceAlias: 'citysearch ' url: http://www.citysearch.com/biz/maria-da-vittorio-san-francisco Apiary_addAggregationUrl_Response200: type: object properties: id: type: number description: Id of the created Aggregation. sourceAlias: type: string description: Alias of the source. sourceName: type: string description: Name of the source. sourceUrl: type: string description: Url of the souce. Body: type: string description: |- { "id": "237030543", "sourceAlias": "citysearch", "sourceName": "Citysearch", "sourceUrl": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco" } Apiary_getReviewConversionReport_Response200: type: object properties: emailSentInfo: type: object properties: total: type: number description: Total number of email send. emailDetails: type: array description: Details of email. items: type: object properties: reqType: type: string description: Type of request, Values could be share_request, share_request_reminder,review_request,review_request_reminder. count: type: number description: Number of request send. description: Email sent details. emailOpenInfo: type: object properties: total: type: number description: Total number of email opened. pc: type: number description: Total number of email opened on PC. mobile: type: object properties: ios: type: number description: IOS android: type: number description: Anroid other: type: number description: Others description: Total number of email opened on Mobile device. tablet: type: object properties: ios: type: number description: IOS android: type: number description: Anroid other: type: number description: Others description: Total number of email opened on Tablet device. description: Email open details. emailClickInfo: type: array description: Email click details. items: type: object properties: total: type: number description: Total number of email clicked. pc: type: array items: type: object properties: citysearch: type: number description: Email click on citysearch. google: type: number description: Email click on google. birdeye: type: number description: Email click on birdeye. otherSites: type: number description: Email click on otherSites. description: Total number of email clicked on PC. reviews: type: array description: Review details items: type: object properties: sourceName: type: string description: Source name sourceAlias: type: string description: Souce alias avgRating: type: number description: Average rating reviewCount: type: number description: Review count smsDetail: type: object properties: msgSent: type: number description: Total number of SMS sent. msgClick: type: number description: Total number of SMS clicked. destination: type: array items: type: object properties: citysearch: type: number description: Number of click on citysearch. google: type: number description: Number of click on google. birdeye: type: number description: Number of click on birdeye. otherSites: type: number description: Number of click on otherSites. description: SMS details. Apiary_reviewAndRatingOverTimeReport_Response200: type: array items: type: object properties: rating: type: number description: Average Rating for the particular day. count: type: number description: Number of reviews for the particular day. milestone: type: string description: Date. Apiary_reviewCount_Rating_Response200: type: object properties: reviewCount: type: number description: Total number of reviews. countByRating: type: array description: Review count against each possible review rating. For Facebook recommended and non-recommended reviews rating will be 0. items: type: object properties: rating: type: number description: Review Rating. count: type: number description: Number of reviews according to rating. Apiary_reviewCount_RatingByEmployee_Request: type: object properties: businessNumbers: type: array description: Business Numbers under enterprise account. items: {} sourceAlias: type: string description: Alias of the source. fromDate: type: string description: Review date (start). toDate: type: string description: Review date (end). employees: type: array description: Employee details for which review count will be fetched. items: type: object properties: firstName: type: string description: Employee's first name. lastName: type: string description: Employee's last name. phone: type: string description: Employee's phone number. example: businessNumbers: - 145308764185002 - 145308769721320 sourceAlias: - google - citysearch employees: - firstName: David lastName: Wood phone: '4424242424' fromDate: 04/01/2013 toDate: 05/3/2015 Apiary_reviewCount_RatingByEmployee_Response200: type: object properties: employees: type: array description: Employee details for which review count will be fetched. items: type: object properties: employee: type: object properties: firstName: type: string description: Employee's first name. lastName: type: string description: Employee's last name. phone: type: string description: Employee's phone number. countByRating: type: array items: type: object properties: rating: type: number description: Review Rating. count: type: number description: Number of reviews according to rating. description: Review count against each possible review rating. For Facebook recommended and non-recommended reviews rating will be 0. firstName: type: string description: Employee's first name. lastName: type: string description: Employee's last name. phone: type: string description: Employee's phone number. Apiary_insightsCategoryReportByLocationReport_Response200: type: array items: type: object properties: alias: type: string description: Alias of the location. avgScore: type: number description: Average score of the keywords inside the category. grade: type: string description: Grade of the keywords. totalCount: type: number description: Total count of keyword present. metricForLocn: type: object properties: Category_Name: type: object properties: category: type: string description: Category name. avgScore: type: number description: Average score. count: type: number description: Count. grade: type: string description: Grade. parentCategory: type: string description: Parent category name. description: This will be the name of the category like Beverages. description: Location wise metric data. Apiary_competitiveRankingReport_Response200: type: object properties: positiveCount: type: number description: Number of positive keywords. neutralCount: type: number description: Number of neutral keywords. negativeCount: type: number description: Number of negative keywords.. positivePercent: type: number description: Positive keyword percentage. neutralPercent: type: number description: Neutral keyword percentage. negativePercent: type: number description: Negative keyword percentage. name: type: string description: Enterprise name. count: type: number description: Total Count. rating: type: number description: Average rating. competitors: type: array description: Competitors data. items: type: object properties: positiveCount: type: number description: Number of positive keywords. neutralCount: type: number description: Number of neutral keywords. negativeCount: type: number description: Number of negative keywords.. positivePercent: type: number description: Positive keyword percentage. neutralPercent: type: number description: Neutral keyword percentage. negativePercent: type: number description: Negative keyword percentage. name: type: string description: Enterprise name. count: type: number description: Total count. rating: type: number description: Average rating. Apiary_nPSOverTimeReport_Response200: type: object properties: totalCount: type: number description: Total number of promoters, passives, and detractors. avgNpsScore: type: number description: Average NPS score. promoters: type: number description: Total number of promoters. passives: type: number description: Total number of passives. detractors: type: number description: Total number of detractors. dataPoints: type: array description: Data points. items: type: object properties: nodeId: type: number description: Node Id. label: type: string description: Label. shortLabel: type: string description: Short Label. startDate: type: string description: Start date. endDate: type: string description: End date. totalCount: type: number description: Count. detractorPercentile: type: number description: Detractor Percentile. passivePercentile: type: number description: Passive Percentile. npsScore: type: number description: Average NPS Score. positiveCount: type: number description: Positive Count. negativeCount: type: number description: Negative Count. neutralCount: type: number description: Neutral Count. groupByType: type: string description: Grouping by. dateDiff: type: number description: Date difference. Apiary_nPSByLocationReport_Response200: type: object properties: totalCount: type: number description: Total number of promoters, passives, and detractors. avgNpsScore: type: number description: Average NPS score. promoters: type: number description: Total number of promoters. passives: type: number description: Total number of passives. detractors: type: number description: Total number of detractors. dataPoints: type: array description: Data points. items: type: object properties: nodeId: type: number description: Node Id. label: type: string description: Location Name. detractorPercentile: type: number description: Detractor Percentile. passivePercentile: type: number description: Passive Percentile. promoterPercentile: type: number description: Promoter Percentile. npsScore: type: number description: Average NPS Score. positiveCount: type: number description: Positive Count. negativeCount: type: number description: Negative Count. neutralCount: type: number description: Neutral Count. totalCount: type: number description: Total Count. businessNumber: type: number description: Business number of the location groupByType: type: string description: Grouping by. dateDiff: type: number description: Date difference. totalPages: type: number description: Total number of pages. page: type: number description: Current Page. size: type: number description: Size. Apiary_reviewBySourceReport_Response200: type: array items: type: object properties: count: type: number description: Number of reviews for the particular location. milestone: type: string description: Name of the Location. businessId: type: number description: Business number of the location. reviewSites: type: array items: type: object properties: sourceAlias: type: string description: Source alias. count: type: number description: Number of reviews in sources. description: List of source Alias. Apiary_visitorReport_Response200: type: array items: type: object properties: count: type: number description: Number of visitor for the particular locations. milestone: type: string description: Name of the Location. businessId: type: number description: Business number of the location. visitors: type: array items: type: object properties: sourceAlias: type: string description: Source alias. count: type: number description: Number of visits at source side. description: Visitor data. Apiary_reviewResponseRateOverTime_Response200: type: object properties: summary: type: object properties: actual: type: object properties: totalCount: type: number description: Total number of reviews in selected period. avgRating: type: number description: Average rating in selected period. responseRate: type: number description: Response rate percentage. unrespondedRate: type: number description: Unresponded rate percentage. unrespondedCount: type: number description: Count of unresponded reviews. respondedCount: type: number description: Count of responded reviews. unrespondedCountGrowth: type: number description: Growth percentage against comparison period. respondedCountGrowth: type: number description: Growth percentage against comparison period. totalCountGrowth: type: number description: Growth percentage against comparison period. responseRateGrowth: type: number description: Growth percentage against comparison period. compare: type: object properties: totalCount: type: number description: Total number of reviews in comparison period. avgRating: type: number description: Average rating in comparison period. responseRate: type: number description: Response rate percentage in comparison period. unrespondedRate: type: number description: Unresponded rate percentage in comparison period. unrespondedCount: type: number description: Count of unresponded reviews in comparison period. respondedCount: type: number description: Count of responded reviews in comparison period. dataPoints: type: array description: Time-series points for actual and comparison periods. items: type: object properties: actual: type: object properties: label: type: string items: {} description: Display label for the bucket. shortLabel: type: string description: Short display label. totalCount: type: number description: Total reviews in the bucket. startDate: type: string description: Bucket start date. endDate: type: string description: Bucket end date. responseRate: type: number description: Response rate percentage. unrespondedCount: type: number description: Unresponded review count. respondedCount: type: number description: Responded review count. respondedCountGrowth: type: number description: Growth percentage. totalCountGrowth: type: number description: Growth percentage. responseRateGrowth: type: number description: Growth percentage. compare: type: object properties: label: type: string items: {} description: Comparison label for the bucket. shortLabel: type: string description: Short comparison label. totalCount: type: number description: Comparison total reviews in the bucket. startDate: type: string description: Comparison bucket start date. endDate: type: string description: Comparison bucket end date. responseRate: type: number description: Comparison response rate percentage. unrespondedCount: type: number description: Comparison unresponded review count. respondedCount: type: number description: Comparison responded review count. dateDiff: type: number description: Date range difference. groupByType: type: string description: Grouping unit used in data points. dataPresent: type: boolean description: Indicates whether report data is present. Apiary_reviewResponseRateByLocationOverview_Response200: type: object properties: summary: type: object properties: actual: type: object properties: totalCount: type: number description: Total number of reviews. responseRate: type: number description: Response rate percentage. unrespondedRate: type: number description: Unresponded rate percentage. unrespondedCount: type: number description: Count of unresponded reviews. respondedCount: type: number description: Count of responded reviews. compare: type: object properties: totalCount: type: number description: Total number of reviews in comparison period. responseRate: type: number description: Response rate percentage in comparison period. unrespondedRate: type: number description: Unresponded rate percentage in comparison period. unrespondedCount: type: number description: Count of unresponded reviews in comparison period. respondedCount: type: number description: Count of responded reviews in comparison period. dataPoints: type: array description: Location-wise response-rate metrics. items: type: object properties: actual: type: object properties: label: type: string description: Location label. totalCount: type: number description: Total number of reviews for the location. responseRate: type: number description: Response rate percentage for the location. unrespondedRate: type: number description: Unresponded rate percentage for the location. unrespondedCount: type: number description: Count of unresponded reviews for the location. respondedCount: type: number description: Count of responded reviews for the location. businessNumber: type: number description: Business number of the location. compare: type: object properties: label: type: string description: Comparison location label. totalCount: type: number description: Comparison total number of reviews for the location. responseRate: type: number description: Comparison response rate percentage for the location. unrespondedRate: type: number description: Comparison unresponded rate percentage for the location. unrespondedCount: type: number description: Comparison unresponded reviews for the location. respondedCount: type: number description: Comparison responded reviews for the location. businessNumber: type: number description: Business number of the location. dataPresent: type: boolean description: Indicates whether report data is present. Apiary_averageResponseTimeByLocation_Response200: type: object properties: summary: type: object properties: actual: type: object properties: avgResponseTime: type: object properties: days: type: number description: Average response time in days. hours: type: number description: Average response time in hours. minutes: type: number description: Average response time in minutes. respondedCount: type: number description: Number of responded reviews. compare: type: object properties: avgResponseTime: type: object properties: days: type: number description: Average response time in days for comparison period. hours: type: number description: Average response time in hours for comparison period. minutes: type: number description: Average response time in minutes for comparison period. respondedCount: type: number description: Number of responded reviews in comparison period. dataPoints: type: array description: Location-wise average response-time metrics. items: type: object properties: actual: type: object properties: label: type: string description: Location label. avgResponseTime: type: object properties: days: type: number description: Average response time in days for the location. hours: type: number description: Average response time in hours for the location. minutes: type: number description: Average response time in minutes for the location. respondedCount: type: number description: Number of responded reviews for the location. businessNumber: type: number description: Business number of the location. compare: type: object properties: label: type: string description: Comparison location label. avgResponseTime: type: object properties: days: type: number description: Comparison average response time in days. hours: type: number description: Comparison average response time in hours. minutes: type: number description: Comparison average response time in minutes. respondedCount: type: number description: Comparison responded reviews for the location. businessNumber: type: number description: Business number of the location. dateDiff: type: number description: Date range difference. groupByType: type: string description: Grouping unit used in data points. dataPresent: type: boolean description: Indicates whether report data is present. Apiary_averageResponseTimeOverTime_Response200: type: object properties: summary: type: object properties: actual: type: object properties: avgResponseTime: type: object properties: days: type: number description: Average response time in days. hours: type: number description: Average response time in hours. minutes: type: number description: Average response time in minutes. respondedCount: type: number description: Number of responded reviews. compare: type: object properties: avgResponseTime: type: object properties: days: type: number description: Average response time in days for comparison period. hours: type: number description: Average response time in hours for comparison period. minutes: type: number description: Average response time in minutes for comparison period. respondedCount: type: number description: Number of responded reviews in comparison period. dataPoints: type: array description: Time-series data points with comparison period values. items: type: object properties: actual: type: object properties: label: type: string description: Display label for the bucket. shortLabel: type: string description: Short display label. startDate: type: string description: Bucket start date. endDate: type: string description: Bucket end date. avgResponseTime: type: object properties: days: type: number description: Average response time in days. hours: type: number description: Average response time in hours. minutes: type: number description: Average response time in minutes. respondedCount: type: number description: Number of responded reviews in the bucket. compare: type: object properties: label: type: string description: Comparison label for the bucket. shortLabel: type: string description: Short comparison label. startDate: type: string description: Comparison bucket start date. endDate: type: string description: Comparison bucket end date. avgResponseTime: type: object properties: days: type: number description: Comparison average response time in days. hours: type: number description: Comparison average response time in hours. minutes: type: number description: Comparison average response time in minutes. respondedCount: type: number description: Comparison responded reviews in the bucket. dateDiff: type: number description: Date range difference. groupByType: type: string description: Grouping unit used in data points. dataPresent: type: boolean description: Indicates whether report data is present. Apiary_getAllSurveys_Response200: type: array items: type: object properties: surveyId: type: number description: Survey Id. name: type: string description: Survey Name. status: type: string description: Survey status. created: type: number description: Survey created date in epoc. lastModified: type: number description: Survey last modified date in epoc responses: type: number description: Number of survey responses. questionCount: type: number description: Number of questions. Apiary_updateSurveySettings_Request: type: object properties: surveySettings: type: object properties: showSurveyTitle: type: boolean description: Pass true if want to show survey title. showQuestionNumber: type: boolean description: Pass true if want to show question number. showProgressBar: type: boolean description: Pass true if want to show progress bar. progressbarPosition: type: string description: Position of progress bar. showLogo: type: string description: Pass ON if want to show logo. showTitle: type: string description: Show title. customTitle: type: string description: Custom title value. themeColor: type: string description: Theme color value. themeTextColor: type: string description: Theme color text value. subject: type: string description: Subject of the survey email. message: type: string description: Thank you message.. signature: type: string description: Signature. enableThankyouEmail: type: boolean description: Pass true if want to enable Thank you email. description: Survey settings accessControl: type: object properties: userAccessList: type: array items: type: object properties: userEmail: type: string description: Email of the user. role: type: string description: User role. delete: type: boolean description: Delete status of the user. surveyAccess: type: object properties: role: type: string description: User's survey access. description: Access control data. example: surveySettings: showSurveyTitle: false showQuestionNumber: false showProgressBar: false progressbarPosition: Bottom showLogo: true showTitle: CUSTOM customTitle: Welcome to Tennessee! themeColor: "#1976d2" themeTextColor: "#ffffff" subject: Thank you for taking the survey message: |- Hi , Thank you for taking the time to give your inputs on the survey. signature: | Sincerely, BMW_Survey enableThankyouEmail: true accessControl: userAccessList: - userEmail: abc@test.com role: viewer - userEmail: def@test.com delete: true surveyAccess: role: editor Apiary_addMedia_Request: type: object properties: media: type: array description: List of media items to be uploaded. items: type: object properties: url: type: string description: Url of the media item. mediaCategory: type: string description: 'Category for the media item. Possible values are:' description: type: string description: Description of the media. mediaFormat: type: string description: 'Format of the Media. Possible values are:' required: - url - mediaCategory - description - mediaFormat required: - media example: media: - url: https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2 mediaCategory: TEAMS description: Image of the team mediaFormat: PHOTO - url: https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4 mediaCategory: ADDITIONAL description: Introductory video mediaFormat: VIDEO Apiary_addMedia_Response200: type: object required: - media properties: media: type: array items: type: object properties: mediaId: type: string description: Id of the media. url: type: string description: Url of the media item. mediaCategory: type: string description: Category for the media item. description: type: string description: Description of the media. mediaFormat: type: string description: Format of the Media. description: List of media items. Apiary_getMedia_Response200: type: object properties: media: type: array items: type: object properties: mediaId: type: string description: Id of the media. url: type: string description: Url of the media item. mediaCategory: type: string description: Category for the media item. description: type: string description: Description of the media. mediaFormat: type: string description: Format of the Media. description: List of media items of the business. Apiary_updateMedia_Request: type: object properties: mediaCategory: type: string description: 'Category for the media item. Possible values are:' required: - mediaCategory example: mediaCategory: INTERIOR Apiary_scheduleSocialPost_Request: type: object properties: text: type: string description: Input text that will be added in the post. Limits of characters across various Social Sites socialSite: type: string description: The social site where the post will be made. Possible values are properties: Error message: {} subBusinessNumbers: type: array description: List of Location Ids. Optional for SMB. items: {} scheduleTimestamp: type: number description: A Unix timestamp in milliseconds that represents the date and time when the post should be scheduled. If not provided, the post will be published after 5 minutes of posting. media: type: object properties: type: type: string description: An array of media objects, each containing the media type and the URL. Allowed media type are IMAGE, VIDEO and REEL. mediaUrl: type: string description: Media Link. Error message: type: string description: Media details. additionalMetaData: type: object properties: callToActionType: type: string description: Type of data. callToActionUrl: type: string description: Link of the additional data(Not required when CTA type is CALL). description: Additional metadata for the post, including a call to action (CTA). Applicable only for GOOGLEMYBUSINESS. required: - text - socialSite example: text: Check out the latest collection socialSite: GOOGLEMYBUSINESS subBusinessNumbers: - 123456780 - 123456781 scheduleTimestamp: 1677759962528 media: - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png additionalMetaData: callToActionType: LEARN_MORE callToActionUrl: https://app.birdeye.com/ Apiary_editScheduledSocialPost_Request: type: object properties: trackingId: type: string description: Tracking id received when post was created through public api. text: type: string description: Input text that will be added in the post. Limits of characters across various Social Sites socialSite: type: string description: The social site where the post will be edited. Possible values are properties: Error message: {} subBusinessNumbers: type: array description: List of location ids for which this post should be edited. items: {} scheduleTimestamp: type: number description: A Unix timestamp in milliseconds that represents the date and time when the post should be scheduled. If not provided, the post will have same schedule time as the original one. media: type: object properties: type: type: string description: An array of media objects, each containing the media type and the URL. Allowed media type are IMAGE, VIDEO and REEL. mediaUrl: type: string description: Media Link. Error message: type: string description: Media details. additionalMetaData: type: object properties: callToActionType: type: string description: Type of data. callToActionUrl: type: string description: Link of the additional data(Not required when CTA type is CALL). description: Additional metadata for the post, including a call to action (CTA). Applicable only for GOOGLEMYBUSINESS. required: - trackingId - text - socialSite - subBusinessNumbers example: trackingId: 4ece211b82162d1101d2d82a24876a92 text: Check out the latest collection socialSite: GOOGLEMYBUSINESS subBusinessNumbers: - 123456780 - 123456781 scheduleTimestamp: 1677759962528 media: - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png - type: IMAGE mediaUrl: https://upload.wikimedia.org/wikipedia/commons/5/53/Google_Logo.png additionalMetaData: callToActionType: LEARN_MORE callToActionUrl: https://app.birdeye.com/ Apiary_editPublishedSocialPost_Request: type: object properties: trackingId: type: string description: Tracking id received when post was created through public api. text: type: string description: Text to be updated for the post. Limits of characters across various Social Sites socialSite: type: string description: The social site where the post will be edited. Possible values are properties: Error message: {} subBusinessNumbers: type: array description: List of location ids for which this post should be edited. If list contains a location which is not part of the post, then no action will be taken for that location. items: {} required: - trackingId - text - socialSite - subBusinessNumbers example: trackingId: 4ece211b82162d1101d2d82a24876a92 text: Check out the latest collection socialSite: GOOGLEMYBUSINESS subBusinessNumbers: - 123456780 - 123456781 Apiary_trackSocialPost_Response200: type: object properties: trackingId: type: string description: The tracking ID of the scheduled or posted social post. accountNumber: type: string description: The account ID associated with the post. socialSite: type: string description: Social Sites. Possible values are subBusinessNumbers: type: array description: List of Location Ids. Optional for SMB. items: {} socialPostDetails: type: array description: An array of objects containing post details, including status, location name, and published timestamp. items: type: object properties: locationName: type: string description: The name of the location where the post was published. locationNumber: type: string description: The ID of the location where the post was published. status: type: object properties: status: type: string description: 'Post status. Possible values:' failureReason: type: string description: Failure reason if any. description: Post status details. publishedTimestamp: type: number description: The Unix timestamp (in milliseconds) when the post was published. socialSitePostId: type: string description: Social site post id. socialSitePostUrl: type: string description: Social site post link. Apiary_socialOpenUrlPerformanceReport_Request: type: object properties: startDate: type: string description: Start date in `MM/dd/YYYY` format. endDate: type: string description: End date in `MM/dd/YYYY` format. sourceNames: type: array description: List of social channels to include in the report. items: {} businessNumbers: description: List of business numbers to filter the report. If empty, all accessible business numbers are considered. type: array items: {} comparisonFilter: type: object properties: startDate: type: string description: Comparison start date in `MM/dd/YYYY` format. endDate: type: string description: Comparison end date in `MM/dd/YYYY` format. description: Comparison date range. page: type: number description: Page number for location-level data points. size: type: number description: Number of records per page. required: - startDate - endDate example: startDate: 02/03/2021 endDate: 02/10/2026 sourceNames: - Instagram - Tiktok - Facebook - Linkedin businessNumbers: [] comparisonFilter: startDate: 01/01/2020 endDate: 01/10/2020 page: 1 size: 50 Apiary_socialOpenUrlPerformanceReport_Response200: type: object properties: summary: type: object properties: actual: type: object properties: impressions: type: number description: Total impressions in selected period. engagements: type: number description: Total engagements in selected period. engRate: type: number description: Engagement rate in selected period. postCount: type: number description: Total post count in selected period. channelWiseData: type: object properties: {} description: Channel-level social metrics for selected period. totalRecords: type: number description: Total number of location-level records. postCountGrowthPercent: type: number description: Post count growth percentage against comparison period. engRateGrowthPercent: type: number description: Engagement rate growth percentage against comparison period. engagementGrowthPercent: type: number description: Engagement growth percentage against comparison period. compare: type: object properties: impressions: type: number description: Total impressions in comparison period. engagements: type: number description: Total engagements in comparison period. engRate: type: number description: Engagement rate in comparison period. postCount: type: number description: Total post count in comparison period. channelWiseData: type: object properties: {} description: Channel-level social metrics in comparison period. totalRecords: type: number description: Total number of location-level records in comparison period. dataPoints: type: array description: Location-level report data for actual and comparison periods. items: type: object properties: actual: type: object properties: label: type: string description: Location label. startDate: type: string description: Start date of the selected period. endDate: type: string description: End date of the selected period. locationId: type: number description: Location ID. businessNumber: type: number description: Business number of the location. externalReferenceId: type: string description: External reference ID of the location. channelWiseData: type: object description: Channel-level social metrics for the location. compare: type: object properties: label: type: string description: Location label. startDate: type: string description: Start date of the selected period. endDate: type: string description: End date of the selected period. locationId: type: number description: Location ID. businessNumber: type: number description: Business number of the location. externalReferenceId: type: string description: External reference ID of the location. channelWiseData: type: object description: Channel-level social metrics for the location. description: Comparison period metrics for the same location. Apiary_getDetailsOfEmployees_Response200: type: array items: type: object properties: firstName: type: string description: First name of the employee. lastName: type: string description: Last name of the employee. emailId: type: string description: Email Id of the employee. phone: type: string description: Phone number of the employee. imageUrl: type: string description: Image URL of the employee. Apiary_listConversations_Response200: type: object properties: totalConversations: type: number description: The number of total conversation objects that can be retrieved through pagination. totalMessages: type: string description: The number of total message objects that can be retrieved through pagination. conversations: type: array description: List of conversations. items: type: object properties: id: type: string description: A unique ID generated by the Birdeye platform that identifies this conversation. contact: type: object properties: id: type: number description: Contact id. name: type: string description: Contact name. firstName: type: string description: Contact first name. lastName: type: string description: Contact last name. phone: type: string description: Phone number of the contact. emailId: type: string description: Email Id of the contact. createdDate: type: string description: Contact creation date. updatedDate: type: string description: Contact updation date. team: type: string description: Team name. locationId: type: string description: Location Id to which contact is attached. description: Contact details. messages: type: array items: type: object properties: sentAt: type: number description: Epoc time of the message. id: type: number description: Message id. text: type: string description: Message text. attachments: type: object description: Attachment details. direction: type: string description: Message direction, SEND or RECEIVE. channel: type: string description: 'A unique identifier that is used to send or receive the message.for example: sms, email or Live_chat.' description: List of messages. conversation_start_date: type: string description: The date conversation. last_message_received_on: type: string description: The date on which the last message was recieved within the defined date range. status: type: string description: Status of the conversation, OPEN or CLOSE. last_used_channel: type: string description: Last used channel. assigned_to: type: object properties: id: type: number description: Id of the user. name: type: string description: Name of the Assignee. type: type: string description: Type of Assignee. emailId: type: string description: Email id of Assignee. description: Assinee details. hasMore: type: boolean description: Indicates if there are more conversations. Apiary_createSubscription_Request: type: object properties: webhookUrl: type: string description: The webhook endpoint URL on your server on which webhook requests are to be sent. emails: type: array description: The email id(s) of the business. items: {} eventName: type: string description: Name of the evnet to be subscribed auth: type: object properties: username: type: string description: username for authorization password: type: string description: password for authorization description: Will be used for basic authorization, should be null for no auth example: webhookUrl: https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65 emails: - test@xyz.com eventName: APPOINTMENT_BOOKED auth: username: testUser password: userpassword Apiary_getEvents_Response200: type: array items: type: object properties: eventId: type: number description: Event Id. eventName: type: string description: Name of the created event. Possible values are Apiary_createWebhookSubscription_Request: type: object properties: businessNumber: type: number description: The business number for which events to be subscribed. Should always be the account business number not the location business number. apiKey: type: string description: Partner specific API key provided by Birdeye for data exchange. events: type: array description: A list of event name strings from the list of available events that should trigger this webhook. Possible values are items: {} endpoint: type: string description: The webhook endpoint URL on your server on which webhook requests are to be sent. required: - businessNumber - apiKey - events example: businessNumber: '755009344' apiKey: 92bcd6e0-c102-43fd-8a67-1a7be5258451 events: - conversation.created - conversation.updated - message.added - message.closed endpoint: https://webhook.site/0c27e14d-f833-4589-b201-86b41a651464 Apiary_getCompetitorBusiness_Response200: type: array items: type: object properties: id: type: number description: Enterprise Competitor Business Number. name: type: string description: Enterprise Competitor Business Name. competitorId: type: number description: Enterprise Competitor Business ID. alias: type: string description: Enterprise Competitor Business alias. Apiary_getCompetitorChildBusiness_Response200: type: array items: type: object properties: id: type: number description: Business ID name: type: string description: Business Name alias: type: number description: Business alias address: type: object properties: address1: type: string description: Address of the business. address2: type: string description: Address of the business. city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. countryName: type: string description: Country Name (2 character country code). description: Business address phone: type: string description: Business phone. type: type: string description: Type of account. e.g. Reseller (when it is a sub-reseller), Enterprise-Location (location based enterprise), Enterprise-Product (product based enterprise), Business (SMB/Enterprise location), Product (Enterprise product). status: type: string description: Business status createdOn: type: string description: Business singup date compAccountId: type: number description: Competitor Location Ids. childCount: type: number description: Child account count(applicable only for Reseller, Enterprise-Location, Enterprise-Product). Apiary_getBusinessCompetitors_Response200: type: array items: type: object properties: enterpriseId: type: number description: Enterprise Business Number. enterpriseName: type: string description: Enterprise Name. businessCompetitors: type: array items: type: object properties: businessId: type: number description: Competitor Business Number. name: type: string description: Competitor Business Name. location: type: object properties: address1: type: string description: Address of the business. address2: type: string description: Address of the business. city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. countryName: type: string description: Country Name (2 character country code). lat: type: string description: Latitude. lng: type: string description: Longitude. description: Address details description: List of business competitors Apiary_createNewCompetitorEnterprise_Request: type: object properties: businessName: type: string description: Location competitor name. userEmailId: type: string description: Location user email. countryCode: type: string description: Location country code. phone: type: string description: Location phone number. zip: type: string description: Zip code. competitorId: type: string description: Competitor Id. type: type: string description: Business type. example: businessName: Location_compca userEmailId: ron@test.com countryCode: CA phone: 408-234-5272 zip: '95035' competitorId: 100037693 type: Product Apiary_createNewCompetitorEnterprise_Response200: type: object properties: competitorId: type: number example: 100037739 description: Enterprise Competitor Business ID. templateid: type: number description: Template Id. isAggregationRequired: type: number example: 1 description: Is agrgegation required. type: type: string example: Enterprise description: Type. businessNumber: type: number example: 169744180007807 description: Enterprise Competitor Business Number. businessAlreadyPresent: type: boolean description: Is Business Already Present. Apiary_createNewChildBusinessInCompetitorEnterprise_Response200: type: object properties: competitorId: type: number example: 100037739 description: Enterprise Competitor Business ID. templateid: type: number description: Template Id. isAggregationRequired: type: number example: 1 description: Is agrgegation required. type: type: string example: Enterprise description: Type. businessNumber: type: number example: 169744180007807 description: Enterprise Competitor Business Number. businessAlreadyPresent: type: boolean description: Is Business Already Present. Apiary_addNewCompetitorAggregationUrl_Request: type: object properties: sourceAlias: type: string description: Source alias. url: type: string description: Source url to be added. required: - sourceAlias - url example: *1 Apiary_addNewCompetitorAggregationUrl_Response200: type: object properties: id: type: number description: Id of the created Aggregation. sourceAlias: type: string description: Alias of the source. sourceName: type: string description: Name of the source. sourceUrl: type: string description: Url of the souce. sourceId: type: number description: Id of the source. compAccountId: type: number description: Competitor account id. Body: type: string description: |- { "id": 140179308, "sourceId": 2, "compAccountId": 1765, "sourceUrl": "https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476", "sourceName": "Google", "thumbnailUrl": "source/icons/2.png", "backGroundColor": "#dd4b39", "textColor": "#ffffff", "userName": null, "password": null, "profileId": null, "reviewFormUrl": "https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476", "aggregationStatus": 3, "sourceAlias": "google", "disabledAggregation": null, "disabledAggregationReason": null } Apiary_getCompetitorReviews_Response200: type: array items: type: object properties: reviewId: type: number description: Id of the review. rating: type: number description: Overall rating for the review, in case of direct feedback and facebook recommendations it will be 0. For Facebook recommendations, value will be 1, Non recommended review will have value set as 0. comments: type: string description: User comment. reviewer: type: object properties: firstName: type: string lastName: type: string nickName: type: string thumbnailUrl: type: string description: Thumbn description: Reviewer details sourceType: type: string description: Source of the review if it is an aggregated review. reviewURL: type: string description: Review url reviewDate: type: string description: Review posted date. response: type: string description: Review response text. responseDate: type: string description: Response date. enableReply: type: boolean description: Whether a review reply is supported via Birdeye API or not. customerId: type: number description: Customer's Id attributed with this review (if any). extraParams: type: object description: Key value pair of custom field(s) associated with the customer attributed to the review (if any) Apiary_getScore_Request: anyOf: - type: object properties: {} - type: object properties: sourceType: type: string description: Type of source e.g. review [by default] or social. sources: type: array description: Aggregation sources. items: {} timePeriodSelected: type: string description: 'For all time : all.' startDate: type: string description: Date from which data has to be fetched[MM/DD/YYYY]. endDate: type: string description: Date until which data has to be fetched[MM/DD/YYYY]. competitors: type: array description: List of competitors items: {} type: object properties: sourceType: type: string description: Type of source e.g. review [by default] or social. sources: type: array items: {} description: Aggregation sources. timePeriodSelected: type: string description: 'For all time : all.' startDate: type: string description: Date from which data has to be fetched[MM/DD/YYYY]. endDate: type: string description: Date until which data has to be fetched[MM/DD/YYYY]. competitors: type: array items: type: object properties: competitorId: type: number description: Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API]. compAccountIds: type: array items: {} description: Locations Ids of competitor account [compAccountIds in Child Business of Competitor API]. description: List of competitors Apiary_getThemeStatistics_Request: type: object properties: sourceType: type: string description: Type of source e.g. review [by default] or social. sources: type: array description: Aggregation sources. items: {} timePeriodSelected: type: string description: 'For all time : all.' startDate: type: string description: Date from which data has to be fetched[MM/DD/YYYY]. endDate: type: string description: Date until which data has to be fetched[MM/DD/YYYY]. competitors: type: array description: List of competitors items: type: object properties: competitorId: type: number description: Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API]. compAccountIds: type: array items: {} description: Locations Ids of competitor account [compAccountIds in Child Business of Competitor API]. topThm: type: number description: Count of top Themes to be fetched. orderBy: type: string description: 'Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"' sentiment: type: number description: "-1 = negative sentiment," example: sourceType: review sources: - google - citysearch startDate: 11/02/2020 endDate: 01/06/2021 competitors: - competitorId: 530846 compAccountIds: - 162426 - 144352 - competitorId: 720708 compAccountIds: - 165432 topThm: 25 orderBy: occurrence sentiment: -1 Apiary_getThemeStatistics_Response200: type: object properties: id: type: number example: 398331 description: Business Id. name: type: string example: Social Stress description: Name of Enterprise. themes: type: array items: {} description: List of Themes. occr: type: number example: 3 description: Occurence. avgScore: type: number example: 1 description: Average Score. pPrct: type: number description: Positive Percentage. nPrct: type: number example: 0.04717 description: Negative Percentage. prct: type: number example: 0.006304 description: Percentage pCt: type: number example: 30707 description: Positive Count. nCt: type: number example: 6360 description: Negative Count. ct: type: number example: 47592 description: Total Count. themeStats: type: array items: type: object properties: theme: type: string description: Theme. adj: type: string description: Adjective kw: type: string description: Keyword. pCt: type: number description: Positive Count. nCt: type: number description: Negative Count. ct: type: number description: Total Count. score: type: number description: Score. scr: type: number description: Scr. description: List of Theme details competitors: type: array items: type: object properties: id: type: number description: Business Id. name: type: string description: Name of Enterprise. themes: type: array items: {} description: List of Themes. occr: type: number description: Occurence. avgScore: type: number description: Average Score. pPrct: type: number description: Positive Percentage. nPrct: type: number description: Negative Percentage. prct: type: number description: Percentage pCt: type: number description: Positive Count. nCt: type: number description: Negative Count. ct: type: number description: Total Count. themeStats: type: array items: type: object properties: theme: type: string description: Theme. adj: type: string description: Adjective kw: type: string description: Keyword. pCt: type: number description: Positive Count. nCt: type: number description: Negative Count. ct: type: number description: Total Count. score: type: number description: Score. scr: type: number description: Scr. description: List of Theme details description: Competitor details. Apiary_getKeywordStatistics_Request: type: object properties: sourceType: type: string description: Type of source e.g. review [by default] or social. sources: type: array description: Aggregation sources. items: {} timePeriodSelected: type: string description: 'For all time : all.' startDate: type: string description: Date from which data has to be fetched[MM/DD/YYYY]. endDate: type: string description: Date until which data has to be fetched[MM/DD/YYYY]. competitors: type: array description: List of competitors items: type: object properties: competitorId: type: number description: Enterprise Competitor Ids [competitorId in Competitor of Enterprise Business API]. compAccountIds: type: array items: {} description: Locations Ids of competitor account [compAccountIds in Child Business of Competitor API]. topKW: type: number description: Count of top Keywords to be fetched. topAd: type: number description: Count of top Adjectives to be fetched. orderBy: type: string description: 'Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"' sentiment: type: number description: "-1 = negative sentiment," example: sourceType: review sources: - google - citysearch startDate: 11/02/2020 endDate: 01/06/2021 competitors: - competitorId: 530846 compAccountIds: - 162426 - 144352 - competitorId: 720708 compAccountIds: - 165432 topKW: 25 topAd: 10 orderBy: ztoa sentiment: -1 Apiary_getKeywordStatistics_Response200: type: object properties: id: type: number example: 119468 description: Business Id name: type: string example: Social Stress description: Name of Enterprise keywords: type: array items: {} description: List of keywords. ct: type: number example: 27159 description: Count. avgScr: type: number example: 1 description: Average Score. keywordStats: type: array items: type: object properties: keyword: type: string description: Keyword occurences: type: number description: Occurences score: type: number description: Score scr: type: number description: Scr. negKWAdjectives: type: array items: type: object properties: adjective: type: string description: Adjectives occurences: type: number description: Occurences prcnt: type: number description: Percentage avgScore: type: number description: Average Score description: Negative keyword details competitors: type: array items: type: object properties: id: type: number description: Business Id name: type: string description: Name of Enterprise keywords: type: array items: {} description: List of keywords. ct: type: number description: Count. avgScr: type: number description: Average Score. keywordStats: type: array items: type: object properties: keyword: type: string description: Keyword occurences: type: number description: Occurences score: type: number description: Score scr: type: number description: Scr. negKWAdjectives: type: array items: type: object properties: adjective: type: string description: Adjectives occurences: type: number description: Occurences prcnt: type: number description: Percentage avgScore: type: number description: Average Score description: Negative keyword details description: Competitor details Apiary_retrieveCompetitorReviews_Response200: type: object properties: businessLocations: type: array items: type: object properties: businessId: type: number description: The unique identifier for the business name: type: string description: The name of your business location being analyzed alias: type: string description: The alias for the business location businessNumber: type: number description: Business number for the location phone: type: string description: Phone number of the location address: type: string description: Address of the business location description: The list of business locations being analyzed competitorLocation: type: string description: The name of the competitor location where the review was left competitorBrand: type: string description: The brand name or identifier of the competitor source: type: string description: The review platform/source where the review was published rating: type: number description: The star rating given by the reviewer (1-5 scale) reviewComment: type: string description: The actual text content of the review written by the customer reviewerName: type: string description: The name of the person who wrote the review reviewDate: type: string description: The date when the review was published (YYYY-MM-DD format) reply: type: string description: The business owner's response to the review (if any) Apiary_retrieveCompetitorReviewMetrics_Response200: type: object properties: businessLocations: type: object description: The list of business locations being analyzed properties: businessId: type: number description: The unique identifier for the business name: type: string description: The name of your business location being analyzed alias: type: string description: The alias for the business location businessNumber: type: number description: Business number for the location phone: type: string description: Phone number of the location address: type: string description: Address of the business location competitorLocation: type: string description: The name of the competitor location where the review was left competitorBrand: type: string description: The brand name or identifier of the competitor source: type: string description: The review platform/source where the review was published overallRating: type: number description: The average rating for this competitor location on this specific source reviewCount: type: number description: The total number of reviews for this competitor location on this specific source Apiary_getInsightExperienceLocationInfo_Response200: type: object properties: totalCount: type: number description: Total number of locations returned dataPoints: type: array description: Array of location experience metrics items: type: object properties: id: type: number description: Location business number name: type: string description: Location name experienceScore: type: number description: Current experience score listingScore: type: number description: Current listing score sentimentScore: type: number description: Current sentiment score reputationScore: type: number description: Current reputation score experienceDeltaScore: type: number description: Previous period experience score listingDeltaScore: type: number description: Previous period listing score sentimentDeltaScore: type: number description: Previous period sentiment score reputationDeltaScore: type: number description: Previous period reputation score experienceDelta: type: number description: Change in experience score listingDelta: type: number description: Change in listing score reputationDelta: type: number description: Change in reputation score sentimentDelta: type: number description: Change in sentiment score Apiary_getAllQuestionsAndAnswers_Response200: type: object properties: totalCount: type: number description: Total number of questions questionsAndAnswers: type: array description: Questions and answers details items: type: object properties: questionId: type: number description: Unique question identifier. answeredByOwner: type: boolean description: Identified if question was answered by page owner. askedByOwner: type: boolean description: Identifies if question was asked by page owner. question: type: string description: text of question updatedBy: type: string description: Name of author of question time: type: string description: time at which question was created/updated hh:mm AM/PM updatedOn: type: string description: Date at which question was created/updated MMM DD, YYYY userProfileLogoUrl: type: string description: url link to google profile photo of author userCategory: type: string description: category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE locationName: type: string description: Birdeye registered business name noOfAnswers: type: string description: number of answer available on question answers: type: object properties: answerId: type: number description: Unique answer identifier. answer: type: string description: Text of answer. answeredByOwner: type: boolean description: Identifies if this answer was added by owner. updatedBy: type: string description: Name of author of answer. updatedOn: type: string description: 'Date at which answer was created/updated format : MMM DD, YYYY' time: type: string description: 'time at which answer was created/updated format: hh:mm AM/PM' userCategory: type: string description: category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE userProfileLogoUrl: type: string description: url link to google profile photo of author description: Answers details Apiary_getAllUnansweredQuestionsAndAnswers_Response200: type: object properties: totalCount: type: number description: Total number of questions questionsAndAnswers: type: array description: Questions and answers details items: type: object properties: questionId: type: number description: Unique question identifier. answeredByOwner: type: boolean description: Identified if question was answered by page owner. askedByOwner: type: boolean description: Identifies if question was asked by page owner. question: type: string description: text of question updatedBy: type: string description: Name of author of question time: type: string description: time at which question was created/updated hh:mm AM/PM updatedOn: type: string description: Date at which question was created/updated MMM DD, YYYY userProfileLogoUrl: type: string description: url link to google profile photo of author userCategory: type: string description: category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE locationName: type: string description: Birdeye registered business name noOfAnswers: type: string description: number of answer available on question answers: type: object properties: answerId: type: number description: Unique answer identifier. answer: type: string description: Text of answer. answeredByOwner: type: boolean description: Identifies if this answer was added by owner. updatedBy: type: string description: Name of author of answer. updatedOn: type: string description: 'Date at which answer was created/updated format : MMM DD, YYYY' time: type: string description: 'time at which answer was created/updated format: hh:mm AM/PM' userCategory: type: string description: category of author MERCHANT, REGULAR_USER, LOCAL_GUIDE userProfileLogoUrl: type: string description: url link to google profile photo of author description: Answers details Apiary_getAllServices_Response200: type: object properties: services: type: array description: Google services details items: type: object properties: serviceId: type: string description: Unique service identifier name: type: string description: name of the service currencyCode: type: string description: currency code of the paid service price: type: number description: price of the paid service description: type: string description: description of the service group: type: string description: service group duration: type: number description: service duration in minutes Apiary_getLocationMapping_Response200: type: object properties: category_name: type: string description: name of the GMB category services: type: array description: Google services details items: type: object properties: serviceId: type: string description: Unique service identifier name: type: string description: name of the service currencyCode: type: string description: currency code of the paid service price: type: number description: price of the paid service description: type: string description: description of the service group: type: string description: service group duration: type: number description: service duration in minutes Apiary_getAllQna_Response200: type: object properties: qnAs: type: array items: type: object properties: question: type: object properties: text: type: string description: The text of the question. updatedDate: type: string description: Last update date/time (ISO 8601 or yyyy-MM-dd'T'HH:mm:ss.SSSZ). answers: type: array items: type: object properties: text: type: string description: The text of the answer. description: Array of answers to this question. description: Details for this QnA's question. allLocations: type: boolean description: Indicates if this QnA applies to all business locations. source: type: string description: Source of the QnA entry, e.g. "USER", "AI". sourceType: type: string description: Indicates the source type when the QnA is AI-generated, such as "LINK", "FILE", and others. sourceValue: type: string description: Reference value for the source, could be a link, filename, etc. businessNumbers: type: array items: {} description: Array of location/business numbers, if specific. description: List of QnA objects. Apiary_getLocationStatusReport_Response200: type: object properties: businessName: type: string description: Name of the Business/Location. activationStatus: type: string example: active/demo/inactive description: Activation Status of Business/Location lastUpdated: type: string example: Mon Jun 10 09:49:30 GMT 2024 description: Last Updated Date of a Business/Location. locationStatus: type: string example: Possible Values “Published”,“Scan State” or “Disabled“ description: Return the state of Business/Location. totalSites: type: number example: 44 description: Total no. of Sites. syncedCount: type: number example: 30 description: Total no. of Synced sites count. submittedCount: type: number example: 13 description: Total no. of Submitted sites Count. needUpdatesCount: type: number description: Total no. of Sites where Action is required. optedOutCount: type: number description: Total no. of Opted out sites count. notConnectedCount: type: number example: 1 description: Total no. of Not connected sites count. syncedPercentage: type: string example: 68.18% description: Total no. of Synced Sites Percentage. submittedPercentage: type: string example: 29.55% description: Total no. of Submitted Sites Percentage. needUpdatesPercentage: type: string example: 0.00% description: Total no. of Need Updates Sites Percentage. optedOutPercentage: type: string example: 0.00% description: Total no. of Opted out sites percentage. notConnectedPercentage: type: string example: 2.27% description: Total no. of Not Connected Sites Percentage. publishListings: type: string example: Please initiate Publish for this locations listings. description: Message to initiate publish locations listings. errors: type: array items: {} description: List of Error messages in case of Not Published state if exists. sites: type: array items: type: object properties: siteName: type: string description: Name of listing source. status: type: string description: 'Status of the location on that source. Possible values are :' url: type: string description: Location source link. errors: type: array items: {} description: Possible errors would be come when status of directory is 'Action Required' description: List of location status. Apiary_listingsInsights_Request: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} startDate: type: string description: 'Start Date, Format: yyyy-MM-dd.' endDate: type: string description: 'End Date, Format: yyyy-MM-dd. If startDate and endDate are not provided, then the last 3 months date range will be chosen.' viewMode: description: for mobile or desktop or both (if none is provided then data for both will be displayed) Example “Desktop”, ”Mobile” type: array items: {} required: - viewMode example: businessNumbers: - 156387109031976 startDate: 2010-02-01 endDate: 2022-02-01 viewMode: - Mobile - Desktop Apiary_listingsInsightsDatapoints_Request: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} startDate: type: string description: 'Start Date, Format: yyyy-MM-dd.' endDate: type: string description: 'End Date, Format: yyyy-MM-dd. If startDate and endDate are not provided, then the last 3 months date range will be chosen with groupByType as the day.' viewMode: description: is data required for mobile or desktop or both (if none is provided then data for both will be displayed) type: array items: {} groupByType: type: string description: Group the data accordingly. The default value will be the week. Possible values are example: businessNumbers: - 156387109031976 startDate: 2010-02-01 endDate: 2022-02-01 groupByType: year viewMode: - Mobile - Desktop Apiary_listingsInsightsDatapoints_Response200: type: array items: type: object properties: label: type: string description: The business counts data on a particular date. wsiteVisitsCount: type: number description: The number of times the business profile website was clicked. directionsCount: type: number description: The number of times a direction request was requested to the business location. callsCount: type: number description: The number of times the business profile call button was clicked. Apiary_getGmbAttributes_Response200: type: object properties: Accessibility: type: array items: type: object properties: attributeId: type: string description: Attribute Id. valueType: type: string description: Attribute value type. displayName: type: string description: Attribute display name. groupDisplayName: type: string description: Attribute group name. valueMetadata: type: array items: type: object properties: value: type: string description: Possible attribute value. displayName: type: string description: Attribute display name. description: Contains the list of possible values for the attribute. description: This is dynamic field. Depends upon request inputs. Apiary_getCategoryList_Response200: type: array items: type: object properties: id: type: string description: Category Id. name: type: string description: Category Name. primary: type: boolean description: It will be present in response only in case when sourceName = “VENDOR” Apiary_createListing_Request: type: object properties: businessInfo: type: object properties: name: type: string description: Name of the Business/Product (Max 250 character long). phone: type: string description: Your official Business Phone number. Format is (xxx) xxx-xxxx. websiteUrl: type: string description: Business website url. emailId: type: string description: Business Email ID. isAddressHidden: type: string description: If your business doesn’t have a place for your customers to visit, then you can hide your street address. isServiceAreaProvider: type: string description: If you deliver or provide service at customer locations. mainBusinessDescription: type: string description: Business Description is optional. If this field is included with an empty value in the API request, the existing Business Description will be cleared for the location. If a value is provided, it must contain at least 200 characters. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. serviceAreas: type: array description: 'Locations where you deliver or provide service (applicable if isServiceAreaProvider is ''Yes'').NOTE: Maximum service areas that can be provided are 10.' items: type: object properties: description: type: string description: Area, City, State, Zip, Country. e.g. "1735 Berryessa Rd, San Jose, CA 95133, USA", “Onalaska, WI, USA”. location: type: object properties: address1: type: string description: Address of the business/location. address2: type: string description: Address of the business/location. city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. subLocality: type: string description: "(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system." required: - zip description: Business address required: - name - phone description: Business Information additionalInfo: type: object properties: establishedYear: type: number description: Year established timezone: type: string description: Timezone of the business. languages: type: array description: Languages. items: {} moreHours: description: 'Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api. NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.' type: array items: {} appleMoreHours: description: 'Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api. NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.' type: array items: {} wholeWeekOperating: type: number description: Whether your business is open 24/7, Possible Values - 0 or 1. hoursOfOperations: type: array description: 'Regular hours: Regular working hours of the business for each day from Monday to Sunday.' items: type: object properties: day: type: number description: 0(Monday), 1(Tuesday), 2(Wednesday) and so on. workingHours: type: array items: type: object properties: startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) description: Working hours of the business isOpen: type: number description: 0 (Business closed today), 1 (open) comment: type: string description: Add the special instruction. specialHours: type: array description: For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for. items: type: object properties: specialDate: type: string description: It should be "MM/DD/YYYY". startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) isOpen: type: number description: 0(Business closed today), 1 (open) businessStatus: type: string description: The business status on the listing page can be set to Open, Temporarily Closed, Permanently Closed, or Opening Soon. A Reopen Date is mandatory for 'Temporarily Closed' and 'Opening Soon' statuses, while optional for 'Open'. reopenDate: type: string description: Reopen Date is required for the 'Temporarily Closed' and 'Opening Soon' statuses, and optional for 'Open.' The date must be in the 'MM/dd/yyyy' format. services: type: string description: Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters. keywords: type: string description: Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters. products: type: string description: Products about the business. Useful in SEO and Business products cannot be more than 1000 characters. appointmentLink: type: string description: Let customers book appointments by redirecting them to your appointments page. reservationLink: type: string description: Let customers reserve tables by linking them to your reservations page. menuLink: type: string description: Show customers what you serve by linking them to your menu. orderAheadLink: type: string description: Let customers place delivery and pick-up orders by linking them to your ordering page. impressum: type: string description: In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence. paymentTypes: description: |- List of payment types accepted by the business. + (Members) + China Union Pay + Bitcoin + Cash Accepted + MasterCard + PayPal + Check / Cheque + Contactless Payment + Debit Card + Diners Club + JCB + Financing + Visa + American Express + Cash Only + Rupay + Credit Card + Discover type: array items: {} additionalPaymentTypes: type: string description: Additional Payment Type (Max 250 character long). localPhoneNumber: type: string description: Local phone number. tollFreePhoneNumber: type: string description: Tollfree number. androidAppURL: type: string description: Android app url. iosAppURL: type: string description: IOS app url. required: - hoursOfOperations - services description: Business Additional Information media: type: object properties: logoUrl: type: string description: 'This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.' coverImageUrl: type: string description: 'This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.' gmbCover: type: string description: Google Cover Image Url. facebookCover: type: string description: Facebook Cover Image Url. description: Media details. optOut: type: object properties: gmbLogoOptOut: type: boolean description: Update profile photo on your google my business page. fbLogoOptOut: type: boolean description: Update profile photo on your facebook profile. gmbCoverOptOut: type: boolean description: Update cover photo on your google my business page. fbCoverOptOut: type: boolean description: Update cover photo on your facebook profile. gmbProfileOptOut: type: boolean description: Opt out from the google specific section on the profile page. businessProfileOptOut: type: boolean description: Opt out from the business profile section. description: Opt out section covidInfo: type: object properties: postDescription: type: string description: This information is posted and updated on your Google business profile page and your FB business page. covid19SupportLink: type: string description: Should be a valid covid19 support url virtualCareLink: type: string description: Should be a valid url virtual care link description: Provide this data for updating any COVID specific information you want to share with your customers. bingListing: type: object properties: primaryCategoryBing: type: string description: Primary category of bing. bingCategories: description: You can add a maximum of up to 3 categories. type: array items: {} bingPhoneNumber: type: string description: You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set. bingDescription: type: string description: An ‘About the business description’. Bing description cannot be more than 4096 characters. description: This data will be used to update your Bing listing. internalListing: type: object properties: description: type: string description: Microsite Override Business Description is optional. If this field is included with an empty value in the API request, the existing Microsite Override Business Description will be cleared for the location. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. category: type: string description: Primary category of business. subCategories: description: You can add up to 3 subcategories. type: array items: {} displayCategory: type: string description: Choose one of the category either from primary category or from sub categories. required: - category - subCategories description: Provide data for microsite listing purpose. facebookListing: type: object properties: facebookPhoneNumber: type: string description: Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page categories: description: You can add up to 3 categories. type: array items: {} facebookDescription: type: string description: An ‘about your business’ description. Facebook description cannot be more than 255 characters. description: This data will be used to update your Facebook business page/ listing. gmbListing: type: object properties: googleWebsiteUrl: type: string description: Website url will update on google listing. This website URL will override your existing website URL on your Google business profile. googlePhoneNumber: type: string description: You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set. googleStoreId: type: string description: Store id for google. primaryCategoryGmb: type: string description: Primary category of google. additionalCategories: description: You can add up to 9 subcategories. type: array items: {} googleDescription: type: string description: An ‘about your business’ description. Google description cannot be more than 750 characters. attributes: type: object properties: {} description: Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are hotelAttributes: type: object properties: {} description: Hotel attributes are key characteristics and amenities of your property that help guests discover and understand what your hotel offers. These attributes enhance your hotel's visibility and searchability across booking platforms and travel sites. Supported attribute categories are Services, Policies, FoodAndDrink, Pools, Wellness, Activities, Transportation, Families, Connectivity, Business, Accessibility, Pets, Parking, Housekeeping, HealthAndSafety, Sustainability, Property. Each attribute carries an attributeValueType field indicating the expected value format. Supported formats are BOOLEAN (true/false), INTEGER (positive number), YEAR (year string), TIME (HH:mm string), SINGLE_SELECT (one value from possibleValues), or MULTI_SELECT (comma-separated values from possibleValues). foodDelivery: type: string description: Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com foodTakeout: type: string description: 'Enter the redirect URL where customers can place ''takeout'' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com' whatsappBusinessLink: type: string description: Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/ textMessageNumber: type: string description: Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS. description: This data will be used to update your Google Business Profile/ listing. appleListing: type: object properties: phoneNumber: type: string description: This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number. appleWebsiteUrl: type: string description: Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect. primaryCategory: type: string description: Primary category of apple ,This is a mandatory field. Please pass an acceptable category name/ id by first getting the approved list using the Get category API. additionalCategories: description: You can add upto 5 additional categories most suitable for your business. Please pass an acceptable category name/ id by first getting the approved list using the Get category API. type: array items: {} appleLocationAttributes: type: object properties: {} description: 'Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:' appleActionLinks: type: object properties: {} description: Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API. appleBusinessName: type: string description: Business name shown on your Apple Business listing. Must be between 3 and 250 characters. appleBusinessDescription: type: string description: Business description shown on your Apple Business listing. Must be between 20 and 500 characters. description: This data will be used to update your Google Business Profile/ listing. thirdPartyListing: type: object properties: thirdPartyCategory: type: string description: 'Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.' thirdPartySubCategories: type: string description: 'Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.' description: This data will be used to update your secondary listings sites. socialProfileURLs: type: object properties: facebookUrl: type: string description: Facebook URL. twitterUrl: type: string description: Business Twitter URL. linkedInUrl: type: string description: Business LinkedId URL. googleUrl: type: string description: Business Google URL. youTubeUrl: type: string description: Business Youtube URL. instagramUrl: type: string description: Business Instagram URL. pintrestUrl: type: string description: Business Pinterest URL. bbbUrl: type: string description: Business BB URL. lendingtreeUrl: type: string description: Business Lending Tree URL. description: Profile URLs for business on top rated social sites healthcare: type: object properties: doctorCategories: type: array description: This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values. items: {} isProvider: type: boolean description: If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not. practiceName: type: string description: Name of the practice.Must be less than 191 characters. firstName: type: string description: First name of the provider. middleName: type: string description: Middle name of the provider. surName: type: string description: Surname of the provider npi: type: number description: National Provider Identifier - NPI. Must be 10 digits credentials: type: string description: University of the provider/practice. Must be less than 25 characters university: type: string description: University of the provider/practice. Must be less than 255 characters hospitalAffiliations: type: string description: Hospital Affiliations of the provider/practice. Must be less than 150 characters insurancesAccepted: type: string description: Insurance Accepted of the provider/practice. Must be less than 50 characters description: This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same. example: businessInfo: name: Dieci Lifestyle Spa phone: "(973) 716-0007" websiteUrl: http://www.diecispa.org/ emailId: example@birdeye.com isAddressHidden: false isServiceAreaProvider: false mainBusinessDescription: A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos serviceAreas: - description: Van An, Berryessa Road, San Jose, CA, USA - description: Santa Clara, CA, USA location: address1: 90 W Mount Pleasant Ave address2: "(btwn Preston Dr. & N. Mitchell Ave.)" subLocality: Auckland CBD city: Livingston state: NJ zip: 7039 countryCode: US additionalInfo: establishedYear: '2022' timezone: America/Los_Angeles languages: - English - Hindi moreHours: Dinner: - day: 0 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 1 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 2 isOpen: 1 workingHours: - startHour: 32400 endHour: 72600 - day: 3 isOpen: 1 workingHours: - startHour: 32400 endHour: 41400 - day: 4 isOpen: 1 workingHours: - startHour: 32400 endHour: 41400 - day: 5 isOpen: 1 workingHours: - startHour: 32400 endHour: 41400 - day: 6 isOpen: 1 workingHours: - startHour: 0 endHour: 73800 Delivery: - day: 0 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 1 isOpen: 1 workingHours: - startHour: 25200 endHour: 34200 - day: 2 isOpen: 1 workingHours: - startHour: 7200 endHour: 34200 - day: 3 isOpen: 1 workingHours: - startHour: 0 endHour: 41400 - day: 4 isOpen: 1 workingHours: - startHour: 0 endHour: 41400 - day: 5 isOpen: 1 workingHours: - startHour: 0 endHour: 41400 - day: 6 isOpen: 1 workingHours: - startHour: 3600 endHour: 3600 appleMoreHours: Dining Hours: - day: 0 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 1 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 2 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 3 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 4 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 5 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 6 isOpen: 0 workingHours: - startHour: '' endHour: '' wholeWeekOperating: 0 hoursOfOperations: - day: 0 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 1 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 2 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 3 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 4 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 5 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 6 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 64800 specialHours: - specialDate: 12/31/2020 startHour: 32400 endHour: 43200 isOpen: 0 - specialDate: 01/01/2021 startHour: '' endHour: '' isOpen: 1 businessStatus: Open reopenDate: 01/01/2021 keywords: HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists services: BeautySalon,HairSpa products: LivingProofDryShampoo,KevinMurphyBlondeAngelWash appointmentLink: http://www.gmail.com reservationLink: http://www.gmail.com menuLink: http://www.gmail.com orderAheadLink: http://www.gmail.com impressum: Thisissampleimpressum paymentTypes: - China Union Pay - Bitcoin - Cash Accepted - MasterCard - PayPal - Check / Cheque - Contactless Payment - Debit Card - Diners Club - JCB - Financing - Visa - American Express - Cash Only - Rupay - Credit Card - Discover additionalPaymentTypes: Visa,MasterCard,AmericanExpress,DebitCards,Check localPhoneNumber: "(973)716-0102" tollFreePhoneNumber: '' iosAppURL: http://www.gmail.com androidAppURL: http://www.gmail.com media: logoUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png coverImageUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg gmbCover: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg facebookCover: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg optOut: gmbCoverOptOut: true gmbLogoOptOut: true fbCoverOptOut: false fbLogoOptOut: false gmbProfileOptOut: false businessProfileOptOut: false covidInfo: postDescription: SampleCovidDesc covid19SupportLink: http://www.covidInfo.com virtualCareLink: http://www.covidInfo.com bingListing: primaryCategoryBing: Art Restoration Service bingDescription: Sample Bing Description bingCategories: - Art Restoration Service bingPhoneNumber: "(415) 673-0868" internalListing: description: ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic category: Beauty subCategories: - Eyelash Service - Nail Salons displayCategory: Eyelash Service facebookListing: facebookDescription: This is sample facebook description facebookPhoneNumber: "(415) 673-0868" categories: - Science - Sports thirdPartyListing: thirdPartyCategory: Towing Service thirdPartySubCategories: - Car Dealer - Auto Glass Shop gmbListing: googleWebsiteUrl: http://www.gmail.com googleStoreId: '1232133' googlePhoneNumber: "(973) 716-0007" primaryCategoryGmb: Fast Food Restaurant googleDescription: This is sample description for google additionalCategories: - Snack bar attributes: Accessibility: - attributeId: has_wheelchair_accessible_elevator attributeName: Wheelchair accessible elevator value: false Crowd: - attributeId: welcomes_families attributeName: Family-friendly value: true hotelAttributes: business: business: meetingRoomsCount: attributeId: meetingRoomsCount attributeName: Number of meeting rooms value: 20 policies: policies: checkinTime: attributeId: checkinTime attributeName: Check-In Time value: "14:00" checkoutTime: attributeId: checkoutTime attributeName: Check-Out Time value: "11:00" property: property: builtYear: attributeId: builtYear attributeName: Built Year value: 2010 services: services: frontDesk: attributeId: frontDesk attributeName: Front desk value: true giftShop: attributeId: giftShop attributeName: Gift shop value: false languagesSpoken: attributeId: languagesSpoken attributeName: Languages Spoken value: English,Spanish,French foodDelivery: https://www.ubereats.com foodTakeout: https://www.ubereats.com whatsappBusinessLink: https://wa.me/9737160007 textMessageNumber: 973716-0007 appleListing: primaryCategory: health_care.dentistry.dental_clinic.dentist appleWebsiteUrl: https://www.apple.com additionalCategories: - health_care.dentistry.dental_clinic.dentist.oral_surgeon appleLocationAttributes: crossbusiness.accessibility_features: - attributeId: accessible_elevator crossbusiness.family_kids: - attributeId: kidsclub - attributeId: parents_waitingarea appleActionLinks: - id: quicklinks.schedule_appointment deepLinkUrl: https://www.google.com appStoreUrl: https://apps.apple.com/your_apps_store_url phoneNumber: "+1 201-819-7989" appleBusinessName: This is sample business name appleBusinessDescription: This is sample business description socialProfileURLs: googleUrl: http://www.google.com/123 facebookUrl: http://www.facebook.com/123 twitterUrl: http://www.twitter.com/123 youTubeUrl: http://www.youtube.com/12 linkedinUrl: http://www.linkedin.com/12 instagramUrl: http://www.instagram.com/12 pintrestUrl: http://www.pinterest.com/12 bbbUrl: http://www.bbb.org/12 lendingtreeUrl: http://www.lendingtree.com/12 healthcare: doctorCategories: - Allergist-Immunologist > Allergy - Allergist-Immunologist > General - Addiction Medicine Specialist > General isProvider: true practiceName: General Medicine firstName: John middleName: Jack surName: Doe npi: '1245319599' credentials: MD university: Sample text hospitalAffiliations: Sample text insurancesAccepted: Sample text Apiary_updateListing_Request: type: object properties: businessInfo: type: object properties: name: type: string description: Name of the Business/Product (Max 250 character long). phone: type: string description: Your official Business Phone number. Format is (xxx) xxx-xxxx. websiteUrl: type: string description: Business website url. emailId: type: string description: Business Email ID. isAddressHidden: type: string description: If your business doesn’t have a place for your customers to visit, then you can hide your street address. isServiceAreaProvider: type: string description: If you deliver or provide service at customer locations. mainBusinessDescription: type: string description: Business Description is optional. If this field is included with an empty value in the API request, the existing Business Description will be cleared for the location. If a value is provided, it must contain at least 200 characters. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. serviceAreas: type: array description: 'Locations where you deliver or provide service (applicable if isServiceAreaProvider is ''Yes'').NOTE: Maximum service areas that can be provided are 10.' items: type: object properties: description: type: string description: Area, City, State, Zip, Country. e.g. "1735 Berryessa Rd, San Jose, CA 95133, USA", “Onalaska, WI, USA”. location: type: object properties: address1: type: string description: Address of the business/location. address2: type: string description: Address of the business/location. city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. subLocality: type: string description: "(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system." required: - zip description: Business address required: - name - phone description: Business Information additionalInfo: type: object properties: establishedYear: type: number description: Year established timezone: type: string description: Timezone of the business. languages: type: array description: Languages. items: {} moreHours: description: 'Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api. NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.' type: array items: {} appleMoreHours: description: 'Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api. NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.' type: array items: {} wholeWeekOperating: type: number description: Whether your business is open 24/7, Possible Values - 0 or 1. hoursOfOperations: type: array description: 'Regular hours: Regular working hours of the business for each day from Monday to Sunday.' items: type: object properties: day: type: number description: 0(Monday), 1(Tuesday), 2(Wednesday) and so on. workingHours: type: array items: type: object properties: startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) description: Working hours of the business isOpen: type: number description: 0 (Business closed today), 1 (open) comment: type: string description: Add the special instruction. specialHours: type: array description: For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for. items: type: object properties: specialDate: type: string description: It should be "MM/DD/YYYY". startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) isOpen: type: number description: 0(Business closed today), 1 (open) businessStatus: type: string description: The business status on the listing page can be set to Open, Temporarily Closed, Permanently Closed, or Opening Soon. A Reopen Date is mandatory for 'Temporarily Closed' and 'Opening Soon' statuses, while optional for 'Open'. reopenDate: type: string description: Reopen Date is required for the 'Temporarily Closed' and 'Opening Soon' statuses, and optional for 'Open.' The date must be in the 'MM/dd/yyyy' format. services: type: string description: Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters. keywords: type: string description: Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters. products: type: string description: Products about the business. Useful in SEO and Business products cannot be more than 1000 characters. appointmentLink: type: string description: Let customers book appointments by redirecting them to your appointments page. reservationLink: type: string description: Let customers reserve tables by linking them to your reservations page. menuLink: type: string description: Show customers what you serve by linking them to your menu. orderAheadLink: type: string description: Let customers place delivery and pick-up orders by linking them to your ordering page. impressum: type: string description: In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence. paymentTypes: description: |- List of payment types accepted by the business. + (Members) + China Union Pay + Bitcoin + Cash Accepted + MasterCard + PayPal + Check / Cheque + Contactless Payment + Debit Card + Diners Club + JCB + Financing + Visa + American Express + Cash Only + Rupay + Credit Card + Discover type: array items: {} additionalPaymentTypes: type: string description: Additional Payment Type (Max 250 character long). localPhoneNumber: type: string description: Local phone number. tollFreePhoneNumber: type: string description: Tollfree number. androidAppURL: type: string description: Android app url. iosAppURL: type: string description: IOS app url. required: - hoursOfOperations - services description: Business Additional Information media: type: object properties: logoUrl: type: string description: 'This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.' coverImageUrl: type: string description: 'This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.' gmbCover: type: string description: Google Cover Image Url. facebookCover: type: string description: Facebook Cover Image Url. description: Media details. optOut: type: object properties: gmbLogoOptOut: type: boolean description: Update profile photo on your google my business page. fbLogoOptOut: type: boolean description: Update profile photo on your facebook profile. gmbCoverOptOut: type: boolean description: Update cover photo on your google my business page. fbCoverOptOut: type: boolean description: Update cover photo on your facebook profile. gmbProfileOptOut: type: boolean description: Opt out from the google specific section on the profile page. businessProfileOptOut: type: boolean description: Opt out from the business profile section. description: Opt out section covidInfo: type: object properties: postDescription: type: string description: This information is posted and updated on your Google business profile page and your FB business page. covid19SupportLink: type: string description: Should be a valid covid19 support url virtualCareLink: type: string description: Should be a valid url virtual care link description: Provide this data for updating any COVID specific information you want to share with your customers. bingListing: type: object properties: primaryCategoryBing: type: string description: Primary category of bing. bingCategories: description: You can add a maximum of up to 3 categories. type: array items: {} bingPhoneNumber: type: string description: You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set. bingDescription: type: string description: An ‘About the business description’. Bing description cannot be more than 4096 characters. description: This data will be used to update your Bing listing. internalListing: type: object properties: description: type: string description: Microsite Override Business Description is optional. If this field is included with an empty value in the API request, the existing Microsite Override Business Description will be cleared for the location. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. category: type: string description: Primary category of business. subCategories: description: You can add up to 3 subcategories. type: array items: {} displayCategory: type: string description: Choose one of the category either from primary category or from sub categories. required: - category - subCategories description: Provide data for microsite listing purpose. facebookListing: type: object properties: facebookPhoneNumber: type: string description: Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page categories: description: You can add up to 3 categories. type: array items: {} facebookDescription: type: string description: An ‘about your business’ description. Facebook description cannot be more than 255 characters. description: This data will be used to update your Facebook business page/ listing. gmbListing: type: object properties: googleWebsiteUrl: type: string description: Website url will update on google listing. This website URL will override your existing website URL on your Google business profile. googlePhoneNumber: type: string description: You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set. googleStoreId: type: string description: Store id for google. primaryCategoryGmb: type: string description: Primary category of google. additionalCategories: description: You can add up to 9 subcategories. type: array items: {} googleDescription: type: string description: An ‘about your business’ description. Google description cannot be more than 750 characters. attributes: type: object properties: {} description: Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are hotelAttributes: type: object properties: {} description: Hotel attributes are key characteristics and amenities of your property that help guests discover and understand what your hotel offers. These attributes enhance your hotel's visibility and searchability across booking platforms and travel sites. Supported attribute categories are Services, Policies, FoodAndDrink, Pools, Wellness, Activities, Transportation, Families, Connectivity, Business, Accessibility, Pets, Parking, Housekeeping, HealthAndSafety, Sustainability, Property. Each attribute carries an attributeValueType field indicating the expected value format. Supported formats are BOOLEAN (true/false), INTEGER (positive number), YEAR (year string), TIME (HH:mm string), SINGLE_SELECT (one value from possibleValues), or MULTI_SELECT (comma-separated values from possibleValues). foodDelivery: type: string description: Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com foodTakeout: type: string description: 'Enter the redirect URL where customers can place ''takeout'' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com' whatsappBusinessLink: type: string description: Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/ textMessageNumber: type: string description: Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS. description: This data will be used to update your Google Business Profile/ listing. appleListing: type: object properties: phoneNumber: type: string description: This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number. appleWebsiteUrl: type: string description: Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect. primaryCategory: type: string description: Primary category of apple ,This is a mandatory field. Please pass an acceptable category name/ id by first getting the approved list using the Get category API. additionalCategories: description: You can add upto 5 additional categories most suitable for your business. Please pass an acceptable category name/ id by first getting the approved list using the Get category API. type: array items: {} appleLocationAttributes: type: object properties: {} description: 'Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:' appleActionLinks: type: object properties: {} description: Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API. appleBusinessName: type: string description: Business name shown on your Apple Business listing. Must be between 3 and 250 characters. appleBusinessDescription: type: string description: Business description shown on your Apple Business listing. Must be between 20 and 500 characters. description: This data will be used to update your Google Business Profile/ listing. thirdPartyListing: type: object properties: thirdPartyCategory: type: string description: 'Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.' thirdPartySubCategories: type: string description: 'Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.' description: This data will be used to update your secondary listings sites. socialProfileURLs: type: object properties: facebookUrl: type: string description: Facebook URL. twitterUrl: type: string description: Business Twitter URL. linkedInUrl: type: string description: Business LinkedId URL. googleUrl: type: string description: Business Google URL. youTubeUrl: type: string description: Business Youtube URL. instagramUrl: type: string description: Business Instagram URL. pintrestUrl: type: string description: Business Pinterest URL. bbbUrl: type: string description: Business BB URL. lendingtreeUrl: type: string description: Business Lending Tree URL. description: Profile URLs for business on top rated social sites healthcare: type: object properties: doctorCategories: type: array description: This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values. items: {} isProvider: type: boolean description: If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not. practiceName: type: string description: Name of the practice.Must be less than 191 characters. firstName: type: string description: First name of the provider. middleName: type: string description: Middle name of the provider. surName: type: string description: Surname of the provider npi: type: number description: National Provider Identifier - NPI. Must be 10 digits credentials: type: string description: University of the provider/practice. Must be less than 25 characters university: type: string description: University of the provider/practice. Must be less than 255 characters hospitalAffiliations: type: string description: Hospital Affiliations of the provider/practice. Must be less than 150 characters insurancesAccepted: type: string description: Insurance Accepted of the provider/practice. Must be less than 50 characters description: This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same. example: businessInfo: name: Dieci Lifestyle Spa phone: "(973) 716-0007" websiteUrl: http://www.diecispa.org/ emailId: example@birdeye.com isAddressHidden: false isServiceAreaProvider: false mainBusinessDescription: A cozy neighborhood café serving freshly roasted coffee, artisan teas, and homemade pastries in a friendly atmos serviceAreas: - description: Van An, Berryessa Road, San Jose, CA, USA - description: Santa Clara, CA, USA location: address1: 90 W Mount Pleasant Ave address2: "(btwn Preston Dr. & N. Mitchell Ave.)" subLocality: Auckland CBD city: Livingston state: NJ zip: 7039 countryCode: US additionalInfo: establishedYear: '2022' timezone: America/Los_Angeles languages: - English - Hindi moreHours: Dinner: - day: 0 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 1 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 2 isOpen: 1 workingHours: - startHour: 32400 endHour: 72600 - day: 3 isOpen: 1 workingHours: - startHour: 32400 endHour: 41400 - day: 4 isOpen: 1 workingHours: - startHour: 32400 endHour: 41400 - day: 5 isOpen: 1 workingHours: - startHour: 32400 endHour: 41400 - day: 6 isOpen: 1 workingHours: - startHour: 0 endHour: 73800 Delivery: - day: 0 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 1 isOpen: 1 workingHours: - startHour: 25200 endHour: 34200 - day: 2 isOpen: 1 workingHours: - startHour: 7200 endHour: 34200 - day: 3 isOpen: 1 workingHours: - startHour: 0 endHour: 41400 - day: 4 isOpen: 1 workingHours: - startHour: 0 endHour: 41400 - day: 5 isOpen: 1 workingHours: - startHour: 0 endHour: 41400 - day: 6 isOpen: 1 workingHours: - startHour: 3600 endHour: 3600 appleMoreHours: Dining Hours: - day: 0 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 1 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 2 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 3 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 4 isOpen: 1 workingHours: - startHour: 36000 endHour: 57600 - day: 5 isOpen: 0 workingHours: - startHour: '' endHour: '' - day: 6 isOpen: 0 workingHours: - startHour: '' endHour: '' wholeWeekOperating: 0 hoursOfOperations: - day: 0 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 1 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 2 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 3 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 4 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 5 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 68400 - day: 6 isOpen: 1 workingHours: - startHour: 32400 endHour: 48600 - startHour: 52200 endHour: 64800 specialHours: - specialDate: 12/31/2020 startHour: 32400 endHour: 43200 isOpen: 0 - specialDate: 01/01/2021 startHour: '' endHour: '' isOpen: 1 businessStatus: Open reopenDate: 01/01/2021 keywords: HairSalons,DaySpas,BeautySalon,BeautySalons,Salons, MassageTherapists services: BeautySalon,HairSpa products: LivingProofDryShampoo,KevinMurphyBlondeAngelWash appointmentLink: http://www.gmail.com reservationLink: http://www.gmail.com menuLink: http://www.gmail.com orderAheadLink: http://www.gmail.com impressum: Thisissampleimpressum paymentTypes: - China Union Pay - Bitcoin - Cash Accepted - MasterCard - PayPal - Check / Cheque - Contactless Payment - Debit Card - Diners Club - JCB - Financing - Visa - American Express - Cash Only - Rupay - Credit Card - Discover additionalPaymentTypes: Visa,MasterCard,AmericanExpress,DebitCards,Check localPhoneNumber: "(973)716-0102" tollFreePhoneNumber: '' iosAppURL: http://www.gmail.com androidAppURL: http://www.gmail.com media: logoUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082646457/2816b900140211eb870e7bf4ed6bc766.png coverImageUrl: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082720956/GustavKlimtExpectationTreeoflifeArboldelaVidaFulfilment.jpeg gmbCover: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082807649/41cdeb014d36cb35f936152d44c4c77d.jpeg facebookCover: https://d1py4eyp5hehj0.cloudfront.net/upload/1334812/1718082871068/IJ8Sa5.jpeg optOut: gmbCoverOptOut: true gmbLogoOptOut: true fbCoverOptOut: false fbLogoOptOut: false gmbProfileOptOut: false businessProfileOptOut: false covidInfo: postDescription: SampleCovidDesc covid19SupportLink: http://www.covidInfo.com virtualCareLink: http://www.covidInfo.com bingListing: primaryCategoryBing: Art Restoration Service bingDescription: Sample Bing Description bingCategories: - Art Restoration Service bingPhoneNumber: "(415) 673-0868" internalListing: description: ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridic category: Beauty subCategories: - Eyelash Service - Nail Salons displayCategory: Eyelash Service facebookListing: facebookDescription: This is sample facebook description facebookPhoneNumber: "(415) 673-0868" categories: - Science - Sports thirdPartyListing: thirdPartyCategory: Towing Service thirdPartySubCategories: - Car Dealer - Auto Glass Shop gmbListing: googleWebsiteUrl: http://www.gmail.com googleStoreId: '1232133' googlePhoneNumber: "(973) 716-0007" primaryCategoryGmb: Fast Food Restaurant googleDescription: This is sample description for google additionalCategories: - Snack bar attributes: Accessibility: - attributeId: has_wheelchair_accessible_elevator attributeName: Wheelchair accessible elevator value: false Crowd: - attributeId: welcomes_families attributeName: Family-friendly value: true hotelAttributes: business: business: meetingRoomsCount: attributeId: meetingRoomsCount attributeName: Number of meeting rooms value: 20 policies: policies: checkinTime: attributeId: checkinTime attributeName: Check-In Time value: "14:00" checkoutTime: attributeId: checkoutTime attributeName: Check-Out Time value: "11:00" property: property: builtYear: attributeId: builtYear attributeName: Built Year value: 2010 services: services: frontDesk: attributeId: frontDesk attributeName: Front desk value: true giftShop: attributeId: giftShop attributeName: Gift shop value: false languagesSpoken: attributeId: languagesSpoken attributeName: Languages Spoken value: English,Spanish,French foodDelivery: https://www.ubereats.com foodTakeout: https://www.ubereats.com whatsappBusinessLink: https://wa.me/9737160007 textMessageNumber: 973716-0007 appleListing: primaryCategory: health_care.dentistry.dental_clinic.dentist appleWebsiteUrl: https://www.apple.com additionalCategories: - health_care.dentistry.dental_clinic.dentist.oral_surgeon appleLocationAttributes: crossbusiness.accessibility_features: - attributeId: accessible_elevator crossbusiness.family_kids: - attributeId: kidsclub - attributeId: parents_waitingarea appleActionLinks: - id: quicklinks.schedule_appointment deepLinkUrl: https://www.google.com appStoreUrl: https://apps.apple.com/your_apps_store_url phoneNumber: "+1 201-819-7989" appleBusinessName: This is sample business name appleBusinessDescription: This is sample business description socialProfileURLs: googleUrl: http://www.google.com/123 facebookUrl: http://www.facebook.com/123 twitterUrl: http://www.twitter.com/123 youTubeUrl: http://www.youtube.com/12 linkedinUrl: http://www.linkedin.com/12 instagramUrl: http://www.instagram.com/12 pintrestUrl: http://www.pinterest.com/12 bbbUrl: http://www.bbb.org/12 lendingtreeUrl: http://www.lendingtree.com/12 healthcare: doctorCategories: - Allergist-Immunologist > Allergy - Allergist-Immunologist > General - Addiction Medicine Specialist > General isProvider: true practiceName: General Medicine firstName: John middleName: Jack surName: Doe npi: '1245319599' credentials: MD university: Sample text hospitalAffiliations: Sample text insurancesAccepted: Sample text Apiary_getListing_Response200: type: object properties: businessInfo: type: object properties: name: type: string description: Name of the Business/Location. Should be Max 1000 characters long. phone: type: string description: Your official Business Phone number. Format is (xxx) xxx-xxxx. websiteUrl: type: string description: Business website url. emailId: type: string description: Business Email ID. isAddressHidden: type: string description: If your business doesn’t have a place for your customers to visit, then you can hide your street address. isServiceAreaProvider: type: string description: If you deliver or provide service at customer locations. mainBusinessDescription: type: string description: Business Description is optional. If this field is included with an empty value in the API request, the existing Business Description will be cleared for the location. If a value is provided, it must contain at least 200 characters. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. serviceAreas: type: array description: 'Locations where you deliver or provide service (applicable if isServiceAreaProvider is ''Yes'').NOTE: Maximum service areas that can be provided are 10.' items: type: object properties: description: type: string description: Area, City, State, Zip, Country. e.g. "1735 Berryessa Rd, San Jose, CA 95133, USA", “Onalaska, WI, USA”. placeId: type: string description: ChIJk8EIXIG3j4ARwL_Ao3ykdeQ location: type: object properties: address1: type: string description: Address of the business. address2: type: string description: Address of the business. city: type: string description: City (Max 1000 character long). state: type: string description: State (2 character state code). countryCode: type: string description: Country Code (2 character country code). zip: type: string description: Zip Code. subLocality: type: string description: "(Char 4-80) Mandatory for: New Zealand (Enter the Suburb) Other Countries: This field is not required. Any data entered here for countries outside of New Zealand will be ignored by the system." description: Business address required: - phone description: Business Information additionalInfo: type: object properties: establishedYear: type: number description: Year established timezone: type: string description: Timezone of the business. languages: type: array description: Languages. items: {} moreHours: description: 'Google more hours for specific services you offer such as delivery, takeout, drive-through, and pickup (see: Supported More Hours). Google more hours can only be added if google primary category is added. To get specific types of more hours, please refer to Get supported more hours type api. NOTE: In more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.' type: array items: {} appleMoreHours: description: 'Apple more hours for specific services you offer such as Dining, Bar and Delivery. Apple more hours can only be added if apple primary category is added. To get specific types of apple more hours, please refer to Get supported more hours type api. NOTE: In apple more hours, day 0 denotes Monday, day 1 denotes Tuesday, …, day 6 denotes Sunday.' type: array items: {} wholeWeekOperating: type: number description: Whether your business is open 24/7, Possible Values - 0 or 1. hoursOfOperations: type: array description: 'Regular hours: Regular working hours of the business for each day from Monday to Sunday.' items: type: object properties: day: type: number description: 0(Monday), 1(Tuesday), 2(Wednesday) and so on. workingHours: type: array items: type: object properties: startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) description: Working hours of the business isOpen: type: number description: 0 (Business closed today), 1 (open) comment: type: string description: Add the special instruction. specialHours: type: array description: For special holiday days, where you may have limited hours of operation and don’t want to change your preset regular hours. These would only be applicable only for the dates they are set for. items: type: object properties: specialDate: type: string description: It should be "MM/DD/YYYY". startHour: type: string description: Start hour 9:00 (9 AM), 18:00 (6 PM) endHour: type: string description: End hour 9:00 (9 AM), 18:00 (6 PM) isOpen: type: number description: 0(Business closed today), 1 (open) businessStatus: type: string description: The business status on the listing page can be set to Open, Temporarily Closed, Permanently Closed, or Opening Soon. A Reopen Date is mandatory for 'Temporarily Closed' and 'Opening Soon' statuses, while optional for 'Open'. reopenDate: type: string description: Reopen Date is required for the 'Temporarily Closed' and 'Opening Soon' statuses, and optional for 'Open.' The date must be in the 'MM/dd/yyyy' format. services: type: string description: Services offered by the business. Useful in SEO. (Comma separated list of services offered) Business services cannot be more than 1000 characters. keywords: type: string description: Important keywords related to the business. Useful in SEO. (Comma separated list of important keywords) Business keywords cannot be more than 1000 characters. products: type: string description: Products about the business. Useful in SEO and Business products cannot be more than 1000 characters. appointmentLink: type: string description: Let customers book appointments by redirecting them to your appointments page. reservationLink: type: string description: Let customers reserve tables by linking them to your reservations page. menuLink: type: string description: Show customers what you serve by linking them to your menu. orderAheadLink: type: string description: Let customers place delivery and pick-up orders by linking them to your ordering page. impressum: type: string description: In certain countries (like Austria, Germany and Switzerland), businesses may be required by law to include a statement of ownership on their web presence. paymentTypes: description: |- List of payment types accepted by the business. + (Members) + China Union Pay + Bitcoin + Cash Accepted + MasterCard + PayPal + Check / Cheque + Contactless Payment + Debit Card + Diners Club + JCB + Financing + Visa + American Express + Cash Only + Rupay + Credit Card + Discover type: array items: {} additionalPaymentTypes: type: string description: Additional Payment Type (Max 250 character long). localPhoneNumber: type: string description: Local phone number. tollFreePhoneNumber: type: string description: Tollfree number. androidAppURL: type: string description: Android app url. iosAppURL: type: string description: IOS app url. required: - hoursOfOperations - services description: Business Additional Information media: type: object properties: logoUrl: type: string description: 'This logo will pushed to your listings sites such as Google, Facebook, Bing, Birdeye and all the other secondary listings sites. Format: JPG, JPEG, PNG. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.' coverImageUrl: type: string description: 'This cover photo will pushed to your listings sites such as Birdeye and all the other secondary listings sites. Cover image URL for business will be displayed on custom review site. Format: JPG, JPEG, PNG. Minimum 1110 x 374px. 10 KB min.' gmbCover: type: string description: Google Cover Image Url. facebookCover: type: string description: Facebook Cover Image Url. description: Media details. optOut: type: object properties: gmbLogoOptOut: type: boolean description: Update profile photo on your google my business page. fbLogoOptOut: type: boolean description: Update profile photo on your facebook profile. gmbCoverOptOut: type: boolean description: Update cover photo on your google my business page. fbCoverOptOut: type: boolean description: Update cover photo on your facebook profile. gmbProfileOptOut: type: boolean description: Opt out from the google specific section on the profile page. businessProfileOptOut: type: boolean description: Opt out from the business profile section. description: Opt out section covidInfo: type: object properties: postDescription: type: string description: This information is posted and updated on your Google business profile page and your FB business page. covid19SupportLink: type: string description: Should be a valid covid19 support url virtualCareLink: type: string description: Should be a valid url virtual care link description: Provide this data for updating any COVID specific information you want to share with your customers. bingListing: type: object properties: primaryCategoryBing: type: string description: Primary category of bing. bingCategories: description: You can add a maximum of up to 3 categories. type: array items: {} bingPhoneNumber: type: string description: You can provide a phone number which will be pushed only to your Bing listing site and will override the primary phone number set. bingDescription: type: string description: An ‘About the business description’. Bing description cannot be more than 4096 characters. description: This data will be used to update your Bing listing. internalListing: type: object properties: description: type: string description: Microsite Override Business Description is optional. If this field is included with an empty value in the API request, the existing Microsite Override Business Description will be cleared for the location. Avoid sending URLs, phone numbers, addresses, or promotional content in this field. category: type: string description: Primary category of business. subCategories: description: You can add up to 3 subcategories. type: array items: {} displayCategory: type: string description: Choose one of the category either from primary category or from sub categories. required: - category - subCategories description: Provide data for microsite listing purpose. facebookListing: type: object properties: facebookPhoneNumber: type: string description: Phone number for facebook profile. This phone number will override the main phone number on your Facebook business page categories: description: You can add up to 3 categories. type: array items: {} facebookDescription: type: string description: An ‘about your business’ description. Facebook description cannot be more than 255 characters. description: This data will be used to update your Facebook business page/ listing. gmbListing: type: object properties: googleWebsiteUrl: type: string description: Website url will update on google listing. This website URL will override your existing website URL on your Google business profile. googlePhoneNumber: type: string description: You can provide a phone number which will be pushed only to your google listing site and will override the primary phone number set. googleStoreId: type: string description: Store id for google. primaryCategoryGmb: type: string description: Primary category of google. additionalCategories: description: You can add up to 9 subcategories. type: array items: {} googleDescription: type: string description: An ‘about your business’ description. Google description cannot be more than 750 characters. attributes: type: object properties: {} description: Google my business attributes are highly visible statements about your business that appear on your Google My Business listing. Supported attributes are hotelAttributes: type: object properties: {} description: Hotel attributes are key characteristics and amenities of your property that help guests discover and understand what your hotel offers. These attributes enhance your hotel's visibility and searchability across booking platforms and travel sites. Supported attribute categories are Services, Policies, FoodAndDrink, Pools, Wellness, Activities, Transportation, Families, Connectivity, Business, Accessibility, Pets, Parking, Housekeeping, HealthAndSafety, Sustainability, Property. Each attribute carries an attributeValueType field indicating the expected value format. Supported formats are BOOLEAN (true/false), INTEGER (positive number), YEAR (year string), TIME (HH:mm string), SINGLE_SELECT (one value from possibleValues), or MULTI_SELECT (comma-separated values from possibleValues). foodDelivery: type: string description: Enter the redirect URL where customers can place delivery orders.This field is applicable for hospitality business and is category dependent.Example http://www.ubereats.com foodTakeout: type: string description: 'Enter the redirect URL where customers can place ''takeout'' food orders. This field is applicable for hospitality business and is category dependent.Example : http://www.ubereats.com' whatsappBusinessLink: type: string description: Enter your WhatsApp Business link to display a direct chat option on your live Google Business Profile. This allows customers to easily message you. Example https://wa.me/ textMessageNumber: type: string description: Enter a valid phone number to enable a text message chat option on your live Google Business Profile, allowing customers to easily reach you via SMS. description: This data will be used to update your Google Business Profile/ listing. appleListing: type: object properties: phoneNumber: type: string description: This will be shown as the primary phoneNumber on your Apple maps place card and will replace/ override your business info phone number. appleWebsiteUrl: type: string description: Website url will update on apple listing. This website URL will override your existing website URL on your Apple Business Connect. primaryCategory: type: string description: Primary category Id for Apple. additionalCategories: description: Additional categories Id for Apple. type: array items: {} primaryCategoryName: type: string description: Primary category Name for Apple. additionalCategoriesNames: description: Additional categories Name for Apple. type: array items: {} appleLocationAttributes: type: object properties: {} description: 'Apple connect attributes are highly visible statements about your business that appear on your Apple Business listing. Few Apple Supported attributes are:' appleActionLinks: type: object properties: {} description: Apple actionLinks are shown on the Apple maps place card which helps users to access or redirect to some website or app store. These are typical CTA’s that you would like to expose to your potential customers. Apple action links can only be selected from pre-defined set of action links which you can get using the GET Action links API. appleBusinessName: type: string description: Business name shown on your Apple Business listing. Must be between 3 and 250 characters. appleBusinessDescription: type: string description: Business description shown on your Apple Business listing. Must be between 20 and 500 characters. description: This data will be used to update your Google Business Profile/ listing. thirdPartyListing: type: object properties: thirdPartyCategory: type: string description: 'Primary business category for third party listings. Note: This is a Mandatory field if vendor is applicable.' thirdPartySubCategories: type: string description: 'Additional sub categories. You can set a maximum of 3 sub categories. Note: This is a Mandatory field if thirdPartyCategory is available.' description: This data will be used to update your secondary listings sites. socialProfileURLs: type: object properties: facebookUrl: type: string description: Facebook URL. twitterUrl: type: string description: Business Twitter URL. linkedInUrl: type: string description: Business LinkedId URL. googleUrl: type: string description: Business Google URL. youTubeUrl: type: string description: Business Youtube URL. pintrestUrl: type: string description: Business Pinterest URL. bbbUrl: type: string description: Business BB URL. lendingtreeUrl: type: string description: Business Lending Tree URL. description: Profile URLs for business on top rated social sites healthcare: type: object properties: doctorCategories: type: array description: This is the doctor specific category your business belongs to. Please refer to the sheet "Doctor Specific Categories" to get the possible values. items: {} isProvider: type: boolean description: If provider then select value true. If practice then select value false. This is a true/false toggle for determining if the location is a provider or not. practiceName: type: string description: Name of the practice.Must be less than 191 characters. firstName: type: string description: First name of the provider. middleName: type: string description: Middle name of the provider. surName: type: string description: Surname of the provider npi: type: number description: National Provider Identifier - NPI. Must be 10 digits credentials: type: string description: University of the provider/practice. Must be less than 25 characters university: type: string description: University of the provider/practice. Must be less than 255 characters hospitalAffiliations: type: string description: Hospital Affiliations of the provider/practice. Must be less than 150 characters insurancesAccepted: type: string description: Insurance Accepted of the provider/practice. Must be less than 50 characters description: This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same. Apiary_getGoogleKeywordsCount_Response200: type: object properties: data: type: array items: type: object properties: label: type: string description: Business/location name. Total, for sum of all locations keyword count frequency: type: string description: Keywords count description: Returns business/location name along with its keywords count. Apiary_retrieveMenuDetails_Response200: type: array items: type: object properties: id: type: string description: Unique identifier of the record businessNumber: type: number description: Unique business ID accountNumber: type: number description: Account ID associated with the business menuDetails: type: object properties: name: type: string description: Business display name error: type: string description: Error details if retrieval failed menus: type: array items: type: object properties: cuisines: type: array items: {} description: List of cuisines served labels: type: array items: type: object properties: displayName: type: string description: type: string languageCode: type: string sections: type: array items: type: object properties: labels: type: array items: type: object properties: displayName: type: string description: type: string languageCode: type: string items: type: array items: type: object properties: labels: type: array items: type: object properties: displayName: type: string description: type: string languageCode: type: string attributes: type: object properties: price: type: object properties: currencyCode: type: string units: type: number nanos: type: number allergen: type: array items: {} dietaryRestriction: type: array items: {} nutritionFacts: type: object properties: calories: type: number fatContent: type: string proteinContent: type: string carbohydrateContent: type: string ingredients: type: array items: type: object properties: name: type: string servesNumPeople: type: number preparationMethods: type: array items: {} portionSize: type: object properties: amount: type: number unit: type: string mediaKeys: type: array items: {} options: type: array items: type: object properties: labels: type: array items: type: object properties: displayName: type: string description: type: string languageCode: type: string attributes: type: object properties: price: type: object properties: currencyCode: type: string units: type: number nanos: type: number businessNumber: type: number correlationId: type: string description: 456 (string) createdAt: type: string description: Creation timestamp updatedAt: type: string description: Last update timestamp crmName: type: string Apiary_getHotelAttributes_Response200: type: object properties: hotelAttributes: type: object properties: services: type: object properties: services: type: object properties: frontDesk: type: object properties: attributeId: type: string example: frontDesk description: Attribute Id. attributeName: type: string example: Front desk description: Attribute display name. columnId: type: number example: 20001 description: Internal column identifier. possibleValues: type: array items: type: object properties: value: type: boolean description: Possible attribute value. name: type: string description: Attribute value display name. description: Contains the list of possible values for the attribute. attributeValueType: type: string example: BOOLEAN description: Defines the expected value format for the attribute. enum: - BOOLEAN - INTEGER - YEAR - TIME - SINGLE_SELECT - MULTI_SELECT description: This is a dynamic field. Depends upon the hotel attributes supported for the selected business. Apiary_createProductListing_Request: type: object properties: businessNumbers: type: array description: Location numbers of enterprise locations. If empty all valid enterprise locations will be selected. items: {} title: type: string description: Product title. description: type: string imageLink: type: string description: Publicly accessible image URL. additionalImageLinks: type: array description: Additional public image URLs. items: {} brandName: type: string googleProductCategoryId: type: string description: Google product taxonomy ID. price: type: object properties: amount: type: string description: Decimal string. currencyCode: type: string description: ISO 4217 code. required: - amount - currencyCode salePrice: type: object properties: amount: type: string currencyCode: type: string required: - amount - currencyCode productSku: type: string description: Merchant SKU; if omitted, system may assign. productTypes: type: array description: Product categorization keywords. items: {} productUrl: type: string description: implant (string, optional) status: type: string description: 'Accepted values: `PUBLISH`, `DRAFT`.' required: - title - imageLink - googleProductCategoryId - price - status example: businessNumbers: - 145308764185002 - 145308769721320 title: Dental Implant description: The dental procedure for replacing missing teeth using implants. imageLink: https://example.com/images/dental-implant-main.jpg additionalImageLinks: - https://example.com/images/dental-implant-side.jpg - https://example.com/images/dental-implant-closeup.jpg brandName: SmileCare googleProductCategoryId: '123' price: amount: '1500.00' currencyCode: USD salePrice: amount: '1200.00' currencyCode: USD productSku: DENTAL-IMPLANT-001 productTypes: - Dental Services - Implants - Cosmetic Dentistry productUrl: https://example.com/products/dental-implant status: PUBLISH Apiary_createProductListing_Response200: type: object properties: productId: type: string description: Unique identifier for the product. code: type: number description: Error code. Present on validation failure. message: type: string description: Error message. Present on validation failure. data: type: object properties: errorAttributes: type: array items: type: object properties: type: type: string description: Type of validation error. message: type: string description: Validation error message. Apiary_updateProductListing_Response200: type: object properties: productId: type: string description: Unique identifier for the product. code: type: number description: Error code. Present on validation failure. message: type: string description: Error message. Present on validation failure. data: type: object properties: errorAttributes: type: array items: type: object properties: type: type: string description: Type of validation error. message: type: string description: Validation error message. Apiary_getListProductListing_Response200: type: object properties: response: type: array description: Product list items: type: object properties: productId: type: string productSku: type: string locationCount: type: number title: type: string description: type: string productUrl: type: string description: bragadiru.ro/preturi/ (string) imageLink: type: string additionalImageLinks: type: array items: {} videoUrl: type: string brandName: type: string googleProductCategoryId: type: string price: type: object properties: amount: type: string currencyCode: type: string productTypes: type: array items: {} salePrice: type: object properties: amount: type: string currencyCode: type: string status: type: string updatedOn: type: number description: Epoch time. updatedBy: type: string totalCount: type: number Apiary_getSearchAiCitations_Request: type: object properties: businessNumbers: type: string description: Comma-separated list of business numbers to retrieve the report for. aiModel: type: string description: Possible values are [**`CHATGPT`**, **`GEMINI`**, **`PERPLEXITY`**] theme: type: string description: Specifies the theme or category used to filter the report data. pageNo: type: string description: Specifies the page number for paginated results. Defaults to 1. pageSize: type: string description: Defines the number of records to be returned per page. Defaults to 25. startDate: type: string description: 'Start date for the report range (format: **`mm/dd/yyyy`**).' endDate: type: string description: 'End date for the report range (format: **`mm/dd/yyyy`**).' viewReportType: type: string description: 'Defines the level at which the report is generated. Allowed values: **`LOCATION_LEVEL`**, **`ACCOUNT_LEVEL`**' startDate - Start date for the report range (format: description: 'Start date for the report range (format: **`mm/dd/yyyy`**).' endDate - End date for the report range (format: description: 'End date for the report range (format: **`mm/dd/yyyy`**).' viewReportType - Defines the level at which the report is generated. Allowed values: description: 'Defines the level at which the report is generated. Allowed values: **`LOCATION_LEVEL`**, **`ACCOUNT_LEVEL`**' example: &2 businessNumbers: - 67348934989 - 327349434334 - 278237892323 aiModel: CHATGPT theme: Dental implants pageNo: 1 pageSize: 25 startDate: 03/01/2026 endDate: 03/31/2026 viewReportType: LOCATION_LEVEL Apiary_getSearchAiBusinesses_Request: type: object properties: businessNumbers: type: string description: Comma-separated list of business numbers to retrieve the report for. aiModel: type: string description: Possible values are [**`CHATGPT`**, **`GEMINI`**, **`PERPLEXITY`**] theme: type: string description: Specifies the theme or category used to filter the report data. pageNo: type: string description: Specifies the page number for paginated results. Defaults to 1. pageSize: type: string description: Defines the number of records to be returned per page. Defaults to 25. startDate: type: string description: 'Start date for the report range (format: **`mm/dd/yyyy`**).' endDate: type: string description: 'End date for the report range (format: **`mm/dd/yyyy`**).' viewReportType: type: string description: 'Defines the level at which the report is generated. Allowed values: **`LOCATION_LEVEL`**, **`ACCOUNT_LEVEL`**' startDate - Start date for the report range (format: description: 'Start date for the report range (format: **`mm/dd/yyyy`**).' endDate - End date for the report range (format: description: 'End date for the report range (format: **`mm/dd/yyyy`**).' viewReportType - Defines the level at which the report is generated. Allowed values: description: 'Defines the level at which the report is generated. Allowed values: **`LOCATION_LEVEL`**, **`ACCOUNT_LEVEL`**' example: *2 Apiary_getAccuracyReport_Request: type: object properties: businessNumbers: type: string description: Comma-separated list of business numbers to retrieve the report for. aiModels: type: string description: Comma-separated list of AI models to include in the report. Possible values are [**`CHATGPT`**, **`GEMINI`**, **`PERPLEXITY`**] startDate: type: string description: 'Start date for the report range (format: **`yyyy-MM-dd`**).' endDate: type: string description: 'End date for the report range (format: **`yyyy-MM-dd`**).' startDate - Start date for the report range (format: description: 'Start date for the report range (format: **`yyyy-MM-dd`**).' endDate - End date for the report range (format: description: 'End date for the report range (format: **`yyyy-MM-dd`**).' example: businessNumbers: - 177337970010644 - 177337970029743 aiModels: - CHATGPT - GEMINI - PERPLEXITY startDate: 2025-12-01 endDate: 2025-12-31 Apiary_getSentimentReport_Request: type: object properties: businessNumbers: type: string description: Comma-separated list of business numbers to retrieve the report for. aiModels: type: string description: Comma-separated list of AI models to include in the report. Possible values are [**`CHATGPT`**, **`GEMINI`**, **`PERPLEXITY`**] startDate: type: string description: 'Start date for the report range (format: **`yyyy-MM-dd`**).' endDate: type: string description: 'End date for the report range (format: **`yyyy-MM-dd`**).' viewReportType: type: string description: 'Defines the level at which the report is generated. Allowed values: **`LOCATION_LEVEL`**, **`ACCOUNT_LEVEL`**' startDate - Start date for the report range (format: description: 'Start date for the report range (format: **`yyyy-MM-dd`**).' endDate - End date for the report range (format: description: 'End date for the report range (format: **`yyyy-MM-dd`**).' viewReportType - Defines the level at which the report is generated. Allowed values: description: 'Defines the level at which the report is generated. Allowed values: **`LOCATION_LEVEL`**, **`ACCOUNT_LEVEL`**' example: businessNumbers: - 177337970010644 - 177337970029743 aiModels: - CHATGPT - GEMINI - PERPLEXITY startDate: 2026-03-01 endDate: 2026-03-31 viewReportType: LOCATION_LEVEL Apiary_createTicket_Request: type: object properties: externalId: type: number description: Public Review Id for which you want to create ticket, Mandatory and applicable for creating review ticket. assignedTo: type: string description: EmailId of the user to whom the ticket will be assigned. ticketType: type: string description: 'Type of ticket you want to create. Possible values:' customer: type: object properties: emailId: type: string description: Email id of the customer. firstName: type: string description: First name of the customer. lastName: type: string description: Last name of the customer. location: type: object properties: city: type: string description: City of the customer’s location. state: type: string description: State of the customer’s location. description: Location details of the customer. phone: type: number description: Phone number of the customer. description: Customer details for which ticket is created, Mandatory and applicable for untagged ticket description: type: string description: Description of the ticket. Applicable for untagged and survey ticket sourceType: type: string description: 'Source Type of the ticket. Applicable for untagged ticket Possible values:' surveyId: type: number description: Id of the survey for which we want to create a ticket. Applicable for survey ticket surveyResponseId: type: number description: Id of the survey response for which we want to create a ticket. Applicable for survey ticket additionalParams: type: array description: If you want to create tickets of survey for particular question and answer. Applicable for survey ticket items: type: object properties: answerId: type: number description: Id of any of the answers on the survey. Applicable for survey ticket questionId: type: number description: Id of any of the questions on the survey. Applicable for survey ticket required: - assignedTo - ticketType example: externalId: 3943351204239963000 assignedTo: pranav.singh@birdeye.com ticketType: review customer: emailId: test+4@yopmail.com firstName: Steve lastName: Smith location: city: Dallas state: Texas phone: '' description: Issue with the Store service sourceType: internal Apiary_updateTicket_Request: type: object properties: ticketUpdateMessages: type: array description: Update ticket. items: type: object properties: assignedTo: type: string description: New assignee of the ticket. ticketId: type: string description: Id of the ticket. ticketStatus: type: string description: Status to be changed. example: ticketUpdateMessages: - assignedTo: steve@ymail.com ticketId: '882382' ticketStatus: assigned userEmail: pranav.singh@birdeye.com Apiary_getAllTicketData_Request: type: object properties: assignees: type: array description: List of assignee email id. items: {} businessNumbers: type: array description: List of Location Business Numbers. items: {} fromDate: type: number description: Epoc start date. toDate: type: number description: Epoc end date. sourceAliases: type: array description: Source alias. items: {} sourceTypes: type: array description: Source Type. items: {} tagNames: type: array description: Tag assigned to any review ticket. items: {} ticketStatuses: type: array description: Filter tickets with status. items: {} ticketTypes: type: array description: List of ticket type, Possible values items: {} example: assignees: [] businessNumbers: [] fromDate: 1581230064000 sourceAliases: - '' sourceTypes: - phone - socialmedia - chat - internal tagNames: - newReview ticketStatuses: - assigned - new ticketTypes: - review - survey - untagged toDate: 1707460464000 Apiary_getAllTicketData_Response200: type: object properties: ticketDetails: type: array items: type: object properties: id: type: number description: Id of the ticket. status: type: string description: Ticket status. rating: type: number description: Review rating. externalId: type: string description: Public review id. description: type: string description: Description of the ticket. activityCount: type: number description: Number of activities associated with the ticket. assignedTo: type: object properties: firstName: type: string description: First Name of the assignee. lastName: type: string description: Last Name of the assignee. name: type: string description: Name of the assignee. emailId: type: string description: Email id of the assignee. description: Assignee details. source: type: object properties: name: type: string description: Source details description: Source details of the ticket ticketType: type: string description: Type of the ticket. tags: type: array items: {} description: List of Ticket tags. reporter: type: object properties: firstName: type: string description: First Name of the reporter lastName: type: string description: Last Name of the reporter description: Ticket reporter details. description: Ticket Details. Apiary_uploadSocialMedia_Request: type: object properties: media_urls: type: array description: List of publicly accessible image or video URLs. Maximum 50 items. Supported image extensions — .jpg, .jpeg, .png, .gif, .webp. Supported video extensions — .mp4, .mov, .avi, .mkv, .webm, .wmv. maxItems: 50 items: type: string folder_id: type: integer description: Optional media library folder ID to organize uploaded assets. If omitted, assets are placed in the default media library location. required: - media_urls example: media_urls: - https://example.com/video.mp4 Apiary_uploadSocialMedia_Response200: type: object properties: batch_id: type: string format: uuid description: Use this to poll the Track Upload Status endpoint for processing results. accepted_count: type: integer description: Number of URLs accepted into the batch. example: batch_id: e0de3eeb-1f52-45bd-9110-fb6b5cb966ad accepted_count: 1 Apiary_trackSocialMediaUpload_Response200: type: object properties: batch_id: type: string format: uuid description: Identifier for the batch. status: type: string description: "Overall batch status. Possible values: COMPLETED (all items\ \ processed successfully), PARTIALLY_COMPLETED (some succeeded, some failed),\ \ FAILED (all items failed), PENDING (processing still in progress —\ \ poll again)." enum: - COMPLETED - PARTIALLY_COMPLETED - FAILED - PENDING accepted_count: type: integer description: Total number of URLs submitted in the batch. success_count: type: integer description: Number of successfully uploaded items. failed_count: type: integer description: Number of failed items. pending_count: type: integer description: Number of items still processing. Poll again if greater than 0. items: type: array description: Per-item processing results. items: type: object properties: source_url: type: string description: The original URL submitted. status: type: string description: Item-level status. Possible values — SUCCESS or FAILED. enum: - SUCCESS - FAILED asset_id: type: integer description: Internal asset ID for use in post creation API. Present only on SUCCESS. cdn_url: type: string description: CDN-hosted URL of the uploaded media. Present only on SUCCESS. failure_reason: type: string description: Human-readable reason for failure. Present only on FAILED. example: batch_id: e0de3eeb-1f52-45bd-9110-fb6b5cb966ad status: COMPLETED accepted_count: 1 success_count: 1 failed_count: 0 pending_count: 0 items: - source_url: https://example.com/video.mp4 status: SUCCESS asset_id: 3457963 cdn_url: https://ddjkm7nmu27lx.cloudfront.net/.../video.mp4