How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Birdeye Report API

Various reporting data points across Birdeye modules like reviews, insights and competitors etc for all your data visualisation

Birdeye Report API is one of 27 APIs that Birdeye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Report. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 17 operations across 17 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.birdeye.com, https://api.birdeye.com/resources.

17 operations 17 paths 20 schemas 2 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.birdeye.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Birdeye Report API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey).

  • apiKey — Partner specific API key provided by Birdeye for data exchange.

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 2 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

Report 17

Various reporting data points across Birdeye modules like reviews, insights and competitors etc for all your data visualisation

GET
/v1/reports/smb
Get Dashboard data
get-dashboard-data 1 param → 200
GET
/v1/reports/business/analytics/email
Get Review conversion report
get-review-conversion-report 5 params → 200
POST
/v1/reports/review/analytic/time
Review and rating over time Report
review-and-rating-over-time-report 3 params body → 200
POST
/v1/reports/rating/location
Reviews & Rating By Location Report
reviews-rating-by-location-report 3 params body → 200
POST
/v1/review/report/count-by-rating/{BusinessId}
Review Count & Rating
review-count-rating 1 param body → 200
POST
/v1/review/report/count-by-rating/employee/{BusinessId}
Review Count & Rating By Employee
review-count-rating-by-employee 1 param body → 200
POST
/v1/keywords/opmetric/location
Insights Category Report by location report
insights-category-report-by-location-report 1 param body → 200
POST
/v2/competitive/ranking
Competitive Ranking Report
competitive-ranking-report 1 param body → 200
POST
/v1/reports/nps/time/elst
NPS Over time Report
nps-over-time-report 1 param body → 200
POST
/v1/reports/nps/location/elst
NPS By Location Report
nps-by-location-report 1 param body → 200
POST
/v1/reports/count/reviewsite
Review By Source Report
review-by-source-report 1 param body → 200
POST
/v1/reports/count/visitors
Visitor report
visitor-report 1 param body → 200
POST
/v1/reports/usage
Usage report
usage-report 4 params body → 200
POST
/v1/review/report/response-rate/time/rate-over-time
Review Response Rate Over Time
review-response-rate-over-time body → 200
POST
/v1/review/report/response-rate/by-location/overview
Review Response Rate By Location Overview
review-response-rate-by-location-overview 4 params body → 200
POST
/v1/review/report/avg-response-time/by-location
Average Response Time By Location
average-response-time-by-location 4 params body → 200
POST
/v1/review/report/avg-response-time/time
Average Response Time Over Time
average-response-time-over-time body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Apiary_nPSByLocationReport_Response200 (11 properties), Apiary_competitiveRankingReport_Response200 (10 properties), Apiary_nPSOverTimeReport_Response200 (8 properties), Apiary_reviewResponseRateOverTime_Response200 (5 properties). Each schema is shown below with its type and property counts.

Apiary_reviewBySourceReport_Response200
array
Apiary_reviewCount_Rating_Response200
object
2 properties
1039Model
object
2 properties
Apiary_averageResponseTimeOverTime_Response200
object
5 properties
Apiary_reviewCount_RatingByEmployee_Response200
object
1 property
Apiary_reviewAndRatingOverTimeReport_Response200
array
89Model
object
2 properties
Apiary_visitorReport_Response200
array
1161Model
object
2 properties
Apiary_nPSOverTimeReport_Response200
object
8 properties
Apiary_insightsCategoryReportByLocationReport_Response200
array
Apiary_averageResponseTimeByLocation_Response200
object
5 properties
Apiary_reviewResponseRateOverTime_Response200
object
5 properties
Apiary_reviewResponseRateByLocationOverview_Response200
object
3 properties
Apiary_nPSByLocationReport_Response200
object
11 properties
1011Model
object
2 properties
Apiary_competitiveRankingReport_Response200
object
10 properties
1167Model
object
2 properties
Apiary_getReviewConversionReport_Response200
object
5 properties
Apiary_reviewCount_RatingByEmployee_Request
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

birdeye-report-api-openapi.yml Raw ↑

Other APIs Birdeye publishes across the network.

Birdeye Aggregation API
Birdeye Business API
Birdeye Business Media API
Birdeye Campaign API
Birdeye Competitor AI API
Birdeye Competitor API
Birdeye Contact API
Birdeye Contact V2 API
Birdeye Conversation API
Birdeye Custom Fields API
Birdeye Employee API
Birdeye FAQ API
Where this information came from

This is an independent, third-party profile of Birdeye Report API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.