Skip to main content
GET
/
presence_analytics
/
keywords
Profile keywords for your business
curl --request GET \
  --url https://api.partoo.co/v2/presence_analytics/keywords \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "count": 1,
  "max_page": 1,
  "keywords": [
    {
      "keyword": 123,
      "count": 123,
      "threshold": 123,
      "date": "2019-11-01",
      "bucket": "month",
      "business_id": "5409c35a97bbc544d8e26737"
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
metrics
enum<string>
required

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

Available options:
count,
threshold
Example:

"metrics=count,threshold"

​
dimensions
enum<string>

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.

Available options:
business,
keyword,
month,
year
Example:

"dimensions=keyword,month"

​
order_by
enum<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

Available options:
<object>,
-<object>
Example:

"order_by=-count"

​
business__in
string[]

Filter by business ids

Business id

​
filter_date__gte
string<datetime>

Filter by date.

Return all the analytics whose date >= given_date.

​
filter_date__lte
string<datetime>

Filter by date.

Return all the analytics whose date <= give_date.

​
page
integer

The page number you want to request.

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

Required range: x >= 1
​
per_page
integer

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

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

Required range: x <= 500

Response

OK

​
page
integer

The current page number.

Example:

1

​
count
integer

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

Example:

1

​
max_page
integer

Total number of pages available for this request.

Example:

1

​
keywords
object[]