data_quality_checks

Every check in the project. Narrow it to one subject with subject_type and subject_uuid, or to one assertion with check_type.

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

Request

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

check_type'accepted_values' | 'custom_sql' | 'freshness' | 'not_null' | 'relationships' | 'row_count' | 'unique'

Only the checks that make this assertion. See /check_types/.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

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

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

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