Skip to main content
GET
Get site keyword analysis status

Authorizations

API-Key
string
header
required

"Enter your organization API key. Example: 'cs_live_xxxx'"

Path Parameters

taskID
string
required

ID of the analysis task to retrieve: enter the id from the analysis submit response as is

Query Parameters

includeSourceURLs
boolean

If true, includes url in each keyword's sources items (default false). sourceURLCount is always included

includeContext
boolean

If true, includes contexts (a list of source quotes where the keyword appears) in each keyword's sources entries (default false). Can be set independently of includeSourceURLs, and contexts may be empty for pages where no quote was identified

Response

OK

error
string

Do not attach an example: a failure reason would appear mixed into the status=COMPLETED example.

id
string

ID of the retrieved analysis task. Same value as the id in the submission response and the taskID in the request path

Example:

"Ck1hRr4mQ2yVX8pTd0LsJw"

keywords
object[]

Populated only when COMPLETED

maxPages
integer

Maximum number of pages to analyze, as requested at submission

Example:

30

processedPages
integer

Number of pages attempted (succeeded plus failed) so far

Example:

8

status
enum<string>

Progress status of the analysis job. PENDING: accepted but not started yet, IN_PROGRESS: crawling and analyzing pages (check progress with totalPages and processedPages), COMPLETED: analysis finished and keywords is populated, FAILED: analysis failed and there is no result (reason in error). Transitions in the order PENDING → IN_PROGRESS → COMPLETED or FAILED, and does not change after a terminal state (COMPLETED or FAILED). If it fails before starting, it may go directly from PENDING to FAILED

Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED
Example:

"COMPLETED"

totalPages
integer

Number of pages to process (finalized after entering IN_PROGRESS)

Example:

8