Get business profile metrics
GET/api/v2/presence/analytics/metrics
Get business profile metrics
Request
Query Parameters
- before a field to order_by DESC, nothing for ASC
Filter by date
Return all the analytics whose date >= given_date.
Filter by date.
Return all the analytics whose filter_date <= given_date.
Possible values: [business_impressions_desktop_maps, business_impressions_desktop_search, business_impressions_mobile_maps, business_impressions_mobile_search, business_direction_requests, call_clicks, website_clicks]
List of analytics to return. At least one in that list.
Where the object is either a dimension or a metric and is used in the request. At most one in the list.
Filter by city
Parameter to fuzzy search businesses on city, zipcode and name.
Filter by business ids
Filter by all allowed businesses except the ones given in
Possible values: >= 1
The page number you want to request.
The value defaults to 1, when it is not included.
Possible values: >= 1 and <= 500
The maximum number of result items to return in a page.
The value defaults to 500, when it is not included.
Responses
- 200
- 400
- 401
- 403
- 404
This endpoint lets you view the Google Business Profile analytics for all your businesses subscribed to Presence Management. The API allows you to select what data you're interested in, and how you want it aggregated (daily, monthly, by business, etc.). You can also filter the results to limit it to a certain date range, and to certain business.
Google Business Profile doesn't provide reliable data for the most recent 5 days.
You can choose the analytics you want to get among:
- impressions: desktop maps impressions, mobile maps impressions, desktop search impressions, and mobile search impressions
- actions: website link clicks, phone calls, and driving directions
You can use the following filters:
- by businesses (businesses id in list or not in list)
- by date (analytics before and/or after a date)
- by business query. Will return matches for the business name, zipcode or city
- by business city.
The response can be aggregated by:
- business id
- by date: either by day, week, month or year
- by both business id and date
The response can be ordered in ascending or descending order by any of the selected dimensions or metrics. See examples for more details.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
metrics
object[]
First day of the aggregation
Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.
Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.
Business impressions on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.
Business impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.
The number of times a direction request was requested to the business location.
Customers who call your business
Customers who click on your website link
Time aggregation requested
Business id
Current page number
Last page number
Number of resources complying with filters
{
"metrics": [
{
"date": "2019-11-05",
"business_impressions_desktop_maps": 123,
"business_impressions_mobile_maps": 123,
"business_impressions_desktop_search": 123,
"business_impressions_mobile_search": 123,
"business_direction_requests": 123,
"call_clicks": 123,
"website_clicks": 123,
"bucket": "day",
"business_id": "5409c35a97bbc544d8e26737"
}
],
"page": 1,
"max_page": 10,
"count": 287
}