signals

List a report's follow-up checks

Every check on one report, newest first. The report_id is the only input. Read this before writing one: a report already carrying a check for the same claim needs no second one, and a report holds at most five open checks at a time.

get/api/projects/{project_id}/signals/scout/runs/report-checks/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/signals/scout/runs/report-checks/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

report_idstring uuid required

The report whose checks to list.

Response

The report's checks, newest first.

check_idstring uuid required

The check.

report_idstring uuid required

The report it is attached to.

titlestring required

The expectation the check states.

kindstring required

metric_threshold (the coordinator measures it) or agent (a run does).

statusstring required

pending while the check waits for the report to resolve, active while it still runs; every other value is terminal.

next_run_atstring date-time required

When the check next runs. Provisional while it is pending.

last_outcomestring nullable required

Verdict of the most recent run; null before the first.

last_outcome_reasonstring nullable required

Why the most recent run was inconclusive: awaiting_data, unmeasurable, needs_manual_verification, or no_fix_to_measure. Null on any other outcome.

run_statestring required

Where the check is in its run cycle. waiting_on_report: pending, no fix to measure yet. paused: active, but its report is suppressed or its horizon passed, so nothing runs it. scheduled: active, not due yet. due: due now, so a run on the check's scout may record the verdict. queued: a run was dispatched and has not started. running: the dispatched run started and has time left. stale: the dispatched run recorded nothing in its window, so the coordinator dispatches again. Any other value is the terminal status.

waiting_on_runboolean required

True while an agent check waits on a dispatched run to record its verdict.

dispatched_run_idstring uuid nullable required

The scout run the coordinator dispatched for the check, once it started. Null while queued.

dispatched_atstring date-time nullable required

When the coordinator last dispatched a run for the check. Null when no run waits.

Changes

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