data_quality_runs

Check-suite executions: start one over a selection, and read every run the project has had.

A suite run may sweep several subjects at once -- a manual project-wide run, a materialization, a source sync -- so it is reported here rather than under any one of them.

get/api/projects/{project_id}/data_quality_runs/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/data_quality_runs/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this data quality suite run.

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/.

Response

idstring uuid required
triggerstring required

manual, materialization, source_sync, or scheduled.

statusstring required

running, completed, failed, or empty (nothing matched the trigger).

subject_typestring nullable required

'table', 'view', 'metric', or 'posthog_table' when the run targets exactly one subject, including a run of a single check on that subject; null for a run spanning several subjects.

subject_uuidstring uuid nullable required

Set when the run targets exactly one subject.

workflow_idstring required
checks_passedinteger required
checks_failedinteger required
checks_erroredinteger required
checks_skippedinteger required
started_atstring date-time nullable required
finished_atstring date-time nullable required
errorstring required

Why the suite itself failed, as opposed to an individual check.

created_atstring date-time required

Changes

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