data_quality_checks

Recent run history for this check, newest first.

get/api/projects/{project_id}/data_quality_checks/{id}/runs/

Request

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

Path parameters

idstring uuid required

A UUID string identifying this data quality check.

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
quality_checkstring uuid nullable required

The definition executed. Nulled rather than cascaded so history outlives hard deletes.

check_namestring nullable required

Name the check carries now, so a run can be told from the others in its suite. Null when the check is unnamed, has been hard deleted, or is out of your reach today -- describe the run by check_type and column_name instead.

suite_runstring uuid required
subject_type'table' | 'view' | 'metric' | 'posthog_table' required
  • table - table
  • view - view
  • metric - metric
  • posthog_table - posthog_table
subject_uuidstring uuid required
subject_namestring required
check_type'not_null' | 'unique' | 'accepted_values' | 'relationships' | 'row_count' | 'freshness' | 'custom_sql' required
  • not_null - not_null
  • unique - unique
  • accepted_values - accepted_values
  • relationships - relationships
  • row_count - row_count
  • freshness - freshness
  • custom_sql - custom_sql
column_namestring required
check_configobject nullable required

Config this run executed, snapshotted so an edit to the check cannot rewrite history. Null for runs recorded before snapshots existed -- unknown, not 'same as the check has now'.

statusstring required

passed, failed, errored, or skipped.

failed_row_countinteger nullable required

Rows violating the assertion. Null for bounds checks like row_count.

observed_valuenumber double nullable required

The check's headline number, recorded on passes too.

compiled_querystring required

HogQL selecting the failing rows. Re-run it to see them. For a run that audited a staged refresh it inlines the view's definition, so it reads the source tables rather than the published table. Empty when there is nothing to replay: retention cleared it, or a staged run could not build its replay query.

audited_staged_refreshboolean required

True when the run audited a refresh that was staged but not yet published, under the materialization gate.

errorstring required

Compilation or execution failure, when status is 'errored'.

duration_msinteger nullable required
started_atstring date-time nullable required
finished_atstring date-time nullable required
created_atstring date-time required

Changes

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