Dataset API Reference

Dataset

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

Endpoints

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

List all environments dataset items

Required API key scopes

dataset:read

Path parameters

environment_id
string

Query parameters

dataset
string
limit
integer
offset
integer

Response

Example request

GET /api/environments/:environment_id/dataset_items
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/".format(
        project_id=project_id,
		environment_id="<the environment 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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
      "input": null,
      "output": null,
      "metadata": null,
      "ref_trace_id": "string",
      "ref_timestamp": "2019-08-24T14:15:22Z",
      "ref_source_id": "string",
      "deleted": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "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"
      },
      "team": 0
    }
  ]
}

Create environments dataset items

Required API key scopes

dataset:write

Path parameters

environment_id
string

Request parameters

dataset
string
input
output
metadata
ref_trace_id
string
ref_timestamp
string
ref_source_id
string
deleted
boolean

Response

Example request

POST /api/environments/:environment_id/dataset_items
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/environments/:environment_id/dataset_items/\
	-d dataset="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"dataset": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "team": 0
}

Retrieve environments dataset items

Required API key scopes

dataset:read

Path parameters

environment_id
string
id
string

Response

Example request

GET /api/environments/:environment_id/dataset_items/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/{dataset_item_id}/".format(
        project_id=project_id,
		dataset_item_id="<the dataset item id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "team": 0
}

Update environments dataset items

Required API key scopes

dataset:write

Path parameters

environment_id
string
id
string

Request parameters

dataset
string
input
output
metadata
ref_trace_id
string
ref_timestamp
string
ref_source_id
string
deleted
boolean

Response

Example request

PATCH /api/environments/:environment_id/dataset_items/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/:id/\
	-d dataset="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/{dataset_item_id}/".format(
        project_id=project_id,
		dataset_item_id="<the dataset item id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"dataset": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "team": 0
}

Delete environments dataset items

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

dataset:write

Path parameters

environment_id
string
id
string

Example request

DELETE /api/environments/:environment_id/dataset_items/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dataset_items/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/dataset_items/{dataset_item_id}/".format(
        project_id=project_id,
		dataset_item_id="<the dataset item id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

List all dataset items

Required API key scopes

dataset:read

Path parameters

project_id
string

Query parameters

dataset
string
limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/dataset_items
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dataset_items/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/dataset_items/".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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
      "input": null,
      "output": null,
      "metadata": null,
      "ref_trace_id": "string",
      "ref_timestamp": "2019-08-24T14:15:22Z",
      "ref_source_id": "string",
      "deleted": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "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"
      },
      "team": 0
    }
  ]
}

Create dataset items

Required API key scopes

dataset:write

Path parameters

project_id
string

Request parameters

dataset
string
input
output
metadata
ref_trace_id
string
ref_timestamp
string
ref_source_id
string
deleted
boolean

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "team": 0
}

Retrieve dataset items

Required API key scopes

dataset:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "team": 0
}

Update dataset items

Required API key scopes

dataset:write

Path parameters

id
string
project_id
string

Request parameters

dataset
string
input
output
metadata
ref_trace_id
string
ref_timestamp
string
ref_source_id
string
deleted
boolean

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "input": null,
  "output": null,
  "metadata": null,
  "ref_trace_id": "string",
  "ref_timestamp": "2019-08-24T14:15:22Z",
  "ref_source_id": "string",
  "deleted": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "team": 0
}

Delete dataset items

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

dataset:write

Path parameters

id
string
project_id
string

Example request

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

Dataset

Endpoints

List all environments dataset items

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create environments dataset items

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve environments dataset items

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update environments dataset items

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments dataset items

Required API key scopes

Path parameters

Example request

Example response

Status 405 No response body

List all dataset items

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create dataset items

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve dataset items

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update dataset items

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete dataset items

Required API key scopes

Path parameters

Example request

Example response

Status 405 No response body

Community questions