Get Experience Score Benchmark

Get Insight Experience Score Benchmark

curl --request POST \
  --url https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark \
  --header 'Content-Type: application/json' \
  --data '
{
  "reviewSources": [
    "Google",
    "Facebook",
    "CitySearch"
  ],
  "ratings": [
    "0",
    "1",
    "3",
    "4",
    "5"
  ],
  "businessNumbers": [
    172957184851864,
    174436684666401
  ],
  "startDate": "02/25/2025",
  "endDate": "02/01/2026"
}
'

import requests

url = "https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark"

payload = {
    "reviewSources": ["Google", "Facebook", "CitySearch"],
    "ratings": ["0", "1", "3", "4", "5"],
    "businessNumbers": [172957184851864, 174436684666401],
    "startDate": "02/25/2025",
    "endDate": "02/01/2026"
}
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({
    reviewSources: ['Google', 'Facebook', 'CitySearch'],
    ratings: ['0', '1', '3', '4', '5'],
    businessNumbers: [172957184851864, 174436684666401],
    startDate: '02/25/2025',
    endDate: '02/01/2026'
  })
};

fetch('https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark', 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/insight/experience/scoreBenchmark",
  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([
    'reviewSources' => [
        'Google',
        'Facebook',
        'CitySearch'
    ],
    'ratings' => [
        '0',
        '1',
        '3',
        '4',
        '5'
    ],
    'businessNumbers' => [
        172957184851864,
        174436684666401
    ],
    'startDate' => '02/25/2025',
    'endDate' => '02/01/2026'
  ]),
  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/insight/experience/scoreBenchmark"

	payload := strings.NewReader("{\n  \"reviewSources\": [\n    \"Google\",\n    \"Facebook\",\n    \"CitySearch\"\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}")

	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/insight/experience/scoreBenchmark")
  .header("Content-Type", "application/json")
  .body("{\n  \"reviewSources\": [\n    \"Google\",\n    \"Facebook\",\n    \"CitySearch\"\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark")

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  \"reviewSources\": [\n    \"Google\",\n    \"Facebook\",\n    \"CitySearch\"\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}"

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

{
  "actual": {
    "sentimentScore": 83.2,
    "reputationScore": 73.2,
    "experienceScore": 68.9,
    "listingScore": 36.5,
    "industrySentimentScore": 89.7,
    "industryReputationScore": 86,
    "industryExperienceScore": 87.8
  },
  "compare": {
    "sentimentScore": 80,
    "reputationScore": 72.8,
    "experienceScore": 67.7,
    "listingScore": 36.5
  }
}

{
  "code": 2003,
  "message": "businessNumbers are mandatory"
}

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

{
  "code": 1011,
  "message": "Business id is invalid"
}

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

POST

insight

experience

scoreBenchmark

Get Insight Experience Score Benchmark

curl --request POST \
  --url https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark \
  --header 'Content-Type: application/json' \
  --data '
{
  "reviewSources": [
    "Google",
    "Facebook",
    "CitySearch"
  ],
  "ratings": [
    "0",
    "1",
    "3",
    "4",
    "5"
  ],
  "businessNumbers": [
    172957184851864,
    174436684666401
  ],
  "startDate": "02/25/2025",
  "endDate": "02/01/2026"
}
'

import requests

url = "https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark"

payload = {
    "reviewSources": ["Google", "Facebook", "CitySearch"],
    "ratings": ["0", "1", "3", "4", "5"],
    "businessNumbers": [172957184851864, 174436684666401],
    "startDate": "02/25/2025",
    "endDate": "02/01/2026"
}
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({
    reviewSources: ['Google', 'Facebook', 'CitySearch'],
    ratings: ['0', '1', '3', '4', '5'],
    businessNumbers: [172957184851864, 174436684666401],
    startDate: '02/25/2025',
    endDate: '02/01/2026'
  })
};

fetch('https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark', 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/insight/experience/scoreBenchmark",
  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([
    'reviewSources' => [
        'Google',
        'Facebook',
        'CitySearch'
    ],
    'ratings' => [
        '0',
        '1',
        '3',
        '4',
        '5'
    ],
    'businessNumbers' => [
        172957184851864,
        174436684666401
    ],
    'startDate' => '02/25/2025',
    'endDate' => '02/01/2026'
  ]),
  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/insight/experience/scoreBenchmark"

	payload := strings.NewReader("{\n  \"reviewSources\": [\n    \"Google\",\n    \"Facebook\",\n    \"CitySearch\"\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}")

	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/insight/experience/scoreBenchmark")
  .header("Content-Type", "application/json")
  .body("{\n  \"reviewSources\": [\n    \"Google\",\n    \"Facebook\",\n    \"CitySearch\"\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/insight/experience/scoreBenchmark")

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  \"reviewSources\": [\n    \"Google\",\n    \"Facebook\",\n    \"CitySearch\"\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}"

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

{
  "actual": {
    "sentimentScore": 83.2,
    "reputationScore": 73.2,
    "experienceScore": 68.9,
    "listingScore": 36.5,
    "industrySentimentScore": 89.7,
    "industryReputationScore": 86,
    "industryExperienceScore": 87.8
  },
  "compare": {
    "sentimentScore": 80,
    "reputationScore": 72.8,
    "experienceScore": 67.7,
    "listingScore": 36.5
  }
}

{
  "code": 2003,
  "message": "businessNumbers are mandatory"
}

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

{
  "code": 1011,
  "message": "Business id is invalid"
}

{
  "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] User associated businessNumber.

Body

application/json

businessNumbers

any[]

required

List of business numbers (max 100).

startDate

string

required

Start date in MM/DD/YYYY format.

endDate

string

required

End date in MM/DD/YYYY format.

reviewSources

any[]

Review sources to include.

ratings

any[]

Rating values to filter.

Response

actual

object

Current performance metrics

Show child attributes

compare

object

Comparison period metrics

Show child attributes

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

Get Experience Score Benchmark

Headers

Body

Response