data_quality_runs

Run checks now: the ones named by check_ids, every enabled check on the subject named by subject_type and subject_uuid, or every enabled check in the project when neither is given. Returns the suite run to poll for the report.

post/api/projects/{project_id}/data_quality_runs/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/data_quality_runs/
  • Auth: 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/.

Request body

check_idsstring[]

Ids of the checks to run. Omit to run every enabled check in the project.

subject_type'table' | 'view' | 'metric' | 'posthog_table'
  • table - table
  • view - view
  • metric - metric
  • posthog_table - posthog_table
subject_uuidstring uuid

Id of the subject to run every enabled check on. Pass subject_type with it.

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.