/api/datasets/{dataset_id}/batch_exports/{id}/

patch

https://analytics.pypestream.com/api/datasets/{dataset_id}/batch_exports/{id}/

Partially updates an existing batch export configuration. Use this to modify specific fields (such as the interval or destination settings) without replacing the entire object.

Path Params

dataset_id

string

required

Dataset ID of the dataset you're trying to access. To find the ID of the dataset, make a call to /api/datasets/.

uuid

required

A UUID string identifying this batch export.

Body Params

Serializer for a BatchExport model.

name

string

A human-readable name for this BatchExport.

destination

object

Serializer for an BatchExportDestination model.

interval

string

enum

The interval at which to export data.

Allowed:

last_paused_at

date-time | null

The timestamp at which this BatchExport was last paused.

start_at

date-time | null

Time before which any Batch Export runs won't be triggered.

end_at

date-time | null

Time after which any Batch Export runs won't be triggered.

trigger_immediately

boolean

Defaults to false

mask_pii

boolean

Defaults to false

If true, personally identifiable information is masked in the properties of exported events. A property is considered to contain PII if a retention period is set for it.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200