Experiment Saved API Reference

Experiment Saved

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

Endpoints

`GET`
`POST`
`GET`
`PATCH`
`DELETE`

List all experiment saved metrics

Required API key scopes

experiment_saved_metric:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/experiment_saved_metrics
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/experiment_saved_metrics/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/experiment_saved_metrics/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example 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",
      "description": "string",
      "query": null,
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "tags": [
        null
      ],
      "user_access_level": "string"
    }
  ]
}

Create experiment saved metrics

Required API key scopes

experiment_saved_metric:write

Path parameters

project_id
string

Request parameters

name
string
description
string
query
tags
array

Response

Example request

POST /api/projects/:project_id/experiment_saved_metrics
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/experiment_saved_metrics/\
	-d name="string",\
	-d query=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/experiment_saved_metrics/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "user_access_level": "string"
}

Retrieve experiment saved metrics

Required API key scopes

experiment_saved_metric:read

Path parameters

id
integer
project_id
string

Response

Example request

GET /api/projects/:project_id/experiment_saved_metrics/: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/experiment_saved_metrics/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/experiment_saved_metrics/{experiment_saved_metric_id}/".format(
        project_id=project_id,
		experiment_saved_metric_id="<the experiment saved metric id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "user_access_level": "string"
}

Update experiment saved metrics

Required API key scopes

experiment_saved_metric:write

Path parameters

id
integer
project_id
string

Request parameters

name
string
description
string
query
tags
array

Response

Example request

PATCH /api/projects/:project_id/experiment_saved_metrics/: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/experiment_saved_metrics/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/experiment_saved_metrics/{experiment_saved_metric_id}/".format(
        project_id=project_id,
		experiment_saved_metric_id="<the experiment saved metric id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "user_access_level": "string"
}

Delete experiment saved metrics

Required API key scopes

experiment_saved_metric:write

Path parameters

id
integer
project_id
string

Example request

DELETE /api/projects/:project_id/experiment_saved_metrics/: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/experiment_saved_metrics/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/experiment_saved_metrics/{experiment_saved_metric_id}/".format(
        project_id=project_id,
		experiment_saved_metric_id="<the experiment saved metric id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Experiment Saved

Endpoints

List all experiment saved metrics

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create experiment saved metrics

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve experiment saved metrics

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update experiment saved metrics

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete experiment saved metrics

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions