{ "opencollection": "1.0.0", "info": { "name": "PostHog actions events API", "version": "1.0.0" }, "items": [ { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "environments_events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/events/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return events with a timestamp after this time. Default: now() - 24 hours." }, { "name": "before", "value": "", "type": "query", "description": "Only return events with a timestamp before this time. Default: now() + 5 seconds." }, { "name": "distinct_id", "value": "", "type": "query", "description": "Filter list by distinct id." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "event", "value": "", "type": "query", "description": "Filter list by event. For example `user sign up` or `$pageview`." }, { "name": "format", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return" }, { "name": "offset", "value": "", "type": "query", "description": "Allows to skip first offset rows. Will fail for value larger than 100000. Read about proper way of paginating: https://posthog.com/docs/api/queries#5-use-timestamp-based-pagination-instead-of-offset" }, { "name": "person_id", "value": "", "type": "query", "description": "Filter list by person id." }, { "name": "properties", "value": "", "type": "query", "description": "Filter events by event property, person property, cohort, groups and more." }, { "name": "select", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions to return" }, { "name": "where", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions that must pass" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n This endpoint allows you to list and filter events.\n It is effectively deprecated and is kept only for backwards compatibility.\n If you ever ask about it you will be advised to not use it...\n If you want to ad-hoc list or aggregate events, use the Query endpoint instead.\n If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.\n " }, { "info": { "name": "environments_events_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/events/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_events_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/events/values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/events/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return events with a timestamp after this time. Default: now() - 24 hours." }, { "name": "before", "value": "", "type": "query", "description": "Only return events with a timestamp before this time. Default: now() + 5 seconds." }, { "name": "distinct_id", "value": "", "type": "query", "description": "Filter list by distinct id." }, { "name": "event", "value": "", "type": "query", "description": "Filter list by event. For example `user sign up` or `$pageview`." }, { "name": "format", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return" }, { "name": "offset", "value": "", "type": "query", "description": "Allows to skip first offset rows. Will fail for value larger than 100000. Read about proper way of paginating: https://posthog.com/docs/api/queries#5-use-timestamp-based-pagination-instead-of-offset" }, { "name": "person_id", "value": "", "type": "query", "description": "Filter list by person id." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "properties", "value": "", "type": "query", "description": "Filter events by event property, person property, cohort, groups and more." }, { "name": "select", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions to return" }, { "name": "where", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions that must pass" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n This endpoint allows you to list and filter events.\n It is effectively deprecated and is kept only for backwards compatibility.\n If you ever ask about it you will be advised to not use it...\n If you want to ad-hoc list or aggregate events, use the Query endpoint instead.\n If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.\n " }, { "info": { "name": "events_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/events/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "events_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/events/values/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] } ], "bundled": true }