Events

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

List all events

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

  • after
    string

    Only return events with a timestamp after this time.

  • before
    string

    Only return events with a timestamp before this time.

  • distinct_id
    integer

    Filter list by distinct id.

  • event
    string

    Filter list by event. For example user sign up or $pageview.

  • format
    string
    One of: "csv""json"
  • limit
    integer

    The maximum number of results to return

  • offset
    integer

    The initial index from which to return the results.

  • person_id
    integer

    Filter list by person id.

  • properties
    Click to open
    array

    Filter events by event property, person property, cohort, groups and more.

  • select
    array

    (Experimental) JSON-serialized array of HogQL expressions to return

  • where
    array

    (Experimental) JSON-serialized array of HogQL expressions that must pass

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

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": "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

    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

  • 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

Status 200
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

    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

  • 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

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

Questions?

Was this page useful?