provider event_definitions GET /api/projects/{project_id}/event_definitions/
@utdk/posthog /api/projects/{project_id}/event_definitions/
event_definitions_list
exclude_hidden query
When true, omit events that have been explicitly hidden by a team admin (Enterprise only).
boolean
exclude_stale query
When true, omit events whose last ingested occurrence is older than 30 days. Events that have never been seen (`last_seen_at` is null) are kept so newly-defined events remain discoverable. Default false. If a search returns zero results with this filter on, retry with `exclude_stale=false` and tell the user the matches are stale.
boolean
limit query
Number of results to return per page.
integer
offset query
The initial index from which to return the results.
integer
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string

Try it

Authentication
Configure credentials for PostHog API
eventDefinitionsList
GET/api/projects/{project_id}/event_definitions/

Parameters

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

When true, omit events that have been explicitly hidden by a team admin (Enterprise only).

When true, omit events whose last ingested occurrence is older than 30 days. Events that have never been seen (`last_seen_at` is null) are kept so newly-defined events remain discoverable. Default false. If a search returns zero results with this filter on, retry with `exclude_stale=false` and tell the user the matches are stale.

Number of results to return per page.

The initial index from which to return the results.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.eventDefinitionsList()