data_quality_checks

Health rollup per subject, for every subject in the project that has checks. Narrow it to one subject with subject_type and subject_uuid.

get/api/projects/{project_id}/data_quality_checks/health/

Request

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

Query parameters

subject_type'metric' | 'posthog_table' | 'table' | 'view'

Kind of object being checked: 'table', 'view', 'metric', or 'posthog_table'.

subject_uuidstring uuid

Id of the table, view, metric, or PostHog table.

Response

subject_typestring required

'table', 'view', 'metric', or 'posthog_table'.

subject_uuidstring required

Id of the table, view, metric, or PostHog table.

healthstring required

failing (an error-severity check failed), erroring (a check could not run), warn (only warn-severity failures), healthy, or unknown (nothing has run yet).

checks_totalinteger required

How many enabled, non-deleted checks cover this subject.

checks_failinginteger required

How many of those checks last reported a failure.

Changes

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