How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog batch_exports API

The batch_exports API from PostHog — 40 operation(s) for batch_exports.

PostHog batch_exports API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Batch Exports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 54 operations across 40 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

54 operations 40 paths 16 schemas 3 DELETE22 GET3 PATCH23 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog batch_exports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 54

Across 40 paths, the API surfaces 54 operations — 3 DELETE, 22 GET, 3 PATCH, 23 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

batch_exports 54
GET
/api/environments/{environment_id}/batch_exports/deprecated
environments_batch_exports_list 3 params → 200
POST
/api/environments/{environment_id}/batch_exports/deprecated
environments_batch_exports_create 1 param body → 201
GET
/api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/deprecated
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
environments_batch_exports_backfills_list 4 params → 200
POST
/api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/deprecated
Create a new backfill for a BatchExport.
environments_batch_exports_backfills_create 2 params body → 201
GET
/api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/{id}/deprecated
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
environments_batch_exports_backfills_retrieve 3 params → 200
POST
/api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/deprecated
Cancel a batch export backfill.
environments_batch_exports_backfills_cancel_create 3 params body → 200
GET
/api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/deprecated
environments_batch_exports_runs_list 4 params → 200
GET
/api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/deprecated
environments_batch_exports_runs_retrieve 3 params → 200
POST
/api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/deprecated
Cancel a batch export run.
environments_batch_exports_runs_cancel_create 3 params body → 200
GET
/api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/logs/deprecated
environments_batch_exports_runs_logs_retrieve 9 params → 200
POST
/api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/retry/deprecated
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.
environments_batch_exports_runs_retry_create 3 params body → 200
GET
/api/environments/{environment_id}/batch_exports/{id}/deprecated
environments_batch_exports_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/batch_exports/{id}/deprecated
environments_batch_exports_update 2 params body → 200
PATCH
/api/environments/{environment_id}/batch_exports/{id}/deprecated
environments_batch_exports_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/batch_exports/{id}/deprecated
environments_batch_exports_destroy 2 params → 204
GET
/api/environments/{environment_id}/batch_exports/{id}/logs/deprecated
environments_batch_exports_logs_retrieve 8 params → 200
POST
/api/environments/{environment_id}/batch_exports/{id}/pause/deprecated
Pause a BatchExport.
environments_batch_exports_pause_create 2 params body → 200
POST
/api/environments/{environment_id}/batch_exports/{id}/run_test_step/deprecated
environments_batch_exports_run_test_step_create 2 params body → 200
POST
/api/environments/{environment_id}/batch_exports/{id}/unpause/deprecated
Unpause a BatchExport.
environments_batch_exports_unpause_create 2 params body → 200
POST
/api/environments/{environment_id}/batch_exports/run_test_step_new/deprecated
environments_batch_exports_run_test_step_new_create 1 param body → 200
GET
/api/environments/{environment_id}/batch_exports/test/deprecated
environments_batch_exports_test_retrieve 1 param → 200
GET
/api/organizations/{organization_id}/batch_exports/deprecated
org_organizations_batch_exports_list 3 params → 200
POST
/api/organizations/{organization_id}/batch_exports/deprecated
org_organizations_batch_exports_create 1 param body → 201
GET
/api/organizations/{organization_id}/batch_exports/{id}/deprecated
org_organizations_batch_exports_retrieve 2 params → 200
PUT
/api/organizations/{organization_id}/batch_exports/{id}/deprecated
org_organizations_batch_exports_update 2 params body → 200
PATCH
/api/organizations/{organization_id}/batch_exports/{id}/deprecated
org_organizations_batch_exports_partial_update 2 params body → 200
DELETE
/api/organizations/{organization_id}/batch_exports/{id}/deprecated
org_organizations_batch_exports_destroy 2 params → 204
GET
/api/organizations/{organization_id}/batch_exports/{id}/logs/deprecated
org_organizations_batch_exports_logs_retrieve 8 params → 200
POST
/api/organizations/{organization_id}/batch_exports/{id}/pause/deprecated
Pause a BatchExport.
org_organizations_batch_exports_pause_create 2 params body → 200
POST
/api/organizations/{organization_id}/batch_exports/{id}/run_test_step/deprecated
org_organizations_batch_exports_run_test_step_create 2 params body → 200
POST
/api/organizations/{organization_id}/batch_exports/{id}/unpause/deprecated
Unpause a BatchExport.
org_organizations_batch_exports_unpause_create 2 params body → 200
POST
/api/organizations/{organization_id}/batch_exports/run_test_step_new/deprecated
org_organizations_batch_exports_run_test_step_new_create 1 param body → 200
GET
/api/organizations/{organization_id}/batch_exports/test/deprecated
org_organizations_batch_exports_test_retrieve 1 param → 200
GET
/api/projects/{project_id}/batch_exports/
batch_exports_list 3 params → 200
POST
/api/projects/{project_id}/batch_exports/
batch_exports_create 1 param body → 201
GET
/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
batch_exports_backfills_list 4 params → 200
POST
/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/
Create a new backfill for a BatchExport.
batch_exports_backfills_create 2 params body → 201
GET
/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
batch_exports_backfills_retrieve 3 params → 200
POST
/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/
Cancel a batch export backfill.
batch_exports_backfills_cancel_create 3 params body → 200
GET
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/
batch_exports_runs_list 4 params → 200
GET
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/
batch_exports_runs_retrieve 3 params → 200
POST
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/
Cancel a batch export run.
batch_exports_runs_cancel_create 3 params body → 200
GET
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/logs/
batch_exports_runs_logs_retrieve 9 params → 200
POST
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/retry/
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.
batch_exports_runs_retry_create 3 params body → 200
GET
/api/projects/{project_id}/batch_exports/{id}/
batch_exports_retrieve 2 params → 200
PUT
/api/projects/{project_id}/batch_exports/{id}/
batch_exports_update 2 params body → 200
PATCH
/api/projects/{project_id}/batch_exports/{id}/
batch_exports_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/batch_exports/{id}/
batch_exports_destroy 2 params → 204
GET
/api/projects/{project_id}/batch_exports/{id}/logs/
batch_exports_logs_retrieve 8 params → 200
POST
/api/projects/{project_id}/batch_exports/{id}/pause/
Pause a BatchExport.
batch_exports_pause_create 2 params body → 200
POST
/api/projects/{project_id}/batch_exports/{id}/run_test_step/
batch_exports_run_test_step_create 2 params body → 200
POST
/api/projects/{project_id}/batch_exports/{id}/unpause/
Unpause a BatchExport.
batch_exports_unpause_create 2 params body → 200
POST
/api/projects/{project_id}/batch_exports/run_test_step_new/
batch_exports_run_test_step_new_create 1 param body → 200
GET
/api/projects/{project_id}/batch_exports/test/
batch_exports_test_retrieve 1 param → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BatchExport (19 properties), PatchedBatchExport (19 properties), BatchExportRun (15 properties), BatchExportBackfill (12 properties). Each schema is shown below with its type and property counts.

