DOCS

List scans

GET/v1/scans

Scan runs for a brand, newest first: the first scan, daily scans and manual ones.

Read-onlyAll plans

Query parameters

brand_idstringoptionalThe brand to read. Optional when your key covers one brand; required for agency keys and when trying the API signed in.
limitintegeroptionalHow many items to return, 1 to 100. Default 20.
cursorstringoptionalThe next_cursor from the previous page.

Response

A list of scan objects.

objectstringAlways list.
dataarray of objectsThe items.
idstringScan id, scn_….
kindstringfirst, daily or manual.
statusstringrunning, done, partial or failed.
enginesarray of stringsEngines in the run.
answers_totalintegerAnswers planned.
answers_doneintegerAnswers collected so far.
starteddatetimeStart.
finisheddatetime or nullEnd.
has_morebooleanWhether there is another page.
next_cursorstring or nullPass as cursor to get the next page.

Errors

401unauthorizedMissing or revoked API key.
404not_foundNo brand with that id that this key can read.
429rate_limitedToo many requests; see Retry-After.