data_quality_checks

Change how often this subject's checks run, or stop running them automatically. Name the subject with subject_type and subject_uuid in the body.

patch/api/projects/{project_id}/data_quality_checks/schedule/

Request

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

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

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

interval'1hour' | '6hour' | '12hour' | '24hour' | '7day'
  • 1hour - 1hour
  • 6hour - 6hour
  • 12hour - 12hour
  • 24hour - 24hour
  • 7day - 7day
enabledboolean

Whether checks run automatically on this schedule.

Response

idstring uuid required

Schedule identifier.

interval'1hour' | '6hour' | '12hour' | '24hour' | '7day' required
  • 1hour - 1hour
  • 6hour - 6hour
  • 12hour - 12hour
  • 24hour - 24hour
  • 7day - 7day
enabledboolean required

Whether the schedule runs automatically.

next_run_atstring date-time nullable required

Next scheduled execution time, if enabled.

last_run_atstring date-time nullable required

Most recent visible scheduled suite execution time.

last_suite_runstring uuid nullable required

Most recent visible scheduled suite.

Changes

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