---
title: "Profile keywords for your business"
method: GET
path: "/presence_analytics/keywords"
tags: ["Presence analytics"]
---

# Profile keywords for your business

`GET /presence_analytics/keywords`

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.

## Query parameters

- `metrics` 'count' | 'threshold', required
- `dimensions` 'business' | 'keyword' | 'month' | 'year' | 'branded'
- `order_by` '<object>' | '-<object>'
- `business__in` BusinessID[]
- `filter_date__gte` string, datetime
- `filter_date__lte` string, datetime
- `branded` boolean
- `page` integer
- `per_page` integer

## Response `200`

OK

- PresenceAnalyticsKeywordsResponse
  - `page` integer — The current page number.
  - `count` integer — Total number of results available for the filters and dimensions requested.
  - `max_page` integer — Total number of pages available for this request.
  - `keywords` object[]
    - `keyword` string — The lower-cased string that the user entered. This is present only if the “keyword” dimension is in the request.
    - `count` integer — An aggregation of mountly keyword search count values. The count values indicates the number of unique users that used the keyword in a month.
    - `threshold` integer — 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.
    - `date` string — First day of the aggregation
    - `bucket` string — Time aggregation requested
    - `business_id` string — Business id
    - `branded` 'branded' | 'discovery' — Indicates whether the keyword is branded or discovery. - `branded`: Keywords associated with your brand (e.g., "Castorama", "Casto") - `discovery`: Generic keywords not associated with your brand (e.g., "bricolage", "magasin outillage") This field is only present when the "branded" dimension is included in the request.

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)