Skip to main content
GET
Get Keywords

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

Query Parameters

as_of
string<uuid> | null

Include only scans up to this completed scan id.

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
cursor
string | null
Maximum string length: 4096
period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all
view
enum<string>
default:tracked

tracked: the keywords read now. archived: keywords archived, or in a topic archived in their segment.

Available options:
tracked,
archived
topic
string<uuid> | null

Only this topic's keywords.

segment
string | null

Only this segment's keywords, by label.

Maximum string length: 200
sort
enum<string>
default:searches

searches, keyword, best_rank, clicks or score. A keyword without the value is last whichever way it sorts.

Available options:
searches,
keyword,
best_rank,
clicks,
score
direction
enum<string> | null

Default: desc, and asc for keyword.

Available options:
asc,
desc

Response

Successful Response

keywords
V1Keyword · object[]
required
limit
integer
required
meta
Meta · object
required

Normalized query and newest included scan.

next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required
period
V1Period · object
required
total
integer
required