The Business Profile Performance API is now launched! Migration work is required.
Review the deprecation schedule and instructions to migrate over to new v1 APIs from older deprecated v4 API.
Help us improve the food menu experience by filling in this survey to better understand what place, menu, and dish attributes you can provide about the merchants you support

Method: locations.searchkeywords.impressions.monthly.list

Stay organized with collections Save and categorize content based on your preferences.

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?monthlyRange.start_month.year=2022&monthlyRange.start_month.month=1&monthlyRange.end_month.year=2022&monthlyRange.end_month.month=3

HTTP request

GET https://businessprofileperformance.googleapis.com/v1/{parent=locations/*}/searchkeywords/impressions/monthly

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

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
monthlyRange

object (MonthlyRange)

Required. The range in months to aggregate the search keywords impressions over.

pageSize

integer

Optional. The number of results requested. The default page size is 100. Page size can be set to a maximum of 100.

pageToken

string (bytes format)

Optional. A token indicating the next paginated result to be returned.

A base64-encoded string.

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 monthly.list.

JSON representation
{
  "searchKeywordsCounts": [
    {
      object (SearchKeywordCount)
    }
  ],
  "nextPageToken": string
}
Fields
searchKeywordsCounts[]

object (SearchKeywordCount)

Search terms which have been used to find a business.

nextPageToken

string (bytes format)

A token indicating the last paginated result returned. This can be used by succeeding requests to get the next "page" of keywords. It will only be present when there are more results to be returned.

A base64-encoded string.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

MonthlyRange

Time range indicating a month range (both inclusive).

JSON representation
{
  "startMonth": {
    object (Date)
  },
  "endMonth": {
    object (Date)
  }
}
Fields
startMonth

object (Date)

Required. Inclusive - Only the year and months fields will be considered

endMonth

object (Date)

Required. Inclusive - Only the year and months fields will be considered

SearchKeywordCount

Represents a single search keyword and its value.

JSON representation
{
  "searchKeyword": string,
  "insightsValue": {
    object (InsightsValue)
  }
}
Fields
searchKeyword

string

The lower-cased string that the user entered.

insightsValue

object (InsightsValue)

One of either: 1) The sum of the number of unique users that used the keyword in a month, aggregated for each month requested. 2) A threshold that indicates that the actual value is below this threshold.

InsightsValue

Represents an insights value.

JSON representation
{

  // Union field InsightsValue can be only one of the following:
  "value": string,
  "threshold": string
  // End of list of possible types for union field InsightsValue.
}
Fields
Union field InsightsValue. Represents that only one of the following proto fields must be present. InsightsValue can be only one of the following:
value

string (int64 format)

Represents the actual value.

threshold

string (int64 format)

Represents the threshold below which the actual value falls.