From fffa828adb2019692c3c50982129b434e14bac50 Mon Sep 17 00:00:00 2001 From: Nikhil Pandey Date: Mon, 9 Mar 2026 12:32:09 +0530 Subject: [PATCH 1/2] benchmark and locationinfo apis doc added --- apiary.apib | 174 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 174 insertions(+) diff --git a/apiary.apib b/apiary.apib index d5fd698..34766b0 100644 --- a/apiary.apib +++ b/apiary.apib @@ -14096,6 +14096,180 @@ This API retrieves competitor metrics review data (average rating and total revi [1167][] +# Insight AI +Insight intelligence, simplified by AI. + +## Insight Experience Score Benchmark [/v1/api/insight/experience/scoreBenchmark] +Insight Experience Score Benchmark API retrieves benchmark scores comparing actual performance against industry standards and specified comparison periods for sentiment, reputation, experience, and listing metrics. + +### Get Insight Experience Score Benchmark [POST] + ++ Request (application/json) + + + Headers + + + x-api-key: (string, required) - API key for authentication + + x-business-number: (number, required) - Business number identifier + + + Attributes + + + reviewSources (array[string], optional) - Review sources to include (e.g., Google, Facebook, CitySearch) + + ratings (array[string], optional) - Rating values to filter (0-5) + + businessNumbers (array[number], 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 + + + Body + + { + "reviewSources": ["Google", "Facebook", "CitySearch"], + "ratings": ["0", "1", "3", "4", "5"], + "businessNumbers": [172957184851864, 174436684666401], + "startDate": "02/25/2025", + "endDate": "02/01/2026" + } + ++ Response 200 (application/json) + + + Attributes + + + actual (object) - Current performance metrics + + sentimentScore (number) - Actual sentiment score + + reputationScore (number) - Actual reputation score + + experienceScore (number) - Actual experience score + + listingScore (number) - Actual listing score + + industrySentimentScore (number) - Industry benchmark sentiment score + + industryReputationScore (number) - Industry benchmark reputation score + + industryExperienceScore (number) - Industry benchmark experience score + + compare (object) - Comparison period metrics + + sentimentScore (number) - Comparison sentiment score + + reputationScore (number) - Comparison reputation score + + experienceScore (number) - Comparison experience score + + listingScore (number) - Comparison listing score + + + Body + + { + "actual": { + "sentimentScore": 83.2, + "reputationScore": 73.2, + "experienceScore": 68.9, + "listingScore": 36.5, + "industrySentimentScore": 89.7, + "industryReputationScore": 86.0, + "industryExperienceScore": 87.8 + }, + "compare": { + "sentimentScore": 80.0, + "reputationScore": 72.8, + "experienceScore": 67.7, + "listingScore": 36.5 + } + } + ++ Response 401 + [1161][] + ++ Response 429 + [89][] + ++ Response 404 + [1011][] + ++ Response 401 + [1167][] + + +## Insight Experience Location Info [/v1/api/insight/experience/locationInfo] +Insight Experience Location Info API retrieves location-wise experience metrics including sentiment, reputation, experience, and listing scores along with delta comparisons for specified business locations and date ranges. + +### Get Insight Experience Location Info [POST] + ++ Request (application/json) + + + Headers + + + x-api-key (string, required) - API key for authentication + + x-business-number (number, required) - Business number identifier + + + Attributes + + + reviewSources (array[string], optional) - List of review sources to filter (e.g., Google, Facebook, CitySearch) + + ratings (array[string], optional) - List of rating values to filter (e.g., 0, 1, 3, 4, 5) + + businessNumbers (array[number], required) - List of business location identifiers (maximum 100 allowed) + + startDate (string, required) - Start date in MM/DD/YYYY format + + endDate (string, required) - End date in MM/DD/YYYY format + + + Body + + { + "reviewSources": ["Google","Facebook","CitySearch"], + "ratings": ["0", "1", "3", "4", "5"], + "businessNumbers": [172957184851864, 174436684666401], + "startDate": "02/25/2025", + "endDate": "02/01/2026" + } + + ++ Response 200 (application/json) + + + Attributes + + + totalCount (number) - Total number of locations returned + + dataPoints (array) - Array of location experience metrics + + id (number) - Location business number + + name (string) - Location name + + experienceScore (number) - Current experience score + + listingScore (number) - Current listing score + + sentimentScore (number) - Current sentiment score + + reputationScore (number) - Current reputation score + + experienceDeltaScore (number) - Previous period experience score + + listingDeltaScore (number) - Previous period listing score + + sentimentDeltaScore (number) - Previous period sentiment score + + reputationDeltaScore (number) - Previous period reputation score + + experienceDelta (number) - Change in experience score + + listingDelta (number) - Change in listing score + + reputationDelta (number) - Change in reputation score + + sentimentDelta (number) - Change in sentiment score + + + Body + + { + "totalCount": 2, + "dataPoints": [ + { + "id": 149546078883527, + "name": "194 - Greywolf Veterinary Hospital", + "experienceScore": 93.1, + "listingScore": 86.7, + "sentimentScore": 96.2, + "reputationScore": 93.8, + "experienceDeltaScore": 93, + "listingDeltaScore": 86, + "sentimentDeltaScore": 96, + "reputationDeltaScore": 93, + "experienceDelta": 0.1, + "listingDelta": 0.7, + "reputationDelta": 0.8, + "sentimentDelta": 0.2 + } + ] + } + + ++ Response 401 + [1167][] + ++ Response 429 + [1027][] + ++ Response 404 + [2151][] + ++ Response 400 + [2150][] + + # Group Google Q&A > __Note__ From bb6c6781aecaa23b5974593da908e5fccc44b535 Mon Sep 17 00:00:00 2001 From: Nikhil Pandey Date: Tue, 10 Mar 2026 11:24:02 +0530 Subject: [PATCH 2/2] issues fixed --- apiary.apib | 55 ++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 17 deletions(-) diff --git a/apiary.apib b/apiary.apib index 34766b0..ab9f286 100644 --- a/apiary.apib +++ b/apiary.apib @@ -14096,7 +14096,7 @@ This API retrieves competitor metrics review data (average rating and total revi [1167][] -# Insight AI +# Group Insight AI Insight intelligence, simplified by AI. ## Insight Experience Score Benchmark [/v1/api/insight/experience/scoreBenchmark] @@ -14108,16 +14108,19 @@ Insight Experience Score Benchmark API retrieves benchmark scores comparing actu + Headers - + x-api-key: (string, required) - API key for authentication - + x-business-number: (number, required) - Business number identifier + Accept: application/json + x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange. + x-business-number: [Required] User associated businessNumber. + + Attributes - + reviewSources (array[string], optional) - Review sources to include (e.g., Google, Facebook, CitySearch) - + ratings (array[string], optional) - Rating values to filter (0-5) - + businessNumbers (array[number], 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: Google,Facebook,CitySearch (array[number])- Review sources to include. + + ratings: 0,1,3,4,5 (array[string], optional) - Rating values to filter. + + businessNumbers: 172957184851864,174436684666401 (array[number], required) - List of business numbers (max 100). + + startDate: 02/25/2025 (string, required) - Start date in MM/DD/YYYY format. + + endDate: 02/01/2026 (string, required) - End date in MM/DD/YYYY format. + + Body @@ -14189,16 +14192,17 @@ Insight Experience Location Info API retrieves location-wise experience metrics + Headers - + x-api-key (string, required) - API key for authentication - + x-business-number (number, required) - Business number identifier + Accept: application/json + x-api-key: [Required] Partner specific API key provided by Birdeye for data exchange. + x-business-number: [Required] User associated businessNumber. + Attributes - + reviewSources (array[string], optional) - List of review sources to filter (e.g., Google, Facebook, CitySearch) - + ratings (array[string], optional) - List of rating values to filter (e.g., 0, 1, 3, 4, 5) - + businessNumbers (array[number], required) - List of business location identifiers (maximum 100 allowed) - + startDate (string, required) - Start date in MM/DD/YYYY format - + endDate (string, required) - End date in MM/DD/YYYY format + + reviewSources (array[string], optional) - List of review sources to filter (e.g., Google, Facebook, CitySearch) + + ratings (array[string], optional) - List of rating values to filter (e.g., 0, 1, 3, 4, 5) + + businessNumbers (array[number], required) - List of business location identifiers (maximum 100 allowed) + + startDate (string, required) - Start date in MM/DD/YYYY format + + endDate (string, required) - End date in MM/DD/YYYY format + Body @@ -14215,8 +14219,9 @@ Insight Experience Location Info API retrieves location-wise experience metrics + Attributes - + totalCount (number) - Total number of locations returned - + dataPoints (array) - Array of location experience metrics + + totalCount (number) - Total number of locations returned + + dataPoints (array) - Array of location experience metrics + + (object) + id (number) - Location business number + name (string) - Location name + experienceScore (number) - Current experience score @@ -14252,6 +14257,22 @@ Insight Experience Location Info API retrieves location-wise experience metrics "listingDelta": 0.7, "reputationDelta": 0.8, "sentimentDelta": 0.2 + }, + { + "id": 149546078886677, + "name": "The animal hospital", + "experienceScore": 93.1, + "listingScore": 86.7, + "sentimentScore": 96.2, + "reputationScore": 93.8, + "experienceDeltaScore": 93, + "listingDeltaScore": 86, + "sentimentDeltaScore": 96, + "reputationDeltaScore": 93, + "experienceDelta": 0.1, + "listingDelta": 0.7, + "reputationDelta": 0.8, + "sentimentDelta": 0.2 } ] }