> ## Documentation Index > Fetch the complete documentation index at: https://docs.birdeye.com/llms.txt > Use this file to discover all available pages before exploring further. # Review Response Rate By Location Overview > Review Response Rate By Location Overview API returns location-wise response-rate metrics. ## OpenAPI ````yaml api/openapi.yaml POST /v1/review/report/response-rate/by-location/overview openapi: 3.0.0 info: title: Birdeye version: 0.0.1 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"
    }
servers: - url: https://api.birdeye.com/resources security: [] 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. paths: /v1/review/report/response-rate/by-location/overview: post: tags: - Report summary: Review Response Rate By Location Overview description: >- Review Response Rate By Location Overview API returns location-wise response-rate metrics. operationId: reviewResponseRateByLocationOverview 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 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 components: requestBodies: 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 schemas: 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. 1167Model: type: object properties: code: type: number message: type: string example: code: 1167 message: API key is missing 1161Model: type: object properties: code: type: number message: type: string example: code: 1161 message: Invalid API key 89Model: type: object properties: code: type: number message: type: string example: code: 89 message: Rate limit exceeded ````