Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Presence analytics

Profile keywords for your business

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)
  • by branded status (branded vs discovery keywords)

The response can be aggregated by:

  • business id
  • by date: month or year
  • by keyword
  • by branded status (branded vs discovery)

The response can be ordered by:

  • business id
  • by date: month, or year
  • by keyword
  • by branded status

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

get/presence_analytics/keywords

Query parameters

metrics'count' | 'threshold' required
Example:metrics=count,threshold

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

dimensions'business' | 'keyword' | 'month' | 'year' | 'branded'
Example:dimensions=keyword,month,branded

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.

order_by'<object>' | '-<object>'
Example:order_by=-count

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 Available dimensions: business, keyword, month, year, branded Available metrics: count, threshold

business__inBusinessID[]

Filter by business ids

[
  "5409c35a97bbc544d8e26737"
]
filter_date__gtestring datetime

Filter by date.

Return all the analytics whose date >= given_date.

filter_date__ltestring datetime

Filter by date.

Return all the analytics whose date <= give_date.

brandedboolean

Filter by branded status.

  • true: Return only branded keywords (keywords associated with your brand)
  • false: Return only discovery keywords (generic keywords not associated with your brand)

If not specified, returns both branded and discovery keywords.

pageinteger

The page number you want to request.

per_pageinteger

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

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

Response

OK

pageinteger

The current page number.

countinteger

Total number of results available for the filters and dimensions requested.

max_pageinteger

Total number of pages available for this request.

Example response

{
  "page": 1,
  "count": 1,
  "max_page": 1,
  "keywords": [
    {
      "count": 123,
      "threshold": 123,
      "date": "2019-11-01",
      "bucket": "month",
      "business_id": "5409c35a97bbc544d8e26737",
      "branded": "branded"
    }
  ]
}