insights

Changed on

Run the data checks on a saved insight, found by its numeric id or its short_id. The checks read the query the insight stores, and work the same way as the checks on a query that is not saved. The status is unsupported for an insight that still stores legacy filters and no query. Nothing is stored.

get/api/projects/{project_id}/insights/{id}/data_checks/

Request

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

Path parameters

integer required
OR
string required

Numeric primary key or 8-character short_id (for example AaVQ8Ijw) identifying the insight.

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

depth'quick' | 'full'

quick, the default, reads within a small budget so the checks can run on every load. On an insight they would read a lot of data for, a quick check does not run and status is on_request. full runs the checks with the same limits as the insight's own query.

  • quick - Read within a small budget, so the checks can run on every load
  • full - Read with the same limits as the insight's own query
format'csv' | 'json'

Response

The result of every check.

status'passed' | 'warning' | 'problem' | 'partial' | 'on_request' | 'no_events' | 'unsupported' | 'inconclusive' required
  • passed - No data issues found
  • warning - A check found a small issue
  • problem - A check found a large issue
  • partial - Some checks could not run, and the others found no issue
  • on_request - The checks would read a lot of data, so they run only on request
  • no_events - No events to check
  • unsupported - This kind of insight cannot be checked
  • inconclusive - No check could run

Changes

  • 417e6bbbc890Revision changes
    • warning

      added the new on_request enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new on_request enum value to the ////// response property for the response status (media type: text/csv)

    • warning

      added the new on_request enum value to the //// response property for the response status (media type: application/json)

    • warning

      added the new on_request enum value to the //// response property for the response status (media type: text/csv)

    • warning

      added the new partial enum value to the //// response property for the response status (media type: application/json)

    • warning

      added the new partial enum value to the //// response property for the response status (media type: text/csv)

    • info

      added the new optional query request parameter depth

  • 1b28c15d563dRevision changes
    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/csv)