experiments

Changed on

Staff only. The inputs that the health checks read for this reader, to debug why a finding shows or not: the context of the checks in health, the exposure query's answer that the exposure checks read, and facts about the project from the setup context's providers (the team's experiment defaults and which SDKs call flags). The exposure answer comes from the cache. When it is missing or stale, a calculation starts in the background and exposures.status says so.

get/api/projects/{project_id}/experiments/{id}/health_inputs/

Request

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

Path parameters

idinteger required

A unique integer value identifying this experiment.

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

is_launchedboolean required

Whether the experiment has a start date.

is_runningboolean required

Whether the experiment is launched and not ended.

has_endedboolean required

Whether the experiment has an end date.

is_pausedboolean required

Whether the experiment is paused.

archivedboolean required

Whether the experiment is archived.

baseline_variant_keystring nullable required

The baseline set in the experiment's settings. Null when unset.

excluded_variant_keysstring[] required

The variants the analysis leaves out of the results. The forced-variant check ignores pins to them.

primary_metric_countinteger required

Single-use primary metrics plus shared metrics linked as primary.

secondary_metric_countinteger required

Single-use secondary metrics plus shared metrics linked as secondary.

flag_last_called_atstring date-time nullable required

The flag's latest recorded call, which a periodic sync of the flag call events sets. Null when the experiment has no flag, or the flag has no recorded call.

flag_calledboolean nullable required

Whether PostHog has recorded any call of the flag. The flag traffic check reads it on a draft. Null when the experiment has no flag, or the organization's flag calls are stored where the checks can't read them.

flag_called_during_runboolean nullable required

Whether PostHog has recorded a call of the flag between launch and the end, or until now. The zero exposures check reads it to say whether the flag is called. Null before launch, after a latest call that came after the end, or when the organization's flag calls can't be read.

events_receivedobject required

Whether the project has received each event that the metrics and the exposure criteria name, by event name. A name that ingestion keeps no record of is absent.

condition_set_traffic_status'read' | 'not_needed' | 'no_query_access' | 'denied_properties' | 'no_flag_version' | 'unknown' required
  • read - Read
  • not_needed - Not Needed
  • no_query_access - No Query Access
  • denied_properties - Denied Properties
  • no_flag_version - No Flag Version
  • unknown - Unknown

Changes

  • 0ca22e1eb92bRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • e263ffc38ef5Revision changes
    • warning

      added the new exposure_criteria_cannot_match enum value to the /////////// response property for the response status

    • warning

      added the new metric_event_not_ingested enum value to the /////////// response property for the response status