Skip to main content

Get business profile keywords

GET 
/api/v2/presence/analytics/keywords

Get business profile keywords

Request​

Query Parameters

    filter_date__gte date

    Filter by date

    Return all the analytics whose date >= given_date.

    filter_date__lte date

    Filter by date.

    Return all the analytics whose filter_date <= given_date.

    metrics string[]required

    Possible values: [count, threshold]

    List of analytics to return. At least one in that list.

    Example: [count, threshold]
    dimensions string[]

    Possible values: [business, keyword, month, year]

    How the returned data will be aggregated. At most 'business' and one time dimensions of the list. If no dimension is given, the request will return the sum of each metric for all requested days and businesses.

    Example: [keyword, month]
    order_by string

    Where the object is either a dimension or a metric and is used in the request. At most one in the list.

    • before a field to order_by DESC, nothing for ASC
    Example: -count
    business__in string[]

    Filter by business ids

    Example: [5409c35a97bbc544d8e26737]
    business__notin string[]

    Filter by all allowed businesses except the ones given in

    Example: [5409c35a97bbc544d8e26737]
    page number

    Possible values: >= 1

    The page number you want to request.

    The value defaults to 1, when it is not included.

    per_page number

    Possible values: >= 1 and <= 500

    The maximum number of result items to return in a page.

    The value defaults to 500, when it is not included.

Responses​

This endpoint lets you view the monthly Google Business Profile search keywords for all your businesses subscribed to Presence Management.

To access the analytics of a business, you need to:

  • have READ access on it
  • have subscribed to Presence Management for this business.
  • You can access the search keywords from Google Business Profile.

The analytics on search keywords are made available by Google Business Profile on a monthly basis.

You will receive the following metrics:

  • count: The sum of the number of unique users that used the keyword in a month
  • threshold: A threshold value indicating that the actual value is less than the threshold. Google Business Profile typically displays for search keywords that were used less than 15 times in a month.

You can use the following filters:

  • by businesses (businesses id in list, and restricted to one business when using the keyword dimension.)
  • by date (analytics before and/or after a date)

The response can be aggregated by:

  • business id
  • by date: month or year
  • both business id and date

The response can be ordered by:

  • business id
  • by date: month, or year

The response can be ordered in ascending or descending order by any of the selected dimensions or metrics.

Schema

    keywords

    object[]

  • Array [

    • date date

    First day of the aggregation

    keyword string

    The lower-cased string that the user entered.

    This is present only if the “keyword” dimension is in the request.

    count number

    An aggregation of monthly keyword search count values.

    The count values indicates the number of unique users that used the keyword in a month.

    threshold number

    An aggregation of monthly threshold values.

    The threshold value indicates that the real count of unique users that used the keyword is below this value.

    bucket string

    Time aggregation requested

    business_id string

    Business id

  • ]

    • page number

    Current page number

    max_page number

    Last page number

    count number

    Number of resources complying with filters

Loading...