Web

For instructions on how to authenticate to use this endpoint, see API overview.

List all web experiments

Required API key scopes

experiment:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response


Request

GET /api/projects/:project_id/web_experiments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/web_experiments/

Response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "feature_flag_key": "string",
      "variants": null
    }
  ]
}

Create web experiments

Required API key scopes

experiment:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • name
    string
  • created_at
    string
  • variants

Response


Request

POST /api/projects/:project_id/web_experiments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/web_experiments/\
	-d name="string"

Response

Status 201
RESPONSE
{
  "id": 0,
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "feature_flag_key": "string",
  "variants": null
}

Retrieve web experiments

Required API key scopes

experiment:read

Path parameters

  • id
    integer

    A unique integer value identifying this web experiment.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response


Request

GET /api/projects/:project_id/web_experiments/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/web_experiments/:id/

Response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "feature_flag_key": "string",
  "variants": null
}

Update web experiments

Required API key scopes

experiment:write

Path parameters

  • id
    integer

    A unique integer value identifying this web experiment.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • name
    string
  • created_at
    string
  • variants

Response


Request

PATCH /api/projects/:project_id/web_experiments/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/web_experiments/:id/\
	-d name="string"

Response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "feature_flag_key": "string",
  "variants": null
}

Delete web experiments

Required API key scopes

experiment:write

Path parameters

  • id
    integer

    A unique integer value identifying this web experiment.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

DELETE /api/projects/:project_id/web_experiments/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/web_experiments/:id/

Response

Status 204 No response body

Community questions

Was this page useful?