AI-generated Key Takeaways
-
Retrieves daily time series data for a specified location and metric within a given date range.
-
Requires specifying the location ID, daily metric, and start and end dates as parameters.
-
Optionally allows filtering by sub-entity type and ID for supported metrics.
-
Returns a JSON response containing a time series object with daily values for the requested metric.
-
Needs authorization with the
https://www.googleapis.com/auth/business.manage
scope.
Returns the values for each date from a given time range that are associated with the specific daily metric.
Example request: GET
https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&dailyRange.start_date.year=2022&dailyRange.start_date.month=1&dailyRange.start_date.day=1&dailyRange.end_date.year=2022&dailyRange.end_date.month=3&dailyRange.end_date.day=31
HTTP request
GET https://businessprofileperformance.googleapis.com/v1/{name=locations/*}:getDailyMetricsTimeSeries
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The location for which the time series should be fetched. Format: locations/{locationId} where locationId is an unobfuscated listing id. |
Query parameters
Parameters | |
---|---|
dailyMetric |
Required. The metric to retrieve time series. |
dailyRange |
Required. The timerange for which the time series will be fetched. |
dailySubEntityType |
Optional. The Sub-entity type and id that the time series relates to. Currently supported DailyMetrics = NONE. |
Request body
The request body must be empty.
Response body
Represents the response for locations.getDailyMetricsTimeSeries.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"timeSeries": {
object ( |
Fields | |
---|---|
timeSeries |
The daily time series. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.