Checks

A project's recent background activity and queued searches

Lists a project's background activity newest first: search checks, page captures and reviews with status running, completed or failed, plus rows for scheduled runs that were skipped because the check allowance was used up (Search check capacity) or billing was paused. searches counts search checks waiting in the queue or running now. latest_on_demand_run summarizes the most recent run_realtime_check run; poll get_check_status for a specific run. next_scheduled_check_at is when the next scheduled check starts, the moment the app's header counts down to; it is null when nothing is scheduled (manual monitoring, no monitored keyword, or a plan that cannot run checks). Failure details are not exposed; a failed search is retried by the system when that is safe.

get/projects/{project_id}/checks

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/checks
  • 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.

Query parameters

limitinteger

Items per page, 1 to 200.

cursorstring

The next_cursor value from the previous page. Omit it for the first page.

Response

A project's recent background activity and queued searches

next_cursorstring nullable required

Pass as cursor to get the next page; null on the last page.

next_scheduled_check_atstring nullable required

ISO 8601 start of the next scheduled check; null when none is scheduled.

request_idstring

Changes

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