Update your Google Business Profile API integration before critical endpoints are disabled. Review the deprecation schedule and instructions to avoid disruptions starting in April 2022.
The Business Profile Performance API is now launched! Migration work is required.

Method: locations.getDailyMetricsTimeSeries

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

string

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

enum (DailyMetric)

Required. The metric to retrieve time series.

dailyRange

object (DailyRange)

Required. The timerange for which the time series will be fetched.

dailySubEntityType

object (DailySubEntityType)

Optional. The Sub-entity type and id that the time series relates to.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Represents the response for locations.getDailyMetricsTimeSeries.

JSON representation
{
  "timeSeries": {
    object (TimeSeries)
  }
}
Fields
timeSeries

object (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.

DailyMetric

Represents all available daily metrics for a business.

Enums
DAILY_METRIC_UNKNOWN Represents the default unknown value.
BUSINESS_IMPRESSIONS_DESKTOP_MAPS 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_MOBILE_MAPS 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_CONVERSATIONS The number of message conversations received on the business profile.
BUSINESS_DIRECTION_REQUESTS The number of times a direction request was requested to the business location.
CALL_CLICKS The number of times the business profile call button was clicked.
WEBSITE_CLICKS The number of times the business profile website was clicked.
BUSINESS_BOOKINGS The number of bookings received from the business profile.
BUSINESS_FOOD_ORDERS The number of food orders received from the business profile.

DailyRange

Time range indicating a date range (both inclusive).

JSON representation
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
startDate

object (Date)

Required. Inclusive

endDate

object (Date)

Required. Inclusive

DailySubEntityType

Represents all possible subentity types that are associated with DailyMetrics.

JSON representation
{

  // Union field Type can be only one of the following:
  "dayOfWeek": enum (DayOfWeek),
  "timeOfDay": {
    object (TimeOfDay)
  }
  // End of list of possible types for union field Type.
}
Fields
Union field Type. Represents that only one of the following proto fields must be present. Type can be only one of the following:
dayOfWeek

enum (DayOfWeek)

Represents the day of the week. Eg: MONDAY.

timeOfDay

object (TimeOfDay)

Represents the time of the day in 24 hour format. Eg: 13:34:20

DayOfWeek

Represents a day of the week.

Enums
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

JSON representation
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Fields
hours

integer

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer

Minutes of hour of day. Must be from 0 to 59.

seconds

integer

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

nanos

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

TimeSeries

Represents a timeseries.

JSON representation
{
  "datedValues": [
    {
      object (DatedValue)
    }
  ]
}
Fields
datedValues[]

object (DatedValue)

List of datapoints in the timeseries, where each datapoint is a date-value pair.

DatedValue

Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.

JSON representation
{
  "date": {
    object (Date)
  },
  "value": string
}
Fields
date

object (Date)

The date that the datapoint corresponds to. This represents a month value if the day field is not set.

value

string (int64 format)

The value of the datapoint.