Review Response Rate Over Time

curl --request POST \
  --url https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'

import requests

url = "https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time"

payload = {
    "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"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time"

	payload := strings.NewReader("{\n  \"reviewSites\": [\n    2,\n    1,\n    110,\n    100\n  ],\n  \"ratings\": [\n    \"0\",\n    \"1\",\n    \"3\",\n    \"4\",\n    \"5\"\n  ],\n  \"businessNumbers\": [\n    172957184851864,\n    174436684666401\n  ],\n  \"startDate\": \"02/25/2025\",\n  \"endDate\": \"02/01/2026\",\n  \"comparisonFilter\": {\n    \"startDate\": \"01/01/2025\",\n    \"endDate\": \"01/10/2025\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time")
  .header("Content-Type", "application/json")
  .body("{\n  \"reviewSites\": [\n    2,\n    1,\n    110,\n    100\n  ],\n  \"ratings\": [\n    \"0\",\n    \"1\",\n    \"3\",\n    \"4\",\n    \"5\"\n  ],\n  \"businessNumbers\": [\n    172957184851864,\n    174436684666401\n  ],\n  \"startDate\": \"02/25/2025\",\n  \"endDate\": \"02/01/2026\",\n  \"comparisonFilter\": {\n    \"startDate\": \"01/01/2025\",\n    \"endDate\": \"01/10/2025\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reviewSites\": [\n    2,\n    1,\n    110,\n    100\n  ],\n  \"ratings\": [\n    \"0\",\n    \"1\",\n    \"3\",\n    \"4\",\n    \"5\"\n  ],\n  \"businessNumbers\": [\n    172957184851864,\n    174436684666401\n  ],\n  \"startDate\": \"02/25/2025\",\n  \"endDate\": \"02/01/2026\",\n  \"comparisonFilter\": {\n    \"startDate\": \"01/01/2025\",\n    \"endDate\": \"01/10/2025\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "summary": {
    "actual": {
      "totalCount": 94,
      "avgRating": 4.2,
      "responseRate": 5,
      "unrespondedRate": 95,
      "unrespondedCount": 89,
      "respondedCount": 5,
      "unrespondedCountGrowth": 89.4,
      "respondedCountGrowth": 400,
      "totalCountGrowth": 95.8,
      "responseRateGrowth": 150
    },
    "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,
        "totalCountGrowth": 0,
        "responseRateGrowth": 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
}

{
  "code": 1167,
  "message": "API key is missing"
}

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

{
  "code": 89,
  "message": "Rate limit exceeded"
}

POST

review

report

response-rate

time

rate-over-time

Review Response Rate Over Time

curl --request POST \
  --url https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'

import requests

url = "https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time"

payload = {
    "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"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time"

	payload := strings.NewReader("{\n  \"reviewSites\": [\n    2,\n    1,\n    110,\n    100\n  ],\n  \"ratings\": [\n    \"0\",\n    \"1\",\n    \"3\",\n    \"4\",\n    \"5\"\n  ],\n  \"businessNumbers\": [\n    172957184851864,\n    174436684666401\n  ],\n  \"startDate\": \"02/25/2025\",\n  \"endDate\": \"02/01/2026\",\n  \"comparisonFilter\": {\n    \"startDate\": \"01/01/2025\",\n    \"endDate\": \"01/10/2025\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time")
  .header("Content-Type", "application/json")
  .body("{\n  \"reviewSites\": [\n    2,\n    1,\n    110,\n    100\n  ],\n  \"ratings\": [\n    \"0\",\n    \"1\",\n    \"3\",\n    \"4\",\n    \"5\"\n  ],\n  \"businessNumbers\": [\n    172957184851864,\n    174436684666401\n  ],\n  \"startDate\": \"02/25/2025\",\n  \"endDate\": \"02/01/2026\",\n  \"comparisonFilter\": {\n    \"startDate\": \"01/01/2025\",\n    \"endDate\": \"01/10/2025\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/review/report/response-rate/time/rate-over-time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reviewSites\": [\n    2,\n    1,\n    110,\n    100\n  ],\n  \"ratings\": [\n    \"0\",\n    \"1\",\n    \"3\",\n    \"4\",\n    \"5\"\n  ],\n  \"businessNumbers\": [\n    172957184851864,\n    174436684666401\n  ],\n  \"startDate\": \"02/25/2025\",\n  \"endDate\": \"02/01/2026\",\n  \"comparisonFilter\": {\n    \"startDate\": \"01/01/2025\",\n    \"endDate\": \"01/10/2025\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "summary": {
    "actual": {
      "totalCount": 94,
      "avgRating": 4.2,
      "responseRate": 5,
      "unrespondedRate": 95,
      "unrespondedCount": 89,
      "respondedCount": 5,
      "unrespondedCountGrowth": 89.4,
      "respondedCountGrowth": 400,
      "totalCountGrowth": 95.8,
      "responseRateGrowth": 150
    },
    "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,
        "totalCountGrowth": 0,
        "responseRateGrowth": 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
}

{
  "code": 1167,
  "message": "API key is missing"
}

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

{
  "code": 89,
  "message": "Rate limit exceeded"
}

Headers

string

e.g. application/json

x-api-key

string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

x-business-number

string

e.g. [Required] Business number of the location.

Body

application/json

reviewSites

any[]

List of review site IDs.

ratings

any[]

Ratings to include in the report.

businessNumbers

any[]

List of business numbers.

startDate

string

Start date in MM/dd/YYYY format.

endDate

string

End date in MM/dd/YYYY format.

comparisonFilter

object

Comparison date range.

Show child attributes

Response

summary

object

Show child attributes

dataPoints

any[]

Time-series points for actual and comparison periods.

dateDiff

number

Date range difference.

groupByType

string

Grouping unit used in data points.

dataPresent

boolean

Indicates whether report data is present.

Overview

Business

Custom Fields

User

Reviews

Contact

Contact V2

Campaign

Aggregation

Report

Survey

Business Media

Social

Employee

Conversation

Subscription

Webhook

Competitor

Competitor AI

Insight AI

Google Q&A

Google Services

FAQ

Listing

GMB Products

Search AI

Ticketing

Integration

Review Response Rate Over Time

Headers

Body

Response