Google Business Performance API: Get Google Business Profile Location Performance
The Google Business Performance API endpoint described here returns Google Business Profile location performance for a connected location over a trailing window. It reports website clicks, call clicks, direction requests, messages as conversations, bookings, and profile impressions split by Search and Maps and by desktop and mobile, with an optional per-day time series when daily is set to true.
Get Google Business Profile location performance — exact contract summary
Use GET {{API_BASE_URL}}/v1/googlebusiness/performance to retrieve location-level performance for a connected Google Business Profile over a trailing window. The response keeps a unified metrics shape with impressions total and clicks, and adds a Google Business-specific breakdown with every breakdown metric. Pass daily=true for a per-day time series in daily. Only location-level metrics are available because per-post Google Business analytics were deprecated in 2024 according to the source contract. The source states a cost of 1 credit for this call.
Authorization
Send the access key in the x-access-key header. The header name is accessKey in the source contract, the location is header, and the value format is shown as <token>. If authentication fails, expect a 401 response with the preserved error shape described in the status matrix. Do not substitute a different authorization header for this endpoint.
Query Parameters
The required query parameter is accountId, a string containing the integration ID of the connected Google Business Profile location. The optional days parameter is an integer for the trailing window in days, defaulting to 28, with a range of 1 <= value <= 540. The optional daily parameter is a boolean, defaulting to false, and includes a per-day time series in daily when set to true. Validate accountId presence, days range, and daily type before calling, because invalid values map to the 400 status in the contract.
Response Body
See the worked request example titled Request example: location performance with required accountId for the exact origin-modular request, and the 200 response example titled 200 response example: metrics, breakdown and daily for the full success body. The success body contains success, days, metrics, breakdown and daily. The metrics object uses the unified shape, while breakdown contains websiteClicks, callClicks, directionRequests, conversations, bookings and impressions with desktopSearch, mobileSearch, desktopMaps, mobileMaps and total. When daily=true, each daily entry contains date, websiteClicks, callClicks, directionRequests, conversations, bookings, impressionsDesktopSearch, impressionsMobileSearch, impressionsDesktopMaps and impressionsMobileMaps.
200 application/json
For a 200 application/json response, check success first, then read days to confirm the trailing window that was applied. Use metrics for the unified impressions and clicks view, and use breakdown for the Google Business-specific action counts and impressions split. Treat metrics values as number or null where the typed contract declares number | null, and treat avgWatchTime, totalWatchTime and skipRate as optional fields. The daily field is declared as array<object> | null in the typed contract, so handle both an array and null without assuming a new rule.
400 application/json
A 400 application/json response uses the preserved shape with success and message. The source does not supply specific message strings for this status, so client code should surface message as returned and check the request parameters, especially accountId, days and daily, before retrying.
401 application/json
A 401 application/json response uses the preserved shape with success and message. The source does not supply specific message strings for this status, so client code should verify the x-access-key header value and surface message as returned.
402 application/json
A 402 application/json response uses the preserved shape with success and message. The source does not supply specific message strings for this status, so client code should surface message as returned and not invent a credit or billing interpretation beyond the numeric status.
404 application/json
A 404 application/json response uses the preserved shape with success and message. The source does not supply specific message strings for this status, so client code should surface message as returned and verify that accountId identifies a connected Google Business Profile location.
502 application/json
A 502 application/json response uses the preserved shape with success and message. The source does not supply specific message strings or retry semantics for this status, so client code should surface message as returned and avoid assuming retry behavior that is not in the contract.
Choosing days and daily, and location-level scope
Choose days based on the comparison you need: the default 28 is suitable for a recent trailing window, while larger values up to 540 extend the window within the stated range. Choose daily=true when you need to see which days drove websiteClicks, callClicks, directionRequests, conversations, bookings or impressions, and leave daily=false for aggregate reporting. Always scope the call to one connected location via accountId, and interpret impressions through breakdown.impressions rather than through per-post data, which is not available from this endpoint.
| Parameter | Required | Type | Default | Constraints / notes |
|---|---|---|---|---|
| accountId | Required (*) | string | — | Integration ID of the connected Google Business Profile location. |
| days | Optional (?) | integer | 28 | Trailing window in days; range 1 <= value <= 540. |
| daily | Optional (?) | boolean | false | Include a per-day time series in daily when true. |
Exact source contract preserved; origin replaced only by {{API_BASE_URL}}.
| Field | Type | Required | Notes |
|---|---|---|---|
| success | boolean | Required | Top-level success flag. |
| days | integer | Required | Trailing window applied. |
| metrics | object | Required | Unified shape: impressions, reach, likes, comments, shares, saves, clicks, views, engagementRate as number | null; avgWatchTime, totalWatchTime, skipRate optional number | null. |
| breakdown | object | Required | Google Business-specific breakdown described below. |
| daily | array<object> | null | Required | Per-day time series when daily=true; typed contract also allows null. |
Typed contract preserved, including number | null metrics fields and optional watch-time fields.
| Field | Type | Required | Notes |
|---|---|---|---|
| breakdown.websiteClicks | integer | Required | Website clicks in breakdown. |
| breakdown.callClicks | integer | Required | Call clicks in breakdown. |
| breakdown.directionRequests | integer | Required | Direction requests in breakdown. |
| breakdown.conversations | integer | Required | Messages (conversations) in breakdown. |
| breakdown.bookings | integer | Required | Bookings in breakdown. |
| breakdown.impressions.desktopSearch | integer | Required | Desktop Search impressions. |
| breakdown.impressions.mobileSearch | integer | Required | Mobile Search impressions. |
| breakdown.impressions.desktopMaps | integer | Required | Desktop Maps impressions. |
| breakdown.impressions.mobileMaps | integer | Required | Mobile Maps impressions. |
| breakdown.impressions.total | integer | Required | Total impressions in breakdown. |
| daily[].date | string | Required | Date for the daily entry. |
| daily[].websiteClicks / callClicks / directionRequests / conversations / bookings | integer | Required | Per-day action counts. |
| daily[].impressionsDesktopSearch / impressionsMobileSearch / impressionsDesktopMaps / impressionsMobileMaps | integer | Required | Per-day impressions split fields. |
Exact field names preserved from source contract.
| Status | Content type | Response shape | Notes |
|---|---|---|---|
| 200 | application/json | success, days, metrics, breakdown, daily | Success body as in the 200 response example. |
| 400 | application/json | success, message | Error shape preserved; no invented message text. |
| 401 | application/json | success, message | Error shape preserved; no invented message text. |
| 402 | application/json | success, message | Error shape preserved; no invented message text. |
| 404 | application/json | success, message | Error shape preserved; no invented message text. |
| 502 | application/json | success, message | Error shape preserved; no invented message text. |
Only numeric status and {success, message} shape preserved; message strings not supplied in source.
Frequently asked questions
How do I choose days and daily for Google Business Profile location performance?
Use the required accountId for the connected Google Business Profile location, choose days for the trailing window (default 28, range 1 to 540), and set daily=true only when you need the per-day time series in the daily field. Check breakdown for websiteClicks, callClicks, directionRequests, conversations, bookings and impressions split by desktopSearch, mobileSearch, desktopMaps and mobileMaps.
What is the difference between metrics and breakdown in the response?
The metrics object keeps the unified shape, including impressions and clicks, while breakdown carries the Google Business-specific counts. Treat nullable metrics fields as number or null, and note that avgWatchTime, totalWatchTime and skipRate are optional in the typed contract.
Can this endpoint return per-post Google Business performance?
Only location-level metrics are available. Per-post Google Business analytics were deprecated in 2024 according to the source contract, so do not expect per-post performance fields from this endpoint.
curl -X GET "{{API_BASE_URL}}/v1/googlebusiness/performance?accountId=string" -H "x-access-key: <token>"{
"success": true,
"days": 0,
"metrics": {
"impressions": 0,
"reach": 0,
"likes": 0,
"comments": 0,
"shares": 0,
"saves": 0,
"clicks": 0,
"views": 0,
"engagementRate": 0,
"avgWatchTime": 0,
"totalWatchTime": 0,
"skipRate": 0
},
"breakdown": {
"websiteClicks": 0,
"callClicks": 0,
"directionRequests": 0,
"conversations": 0,
"bookings": 0,
"impressions": {
"desktopSearch": 0,
"mobileSearch": 0,
"desktopMaps": 0,
"mobileMaps": 0,
"total": 0
}
},
"daily": [
{
"date": "string",
"websiteClicks": 0,
"callClicks": 0,
"directionRequests": 0,
"conversations": 0,
"bookings": 0,
"impressionsDesktopSearch": 0,
"impressionsMobileSearch": 0,
"impressionsDesktopMaps": 0,
"impressionsMobileMaps": 0
}
]
}{
"success": true,
"message": "string"
}| Scope | Field | Type | Type reference | Required | Description |
|---|---|---|---|---|---|
| response#1 | response | object | __0 | ||
| response#1 | response.success | boolean | __1 | Yes | |
| response#1 | response.days | integer | __2 | Yes | |
| response#1 | response.metrics | object | __3 | Yes | |
| response#1 | response.metrics.impressions | number | null | __4 | Yes | |
| response#1 | response.metrics.impressions[variant1] | number | __4_type:number | ||
| response#1 | response.metrics.impressions[variant2] | null | __4_type:null | ||
| response#1 | response.metrics.reach | number | null | __5 | Yes | |
| response#1 | response.metrics.reach[variant1] | number | __5_type:number | ||
| response#1 | response.metrics.reach[variant2] | null | __5_type:null | ||
| response#1 | response.metrics.likes | number | null | __6 | Yes | |
| response#1 | response.metrics.likes[variant1] | number | __6_type:number | ||
| response#1 | response.metrics.likes[variant2] | null | __6_type:null | ||
| response#1 | response.metrics.comments | number | null | __7 | Yes | |
| response#1 | response.metrics.comments[variant1] | number | __7_type:number | ||
| response#1 | response.metrics.comments[variant2] | null | __7_type:null | ||
| response#1 | response.metrics.shares | number | null | __8 | Yes | |
| response#1 | response.metrics.shares[variant1] | number | __8_type:number | ||
| response#1 | response.metrics.shares[variant2] | null | __8_type:null | ||
| response#1 | response.metrics.saves | number | null | __9 | Yes | |
| response#1 | response.metrics.saves[variant1] | number | __9_type:number | ||
| response#1 | response.metrics.saves[variant2] | null | __9_type:null | ||
| response#1 | response.metrics.clicks | number | null | __10 | Yes | |
| response#1 | response.metrics.clicks[variant1] | number | __10_type:number | ||
| response#1 | response.metrics.clicks[variant2] | null | __10_type:null | ||
| response#1 | response.metrics.views | number | null | __11 | Yes | |
| response#1 | response.metrics.views[variant1] | number | __11_type:number | ||
| response#1 | response.metrics.views[variant2] | null | __11_type:null | ||
| response#1 | response.metrics.engagementRate | number | null | __12 | Yes | Engagement rate (0-1). null when the platform does not report engagement. |
| response#1 | response.metrics.engagementRate[variant1] | number | __12_type:number | Engagement rate (0-1). null when the platform does not report engagement. | |
| response#1 | response.metrics.engagementRate[variant2] | null | __12_type:null | Engagement rate (0-1). null when the platform does not report engagement. | |
| response#1 | response.metrics.avgWatchTime | number | null | __13 | No | Instagram Reels only. Average watch time per view, in seconds. null for other media/platforms. |
| response#1 | response.metrics.avgWatchTime[variant1] | number | __13_type:number | Instagram Reels only. Average watch time per view, in seconds. null for other media/platforms. | |
| response#1 | response.metrics.avgWatchTime[variant2] | null | __13_type:null | Instagram Reels only. Average watch time per view, in seconds. null for other media/platforms. | |
| response#1 | response.metrics.totalWatchTime | number | null | __14 | No | Instagram Reels only. Total watch time in seconds, including replays. Meta flags this metric as in development, so it may be null. |
| response#1 | response.metrics.totalWatchTime[variant1] | number | __14_type:number | Instagram Reels only. Total watch time in seconds, including replays. Meta flags this metric as in development, so it may be null. | |
| response#1 | response.metrics.totalWatchTime[variant2] | null | __14_type:null | Instagram Reels only. Total watch time in seconds, including replays. Meta flags this metric as in development, so it may be null. | |
| response#1 | response.metrics.skipRate | number | null | __15 | No | Instagram Reels only. Reels skip rate as reported by Meta (reels_skip_rate, added Dec 2025) — the share of views that skipped past the reel. null for other media/platforms or when Meta has no value yet. |
| response#1 | response.metrics.skipRate[variant1] | number | __15_type:number | Instagram Reels only. Reels skip rate as reported by Meta (reels_skip_rate, added Dec 2025) — the share of views that skipped past the reel. null for other media/platforms or when Meta has no value yet. | |
| response#1 | response.metrics.skipRate[variant2] | null | __15_type:null | Instagram Reels only. Reels skip rate as reported by Meta (reels_skip_rate, added Dec 2025) — the share of views that skipped past the reel. null for other media/platforms or when Meta has no value yet. | |
| response#1 | response.breakdown | object | __16 | Yes | |
| response#1 | response.breakdown.websiteClicks | integer | __17 | Yes | |
| response#1 | response.breakdown.callClicks | integer | __18 | Yes | |
| response#1 | response.breakdown.directionRequests | integer | __19 | Yes | |
| response#1 | response.breakdown.conversations | integer | __20 | Yes | |
| response#1 | response.breakdown.bookings | integer | __21 | Yes | |
| response#1 | response.breakdown.impressions | object | __22 | Yes | |
| response#1 | response.breakdown.impressions.desktopSearch | integer | __23 | Yes | |
| response#1 | response.breakdown.impressions.mobileSearch | integer | __24 | Yes | |
| response#1 | response.breakdown.impressions.desktopMaps | integer | __25 | Yes | |
| response#1 | response.breakdown.impressions.mobileMaps | integer | __26 | Yes | |
| response#1 | response.breakdown.impressions.total | integer | __27 | Yes | |
| response#1 | response.daily | array<object> | null | __28 | Yes | |
| response#1 | response.daily[variant1] | array<object> | __28_extends:__29 | ||
| response#1 | response.daily[variant1][] | object | __30 | ||
| response#1 | response.daily[variant1][].date | string | __31 | Yes | |
| response#1 | response.daily[variant1][].websiteClicks | integer | __32 | Yes | |
| response#1 | response.daily[variant1][].callClicks | integer | __33 | Yes | |
| response#1 | response.daily[variant1][].directionRequests | integer | __34 | Yes | |
| response#1 | response.daily[variant1][].conversations | integer | __35 | Yes | |
| response#1 | response.daily[variant1][].bookings | integer | __36 | Yes | |
| response#1 | response.daily[variant1][].impressionsDesktopSearch | integer | __37 | Yes | |
| response#1 | response.daily[variant1][].impressionsMobileSearch | integer | __38 | Yes | |
| response#1 | response.daily[variant1][].impressionsDesktopMaps | integer | __39 | Yes | |
| response#1 | response.daily[variant1][].impressionsMobileMaps | integer | __40 | Yes | |
| response#1 | response.daily[variant2] | null | __28_extends:__41 | ||
| response#2 | response | object | __0 | ||
| response#2 | response.success | boolean | __1 | Yes | |
| response#2 | response.message | string | __2 | Yes |