PaginatedBatchExportList
object
4 properties 2 required
BatchExportRun
object
Serializer for a BatchExportRun model.
15 properties 6 required
IntervalEnum
string
hour - hour day - day week - week every 5 minutes - every 5 minutes every 15 minutes - every 15 minutes
NullEnum
BatchExportBackfill
object
12 properties 7 required
BatchExportDestinationTypeEnum
string
S3 - S3 Snowflake - Snowflake Postgres - Postgres Redshift - Redshift BigQuery - Bigquery Databricks - Databricks AzureBlob - Azure Blob Workflows - Workflows…
BatchExportDestination
object
Serializer for an BatchExportDestination model.
4 properties 1 required
BatchExport
object
Serializer for a BatchExport model.
19 properties 9 required
PatchedBatchExport
object
Serializer for a BatchExport model.
19 properties
TimezoneEnum
string
Africa/Abidjan - Africa/Abidjan Africa/Accra - Africa/Accra Africa/AddisAbaba - Africa/AddisAbaba Africa/Algiers - Africa/Algiers Africa/Asmara - Africa/Asmara…
ModelEnum
string
events - Events persons - Persons sessions - Sessions
PaginatedBatchExportRunList
object
3 properties 1 required
BatchExportBackfillStatusEnum
string
Cancelled - Cancelled Completed - Completed ContinuedAsNew - Continued As New Failed - Failed FailedRetryable - Failed Retryable Terminated - Terminated TimedO…
BlankEnum
BatchExportRunStatusEnum
string
Cancelled - Cancelled Completed - Completed ContinuedAsNew - Continued As New Failed - Failed FailedRetryable - Failed Retryable FailedBilling - Failed Billing…
PaginatedBatchExportBackfillList
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-batch-exports-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog batch_exports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.