Get business profile keywords

GET 
/api/v2/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)

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.

Request

Query Parameters

metrics string[]required

Possible values: [count, threshold]

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

page integer

Possible values: >= 1

Default value: 1

Page of items to fetch

per_page integer

Possible values: >= 1

Number of items per page.

business__in string[]

Limit results to a specific businesses

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
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 date <= given_date.

Responses

200

application/json

Schema

Schema

page integerrequired

Possible values: >= 1

Default value: 1

Current page

max_page integerrequired

Possible values: >= 1

Default value: 1

Max page based on current per_page value and count

count integerrequired

Default value: 0

Number of items per page.

items

object[]

required

Array [

business_id string

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.

date date

First day of the aggregation

bucket string

Time aggregation requested

]

Example (from schema)

{
  "page": 1,
  "max_page": 1,
  "count": 0,
  "items": [
    {
      "business_id": "string",
      "keyword": "123",
      "count": 123,
      "threshold": 123,
      "date": "2019-11-01",
      "bucket": "month"
    }
  ]
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...