provider batch_exportsbatch_exports POST /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/
@utdk/posthog /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/
environments_batch_exports_runs_cancel_create
Cancel a batch export run.
batch_export_id path required
string
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
A UUID string identifying this batch export run.
string

Try it

Authentication
Configure credentials for PostHog API
environmentsBatchExportsRunsCancelCreate
POST/api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/
Cancel a batch export run.

Parameters

required
required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A UUID string identifying this batch export run.

Input

required
required

The status of this run. * `Cancelled` - Cancelled * `Completed` - Completed * `ContinuedAsNew` - Continued As New * `Failed` - Failed * `FailedRetryable` - Failed Retryable * `FailedBilling` - Failed Billing * `Terminated` - Terminated * `TimedOut` - Timedout * `Running` - Running * `Starting` - Starting

The number of records that have been exported.

The number of records that failed downstream processing (e.g. hog function execution errors).

The latest error that occurred during this run.

The start of the data interval.

required

The end of the data interval.

An opaque cursor that may be used to resume.

required

The timestamp at which this BatchExportRun was created.

The timestamp at which this BatchExportRun finished, successfully or not.

required

The timestamp at which this BatchExportRun was last updated.

The total count of records that should be exported in this BatchExportRun.

The number of bytes that have been exported in this BatchExportRun.

required

The `BatchExport` this run belongs to.

The `BatchExportOnDemand` this run belongs to.

The backfill this run belongs to.

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.environmentsBatchExportsRunsCancelCreate()