Checks

Progress of an on-demand check

Returns how many searches of an on-demand check run are completed, failed or pending. Results appear in list_observations as searches complete.

get/projects/{project_id}/checks/{run_id}

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/checks/{run_id}
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project: its id, its brand domain (for example nike.example) or its exact project or brand name. Unknown or ambiguous references return not_found; call list_projects then.

run_idstring required

run_id from run_realtime_check.

Response

Progress of an on-demand check

run_idstring required
project_idstring required
reusedboolean required

True when this answer repeats an earlier request with the same key, or joins an identical check that is still running. No checks were reserved again.

totalinteger required

Searches in the run: keyword × location × device × source.

completedinteger required
failedinteger required
pendinginteger required
expiredboolean required

True when some of the run's job records were already cleaned up.

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.