Home
PostHog
PostHog
PostHog is an open source product analytics platform that provides event tracking, session recording, feature flags, A/B testing, and user surveys in a single platform. It can be self-hosted or used as a cloud service, giving teams full control over their product data while providing comprehensive tools for understanding and improving user experiences.
9 APIs
16 Features
A/B Testing Analytics Feature Flags Open Source Product Analytics Session Recording
The PostHog API is a single consolidated REST interface that exposes every PostHog capability available in the UI, including event capture, person and group profiles, cohorts, f...
The PostHog Capture API allows developers to send events, identify users, and set user or group properties from any server or client. It is the primary ingestion endpoint for se...
The PostHog Query API provides programmatic access to run HogQL queries against your PostHog data. HogQL is PostHog's SQL-like query language that enables custom analytics queri...
The PostHog Persons API allows developers to retrieve, search, and manage person profiles in PostHog. It supports listing persons with filters, retrieving individual person deta...
The PostHog Feature Flags API enables developers to create, manage, and evaluate feature flags programmatically. It supports boolean and multivariate flags, percentage-based rol...
The PostHog Experiments API provides programmatic management of A/B tests and experiments. It supports creating experiments with control and test variants, defining goal metrics...
The PostHog Insights API allows developers to create, retrieve, and manage saved insights such as trends, funnels, retention charts, paths, and lifecycle analyses. It provides p...
The PostHog Cohorts API enables developers to create and manage cohorts, which are groups of users defined by shared properties or behavioral patterns. Cohorts can be used for t...
The PostHog Annotations API allows developers to create and manage annotations that mark significant events on PostHog charts and dashboards. Annotations provide context for dat...
PostHog does not expose a public GraphQL endpoint. Its primary API surface is a REST API documented at https://posthog.com/docs/api, with an additional HogQL query layer (SQL-li...
GRAPHQL
Product Analytics: 1M events free, tiered $0.0000500-$0.0000090 per event
Session Replay: 5K replays free, tiered $0.005-$0.0015 per replay
Feature Flags + Experiments: 1M requests free, tiered down to $0.00001
Enterprise: SAML/RBAC/audit logs as add-on
Open-source self-hosted alternative (PostHog Cloud or self-host)
Capture API for events from web/mobile/server
HogQL (SQL-style query language)
Decide API for flag evaluation
Public API: 240 req/min/user
Auto-capture for click/page-view tracking
Webhooks for actions and cohort changes
Personal API keys + project keys
SDK ecosystem: JS, React, mobile, server (10+)
Surveys, A/B tests, multivariate experiments
Data warehouse integration (BigQuery, Snowflake, Redshift)
EU + US data residency
PostHog's Customer Data Platform (CDP) exposes a webhook destination that sends event and person data from PostHog to any external HTTP endpoint in real time. The generic Webhoo...
ASYNCAPI
0 properties
JSON STRUCTURE
Sources
opencollection: 1.0.0
info:
name: PostHog API
version: 1.0.0
items:
- info:
name: code-invites
type: folder
items:
- info:
name: Check access
type: http
http:
method: GET
url: '{{baseUrl}}/api/code/invites/check-access/'
docs: Check whether the authenticated user has access to PostHog Code.
- info:
name: Redeem invite code
type: http
http:
method: POST
url: '{{baseUrl}}/api/code/invites/redeem/'
body:
type: json
data: '{}'
docs: Redeem a PostHog Code invite code to enable access.
- info:
name: alerts
type: folder
items:
- info:
name: environments_alerts_list
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/alerts/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_alerts_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/alerts/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_alerts_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/alerts/:id/'
params:
- name: checks_date_from
value: ''
type: query
description: Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns
checks created after this time. Max retention is 14 days.
- name: checks_date_to
value: ''
type: query
description: Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if
not specified.
- name: checks_limit
value: ''
type: query
description: Maximum number of check results to return (default 5, max 500). Applied after date filtering.
- name: checks_offset
value: ''
type: query
description: Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0.
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_alerts_update
type: http
http:
method: PUT
url: '{{baseUrl}}/api/environments/:environment_id/alerts/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_alerts_partial_update
type: http
http:
method: PATCH
url: '{{baseUrl}}/api/environments/:environment_id/alerts/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_alerts_destroy
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/environments/:environment_id/alerts/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_alerts_simulate_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/alerts/simulate/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.
- info:
name: alerts_list
type: http
http:
method: GET
url: '{{baseUrl}}/api/projects/:project_id/alerts/'
params:
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
- 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: alerts_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/projects/:project_id/alerts/'
params:
- 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/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: alerts_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/projects/:project_id/alerts/:id/'
params:
- name: checks_date_from
value: ''
type: query
description: Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns
checks created after this time. Max retention is 14 days.
- name: checks_date_to
value: ''
type: query
description: Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if
not specified.
- name: checks_limit
value: ''
type: query
description: Maximum number of check results to return (default 5, max 500). Applied after date filtering.
- name: checks_offset
value: ''
type: query
description: Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0.
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
- 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: alerts_update
type: http
http:
method: PUT
url: '{{baseUrl}}/api/projects/:project_id/alerts/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
- 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/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: alerts_partial_update
type: http
http:
method: PATCH
url: '{{baseUrl}}/api/projects/:project_id/alerts/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
- 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/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: alerts_destroy
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/projects/:project_id/alerts/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this alert configuration.
- 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: alerts_simulate_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/projects/:project_id/alerts/simulate/'
params:
- 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/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.
- info:
name: batch_exports
type: folder
items:
- info:
name: environments_batch_exports_list
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_backfills_list
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/'
params:
- name: batch_export_id
value: ''
type: path
- name: cursor
value: ''
type: query
description: The pagination cursor value.
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: ordering
value: ''
type: query
description: Which field to use when ordering the results.
auth:
type: bearer
token: '{{bearerToken}}'
docs: 'ViewSet for BatchExportBackfill models.
Allows creating and reading backfills, but not updating or deleting them.'
- info:
name: environments_batch_exports_backfills_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/'
params:
- name: batch_export_id
value: ''
type: path
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Create a new backfill for a BatchExport.
- info:
name: environments_batch_exports_backfills_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/:id/'
params:
- name: batch_export_id
value: ''
type: path
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export backfill.
auth:
type: bearer
token: '{{bearerToken}}'
docs: 'ViewSet for BatchExportBackfill models.
Allows creating and reading backfills, but not updating or deleting them.'
- info:
name: environments_batch_exports_backfills_cancel_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/:id/cancel/'
params:
- name: batch_export_id
value: ''
type: path
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export backfill.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Cancel a batch export backfill.
- info:
name: environments_batch_exports_runs_list
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/'
params:
- name: batch_export_id
value: ''
type: path
- name: cursor
value: ''
type: query
description: The pagination cursor value.
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: ordering
value: ''
type: query
description: Which field to use when ordering the results.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_runs_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/'
params:
- name: batch_export_id
value: ''
type: path
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export run.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_runs_cancel_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/cancel/'
params:
- name: batch_export_id
value: ''
type: path
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export run.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Cancel a batch export run.
- info:
name: environments_batch_exports_runs_logs_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/logs/'
params:
- name: after
value: ''
type: query
description: Only return entries after this ISO 8601 timestamp.
- name: batch_export_id
value: ''
type: path
- name: before
value: ''
type: query
description: Only return entries before this ISO 8601 timestamp.
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export run.
- name: instance_id
value: ''
type: query
description: Filter logs to a specific execution instance.
- name: level
value: ''
type: query
description: 'Comma-separated log levels to include, e.g. ''WARN,ERROR''. Valid levels: DEBUG, LOG, INFO, WARN, ERROR.'
- name: limit
value: ''
type: query
description: Maximum number of log entries to return (1-500, default 50).
- name: search
value: ''
type: query
description: Case-insensitive substring search across log messages.
- info:
name: environments_batch_exports_runs_retry_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/retry/'
params:
- name: batch_export_id
value: ''
type: path
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export run.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: 'Retry a batch export run.
We use the same underlying mechanism as when backfilling a batch export, as retrying
a run is the same as backfilling one run.'
- info:
name: environments_batch_exports_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_update
type: http
http:
method: PUT
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_partial_update
type: http
http:
method: PATCH
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_destroy
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_logs_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/logs/'
params:
- name: after
value: ''
type: query
description: Only return entries after this ISO 8601 timestamp.
- name: before
value: ''
type: query
description: Only return entries before this ISO 8601 timestamp.
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: instance_id
value: ''
type: query
description: Filter logs to a specific execution instance.
- name: level
value: ''
type: query
description: 'Comma-separated log levels to include, e.g. ''WARN,ERROR''. Valid levels: DEBUG, LOG, INFO, WARN, ERROR.'
- name: limit
value: ''
type: query
description: Maximum number of log entries to return (1-500, default 50).
- name: search
value: ''
type: query
description: Case-insensitive substring search across log messages.
- info:
name: environments_batch_exports_pause_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/pause/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Pause a BatchExport.
- info:
name: environments_batch_exports_run_test_step_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/run_test_step/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_unpause_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/unpause/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Unpause a BatchExport.
- info:
name: environments_batch_exports_run_test_step_new_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/run_test_step_new/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: environments_batch_exports_test_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/environments/:environment_id/batch_exports/test/'
params:
- name: environment_id
value: ''
type: path
description: Deprecated. Use /api/projects/{project_id}/ instead.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_list
type: http
http:
method: GET
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/'
params:
- name: limit
value: ''
type: query
description: Number of results to return per page.
- name: offset
value: ''
type: query
description: The initial index from which to return the results.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/'
params:
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_update
type: http
http:
method: PUT
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_partial_update
type: http
http:
method: PATCH
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_destroy
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_logs_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/logs/'
params:
- name: after
value: ''
type: query
description: Only return entries after this ISO 8601 timestamp.
- name: before
value: ''
type: query
description: Only return entries before this ISO 8601 timestamp.
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: instance_id
value: ''
type: query
description: Filter logs to a specific execution instance.
- name: level
value: ''
type: query
description: 'Comma-separated log levels to include, e.g. ''WARN,ERROR''. Valid levels: DEBUG, LOG, INFO, WARN, ERROR.'
- name: limit
value: ''
type: query
description: Maximum number of log entries to return (1-500, default 50).
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
- name: search
value: ''
type: query
description: Case-insensitive substring search across log messages.
- info:
name: org_organizations_batch_exports_pause_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/pause/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Pause a BatchExport.
- info:
name: org_organizations_batch_exports_run_test_step_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/run_test_step/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_unpause_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/unpause/'
params:
- name: id
value: ''
type: path
description: A UUID string identifying this batch export.
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Unpause a BatchExport.
- info:
name: org_organizations_batch_exports_run_test_step_new_create
type: http
http:
method: POST
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/run_test_step_new/'
params:
- name: organization_id
value: ''
type: path
description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
- info:
name: org_organizations_batch_exports_test_retrieve
type: http
http:
method: GET
url: '{{baseUrl}}/api/organizations/:organization_id/batch_exports/test/'
params:
- name: organization_id
value: ''
typ
# --- truncated at 32 KB (1050 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/apis.yml