PostHog
Create PostHog Experiment
Create PostHog Experiment.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| identifieraccount · required | account | required | — |
| project_idstring · required | string | required | Project ID returned by List PostHog Projects. Uses only the selected connected account. |
| namestring · required | string | required | PostHog name. |
| feature_flag_keystring · required | string | required | PostHog feature flag key. |
| descriptionstring · optional | string | optional | PostHog description; null clears this value. |
| start_datestring · optional | string | optional | PostHog start date; null clears this value. |
| end_datestring · optional | string | optional | PostHog end date; null clears this value. |
| holdout_idnumber · optional | number | optional | PostHog holdout id from the matching lookup in this project. |
| parametersstring · optional | string | optional | Experiment parameters JSON, including the feature flag variants and rollout percentages. |
| secondary_metricsstring · optional | string | optional | PostHog secondary metrics as structured JSON or JSON text. Supports Workflow variables. |
| saved_metrics_idsstring · optional | string | optional | PostHog saved metrics ids as structured JSON or JSON text. Supports Workflow variables. |
| filtersstring · optional | string | optional | PostHog filters as structured JSON or JSON text. Supports Workflow variables. |
| archivedboolean · optional | boolean | optional | PostHog archived. |
| typestring · optional | string | optional | PostHog type. |
| exposure_criteriastring · optional | string | optional | PostHog exposure criteria as structured JSON or JSON text. Supports Workflow variables. |
| metricsstring · optional | string | optional | PostHog metrics as structured JSON or JSON text. Supports Workflow variables. |
| metrics_secondarystring · optional | string | optional | PostHog metrics secondary as structured JSON or JSON text. Supports Workflow variables. |
| stats_configstring · optional | string | optional | PostHog stats config as structured JSON or JSON text. Supports Workflow variables. |
| scheduling_configstring · optional | string | optional | PostHog scheduling config as structured JSON or JSON text. Supports Workflow variables. |
| allow_unknown_eventsboolean · optional | boolean | optional | PostHog allow unknown events. |
| _create_in_folderstring · optional | string | optional | PostHog create in folder. |
| conclusionstring · optional | string | optional | PostHog conclusion. |
| conclusion_commentstring · optional | string | optional | PostHog conclusion comment; null clears this value. |
| primary_metrics_ordered_uuidsstring · optional | string | optional | PostHog primary metrics ordered uuids as structured JSON or JSON text. Supports Workflow variables. |
| secondary_metrics_ordered_uuidsstring · optional | string | optional | PostHog secondary metrics ordered uuids as structured JSON or JSON text. Supports Workflow variables. |
| only_count_matured_usersboolean · optional | boolean | optional | PostHog only count matured users. |
| update_feature_flag_paramsboolean · optional | boolean | optional | PostHog update feature flag params. |
Response schema
{
"type": "object",
"required": [
"id",
"name",
"feature_flag_key"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"filters": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"archived": {
"type": "boolean"
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"conclusion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"holdout_id": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parameters": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"feature_flag": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"stats_config": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"saved_metrics": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"feature_flag_key": {
"type": "string"
},
"_create_in_folder": {
"type": "string"
},
"exposure_criteria": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"metrics_secondary": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"saved_metrics_ids": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"scheduling_config": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"secondary_metrics": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"user_access_level": {
"type": "string"
},
"conclusion_comment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"allow_unknown_events": {
"type": "boolean"
},
"only_count_matured_users": {
"type": "boolean"
},
"update_feature_flag_params": {
"type": "boolean"
},
"primary_metrics_ordered_uuids": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"secondary_metrics_ordered_uuids": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}