Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1331219.2 KB
locations

Returns the values for each date from a given time range that are associated with the specific daily metric. Note: Only daily data is available. Hourly metrics are not supported. Example request: GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31

get/v1/{+name}:getDailyMetricsTimeSeries

Path parameters

namestring required

Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.

Query parameters

dailyMetric'DAILY_METRIC_UNKNOWN' | 'BUSINESS_IMPRESSIONS_DESKTOP_MAPS' | 'BUSINESS_IMPRESSIONS_DESKTOP_SEARCH' | 'BUSINESS_IMPRESSIONS_MOBILE_MAPS' | 'BUSINESS_IMPRESSIONS_MOBILE_SEARCH' | 'BUSINESS_CONVERSATIONS' | 'BUSINESS_DIRECTION_REQUESTS' | 'CALL_CLICKS' | 'WEBSITE_CLICKS' | 'BUSINESS_BOOKINGS' | 'BUSINESS_FOOD_ORDERS' | 'BUSINESS_FOOD_MENU_CLICKS'

Required. The metric to retrieve time series.

dailyRange.endDate.dayinteger

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

dailyRange.endDate.monthinteger

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

dailyRange.endDate.yearinteger

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

dailyRange.startDate.dayinteger

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

dailyRange.startDate.monthinteger

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

dailyRange.startDate.yearinteger

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

dailySubEntityType.dayOfWeek'DAY_OF_WEEK_UNSPECIFIED' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'

Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.

dailySubEntityType.timeOfDay.hoursinteger

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

dailySubEntityType.timeOfDay.minutesinteger

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

dailySubEntityType.timeOfDay.nanosinteger

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

dailySubEntityType.timeOfDay.secondsinteger

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

Response

Successful response