Skip to main content
GET
Get Keywords Summary
Returns totals for the keywords in the token’s workspace: how many rank in the top 3, top 10 and so on, and how many moved up or down compared with the previous period. This endpoint only reads data.
Every request needs an API token in the Authorization header. The token decides the workspace.

Parameters

Takes the same filters as List Keywords, without paging.
string
required
Bearer token. Format: Bearer slat_<your-token>.
string
Filter by tracking status. One of: tracked, paused. Leave it out to count both.
Count keywords whose text contains this value.
string
Count keywords tracked in this country, for example US.
string
Start of the period, in YYYY-MM-DD format. Send it together with to. Default: 14 days ago.
string
End of the period, in YYYY-MM-DD format. Default: today (UTC).

Response

Returns 200 OK with this object:
number
required
Number of keywords counted.
object
required
Keywords per band of your site’s average rank in the period. The bands don’t overlap.
object
required
Keywords whose average rank changed compared with the previous period.
object
required
The period and the previous period of the same length used for the comparison: from, to, previousFrom, previousTo.

Errors

See Errors for the response format.

Example