Get business profile keywords
GET/api/v2/presence/analytics/keywords
Get business profile keywords
Request
Query Parameters
- before a field to order_by DESC, nothing for ASC
Filter by date
Return all the analytics whose date
>= given_date
.
Filter by date
.
Return all the analytics whose filter_date
<= given_date
.
Possible values: [count
, threshold
]
List of analytics to return. At least one in that list.
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.
Where the object is either a dimension or a metric and is used in the request. At most one in the list.
Filter by business ids
Filter by all allowed businesses except the ones given in
Possible values: >= 1
The page number you want to request.
The value defaults to 1, when it is not included.
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
- 200
- 400
- 401
- 403
- 404
- 422
- 500
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.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
keywords
object[]
First day of the aggregation
The lower-cased string that the user entered.
This is present only if the “keyword” dimension is in the request.
An aggregation of monthly keyword search count values.
The count values indicates the number of unique users that used the keyword in a month.
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.
Time aggregation requested
Business id
Current page number
Last page number
Number of resources complying with filters
{
"keywords": [
{
"date": "2019-11-01",
"keyword": 123,
"count": 123,
"threshold": 123,
"bucket": "month",
"business_id": "5409c35a97bbc544d8e26737"
}
],
"page": 1,
"max_page": 10,
"count": 287
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
HTTP status code
Error message
errors
object[]
required
Possible values: non-empty
Path to the property with the error
errors
object[]
required
Possible values: non-empty
Error type
Error message
{
"statusCode": 404,
"message": "Cannot find item",
"errors": [
{
"path": "business.id",
"errors": [
{
"type": "object_required_property",
"message": "Required property"
}
]
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}