Events
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all events
Path Parameters
- project_idstring
Query Parameters
- afterstring
- beforestring
- distinct_idinteger
- eventstring
- formatstringOne of:
"csv"
"json"
- limitinteger
- offsetinteger
- person_idinteger
- propertiesarray
- selectarray
- wherearray
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
- idstring
- project_idstring
Query Parameters
- formatstringOne 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_idstring
Query Parameters
- formatstringOne 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"}