Events API Reference

Docs
API
Events

Events

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

Endpoints

`GET`	`/api/projects/:project_id/events/`
`GET`	`/api/projects/:project_id/events/:id/`
`GET`	`/api/projects/:project_id/events/values/`

List all events

Path Parameters

project_id
string

Query Parameters

after
string
before
string
distinct_id
integer
event
string
format
string
One of: "csv""json"
limit
integer
offset
integer
person_id
integer
properties
array

Response

Request

GET /api/projects/:project_id/events

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/events/

Response

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": "string",
      "distinct_id": "string",
      "properties": "string",
      "event": "string",
      "timestamp": "string",
      "person": "string",
      "elements": "string",
      "elements_chain": "string"
    }
  ]
}

Retrieve events

Path Parameters

id
string
project_id
string

Query Parameters

format
string
One of: "csv""json"

Response

Request

GET /api/projects/:project_id/events/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/events/:id/

Response

RESPONSE

{
  "id": "string",
  "distinct_id": "string",
  "properties": "string",
  "event": "string",
  "timestamp": "string",
  "person": "string",
  "elements": "string",
  "elements_chain": "string"
}

Retrieve events values

Path Parameters

project_id
string

Query Parameters

format
string
One of: "csv""json"

Response

Request

GET /api/projects/:project_id/events/values

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/events/values/

Response

RESPONSE

{
  "id": "string",
  "distinct_id": "string",
  "properties": "string",
  "event": "string",
  "timestamp": "string",
  "person": "string",
  "elements": "string",
  "elements_chain": "string"
}

Events

Endpoints

List all events

Path Parameters

Query Parameters

Response

Request

Response

Retrieve events

Path Parameters

Query Parameters

Response

Request

Response

Retrieve events values

Path Parameters

Query Parameters

Response

Request

Response

Questions?

Was this page useful?