Birdeye

Birdeye Report API

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

GitHub OpenAPI
Business capability
Customer Feedback Management BC-430.50

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/reports/smb Get small-business dashboard data · Get Dashboard data #
Ask an LLM
“Can I get the summary dashboard numbers for a small business?”
“What does the SMB dashboard report include?”
Tell an agent
Get dashboard data for business {bid}.
Show the SMB dashboard for {bid}.
GET /v1/reports/business/analytics/email Get the review request conversion report · Get Review conversion report #
Ask an LLM
“What is my review request conversion rate for recent days or months?”
“Can I get the email review conversion report for a date range?”
Tell an agent
Get the review conversion report for {businessId} from {fromDate} to {toDate}.
Show review conversion for {businessId} over the last {days} days.
POST /v1/reports/review/analytic/time Trend review count and rating over time · Review and rating over time Report #
Ask an LLM
“How have my review count and average rating changed over time?”
“Can I trend ratings by review source over the past days?”
Tell an agent
Get the review and rating over time report for {businessId}.
Trend reviews and ratings for {businessId} over the last {days} days by sources {sourceAliases}.
POST /v1/reports/rating/location Compare reviews and rating by location · Reviews & Rating By Location Report #
Ask an LLM
“Which locations have the most reviews and highest ratings?”
“Can I rank locations by rating over the last few months?”
Tell an agent
Get reviews and rating by location for {businessId}.
Rank locations of {businessId} by {sortby} over the last {months} months.
POST /v1/review/report/count-by-rating/{BusinessId} Count reviews by star rating · Review Count & Rating #
Ask an LLM
“How many reviews did I get at each star rating?”
“Can I get review counts by rating for a specific source?”
Tell an agent
Get review count by rating for {BusinessId} from {fromDate} to {toDate}.
Break down {BusinessId} reviews by star rating for source {sourceAlias}.
POST /v1/review/report/count-by-rating/employee/{BusinessId} Count reviews and ratings by employee · Review Count & Rating By Employee #
Ask an LLM
“How many reviews and what ratings does each employee have?”
“Can I filter the employee review report to certain staff?”
Tell an agent
Get review count and rating by employee for {BusinessId}.
Show employee review ratings for {employees} at {BusinessId}.
POST /v1/keywords/opmetric/location Get review insight categories by location · Insights Category Report by location report #
Ask an LLM
“How do my locations compare on insight categories from review content?”
“Can I get category insights per location for certain review sites?”
Tell an agent
Get the insights category report by location for {businessId}.
Show category insights per location for {businessNumbers} under {businessId} from {startDate} to {endDate}.
POST /v2/competitive/ranking Get the competitive ranking report · Competitive Ranking Report #
Ask an LLM
“Where do I rank against competitors on reviews?”
“Can I limit the competitive ranking to specific review sites?”
Tell an agent
Get the competitive ranking report for {businessId}.
Show competitive ranking for {businessId} from {startDate} to {endDate} on {reviewSites}.
POST /v1/reports/nps/time/elst Trend Net Promoter Score over time · NPS Over time Report #
Ask an LLM
“How has my Net Promoter Score changed over time?”
“Can I see NPS movement for a custom date range?”
Tell an agent
Get NPS over time for {businessId}.
Trend NPS for {businessId} between {startDate} and {endDate}.
POST /v1/reports/nps/location/elst Compare Net Promoter Score by location · NPS By Location Report #
Ask an LLM
“Which locations have the highest NPS?”
“Can I compare NPS across specific locations?”
Tell an agent
Get NPS by location for {businessId}.
Compare NPS for locations {businessNumbers} under {businessId}.
POST /v1/reports/count/reviewsite Count reviews by review site · Review By Source Report #
Ask an LLM
“Which review sites bring in the most reviews?”
“Can I count reviews per source over recent months?”
Tell an agent
Get the review by source report for {businessId}.
Count reviews per site for {businessId} over the last {months} months.
POST /v1/reports/count/visitors Get visitor counts · Visitor report #
Ask an LLM
“How many visitors did my locations get by source?”
“Can I get visitor counts for the past few months?”
Tell an agent
Get the visitor report for {businessId}.
Show visitor counts for {businessId} over the last {months} months.
POST /v1/reports/usage Get a usage report · Usage report #
Ask an LLM
“Can I get a usage report as a summary or a table?”
“What usage data is available for a business over a period?”
Tell an agent
Get the {reportType} usage report for {business_id} starting at {sindex}, count {count}.
Pull usage for {business_id} from {startDate} to {endDate}, {reportType} view, index {sindex}, count {count}.
POST /v1/review/report/response-rate/time/rate-over-time Trend review response rate over time · Review Response Rate Over Time #
Ask an LLM
“How has my review response rate trended?”
“Can I compare response rate over time with a previous period?”
Tell an agent
Get review response rate over time for {businessNumbers}.
Trend response rate from {startDate} to {endDate} compared by {comparisonFilter}.
POST /v1/review/report/response-rate/by-location/overview Compare review response rate by location · Review Response Rate By Location Overview #
Ask an LLM
“Which locations respond to the most reviews?”
“Can I sort locations by review response rate?”
Tell an agent
Get the response rate by location overview for {businessNumbers}.
Rank locations by response rate from {startDate} to {endDate}.
POST /v1/review/report/avg-response-time/by-location Compare average review response time by location · Average Response Time By Location #
Ask an LLM
“Which locations take the longest to reply to reviews?”
“Can I sort locations by average response time?”
Tell an agent
Get average review response time by location sorted by {sortBy}.
Show response time per location for {businessNumbers}, sorted by {sortBy}.
POST /v1/review/report/avg-response-time/time Trend average review response time · Average Response Time Over Time #
Ask an LLM
“Is our average review response time getting faster over time?”
“Can I trend response time for low-star reviews only?”
Tell an agent
Get average response time over time for {businessNumbers}.
Trend review reply time from {startDate} to {endDate} for ratings {ratings}.

Documentation

📖
Documentation
https://docs.birdeye.com/api/introduction
📖
Authentication
https://docs.birdeye.com/api/authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/birdeye/openapi/birdeye-report-api-openapi.yml

Other Resources

🔗
Vocabulary
https://artifacts.apis.io/birdeye/vocabulary/birdeye-vocabulary.yml
🔗
JSONLDContext
https://artifacts.apis.io/birdeye/json-ld/birdeye-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/birdeye:birdeye-report-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

birdeye-report-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Birdeye Report API
  version: '1.0'
  description: 'Operations tagged Report across 2 of this provider''s published API definitions: birdeye-birdeye-api-openapi.yml, birdeye-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.birdeye.com
  description: Production
- url: https://api.birdeye.com/resources
tags:


# --- truncated at 32 KB (62 KB total) ---
# Full source: https://artifacts.apis.io/birdeye/openapi/birdeye-report-api-openapi.yml