Skip to main content
POST
Start Keyword List

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

query

Path Parameters

brand_id
integer
required

The unique identifier for the brand

Body

application/json

A list of keywords to estimate in the background.

keywords
string[]
required

Up to 200 keywords, each up to 200 characters. Repeats (ignoring case and spacing) are counted once, and blank entries are dropped.

Required array length: 1 - 200 elements
Maximum string length: 200

Response

Successful Response

A keyword list: its status and progress, without the per-keyword results.

id
integer
required

The list's id.

status
enum<string>
required

queued (waiting to start), running, finished, failed (stopped early; unused lookups were given back) or canceled.

Available options:
queued,
running,
finished,
failed,
canceled
country
string
required

The country the estimates are for. Always US today.

item_count
integer
required

How many keywords are on the list, after repeats and blanks are dropped.

counts
KeywordBulkCounts · object
required

How many of the list's keywords are in each status.

created_at
string<date-time>
required

When the list was started.

started_at
string<date-time> | null
required

When it began running. Null while it's queued.

finished_at
string<date-time> | null
required

When it ended. Null while it's queued or running.