data_quality_checks

Everything in this project you can author a check on, with each subject's columns.

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

Request

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

Response

subject_type'table' | 'view' | 'metric' | 'posthog_table' required
  • table - table
  • view - view
  • metric - metric
  • posthog_table - posthog_table
idstring required

Id of the subject. Pass it back as subject_uuid when creating a check.

namestring required

Queryable name of the subject.

display_namestring required

Label shown in the data catalog. Blank for tables and views.

time_columnstring required

Column a lookback window bounds, or blank for a subject that has none.

columnsobject required

Column name to ClickHouse type. Empty for a metric, and for a view that has not run yet.

editableboolean required

Whether the caller may author a check on this subject. A subject that is only readable can still be the target of a relationships check.

Changes

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