APIHub
Back to Explore

Business Profile Performance API

The Business Profile Performance API allows merchants to fetch performance reports about their business profile on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.

Analytics
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/{location}:fetchMultiDailyMetricsTimeSeries

Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_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`

  • location (path, required) — Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.
  • dailyMetrics (query) — Required. The metrics to retrieve time series for.
  • dailyRange.endDate.day (query) — 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.month (query) — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • dailyRange.endDate.year (query) — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • dailyRange.startDate.day (query) — 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.month (query) — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • dailyRange.startDate.year (query) — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
GET

/v1/{name}: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&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`

  • name (path, required) — Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.
  • dailyMetric (query) — Required. The metric to retrieve time series.
  • dailyRange.endDate.day (query) — 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.month (query) — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • dailyRange.endDate.year (query) — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • dailyRange.startDate.day (query) — 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.month (query) — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • dailyRange.startDate.year (query) — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • dailySubEntityType.dayOfWeek (query) — Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.
  • dailySubEntityType.timeOfDay.hours (query) — 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.
  • dailySubEntityType.timeOfDay.minutes (query) — Minutes of hour of day. Must be from 0 to 59.
  • dailySubEntityType.timeOfDay.nanos (query) — Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
  • dailySubEntityType.timeOfDay.seconds (query) — 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.
GET

/v1/{parent}/searchkeywords/impressions/monthly

Returns the search keywords used to find a business in search or maps. Each search keyword is accompanied by impressions which are aggregated on a monthly basis. Example request: `GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.start_month.year=2022&monthly_range.start_month.month=1&monthly_range.end_month.year=2022&monthly_range.end_month.month=3`

  • parent (path, required) — Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.
  • monthlyRange.endMonth.day (query) — 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.
  • monthlyRange.endMonth.month (query) — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • monthlyRange.endMonth.year (query) — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • monthlyRange.startMonth.day (query) — 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.
  • monthlyRange.startMonth.month (query) — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • monthlyRange.startMonth.year (query) — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • pageSize (query, limit) — Optional. The number of results requested. The default page size is 100. Page size can be set to a maximum of 100.
  • pageToken (query) — Optional. A token indicating the next paginated result to be returned.

3 endpoints auto-detected

curl -X GET \
  "https://businessprofileperformance.googleapis.com/v1/{location}:fetchMultiDailyMetricsTimeSeries"

businessprofileperformance.googleapis.com · HTTPS only