events

List values of an event property from recent events.

get/api/projects/{project_id}/events/values/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/events/values/
  • Auth: HTTP bearer

Path parameters

project_idstring required

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

event_namestring[]

Only read values from events with these names. Repeat to pass several. Required with a personal API key. Projects that read values from the precomputed property values table ignore this filter.

format'csv' | 'json'
is_columnboolean

Read 'key' as an events table column, not a property.

keystring required

The property to list values for.

valuestring

Only return values that contain this text, ignoring case.

Response

refreshingboolean required

True when these results come from a stale cache and a refresh runs in the background.

Changes

No recorded changes to this operation across all 1 revision of this API.