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

Pypestream Batch Exports API

The Batch Exports API from Pypestream — 7 operation(s) for batch exports.

Pypestream Batch Exports API is one of 27 APIs that Pypestream 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, and an AsyncAPI specification.

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

Requests are made against a single base URL, https://analytics.pypestream.com/.

11 operations 7 paths 11 schemas 1 DELETE4 GET1 PATCH4 POST1 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://reporting.pypestream.com/api/v2/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Pypestream Batch Exports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (APIKey). By default, every request must be authenticated.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Batch Exports 11
GET
/api/datasets/{dataset_id}/batch_exports/
Retrieves a paginated list of all batch export configurations for the specified dataset. Use this to view all active and inactive exports, their destinations, and schedules.
batch_exports_list 3 params → 200
POST
/api/datasets/{dataset_id}/batch_exports/
Creates a new batch export configuration. This endpoint requires a destination type (e.g., S3, Snowflake), an interval (e.g., daily, hourly), and the necessary credentials to configure the export pip…
batch_exports_create 1 param body → 201
GET
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/
Retrieves the execution history for a specific batch export. This returns a list of past runs, allowing you to monitor the success or failure status of the export schedule.
batch_exports_runs_list 4 params → 200
GET
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/
Retrieves the details of a single execution run. This is useful for debugging specific failures or verifying the timestamps and data volume of a particular export cycle.
batch_exports_runs_retrieve 3 params → 200
GET
/api/datasets/{dataset_id}/batch_exports/{id}/
Retrieves the full configuration details of a specific batch export identified by its ID.
batch_exports_retrieve 2 params → 200
PUT
/api/datasets/{dataset_id}/batch_exports/{id}/
Updates an existing batch export configuration. This is a full update that replaces the current configuration with the data provided in the request body.
batch_exports_update 2 params body → 200
PATCH
/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.
batch_exports_partial_update 2 params body → 200
DELETE
/api/datasets/{dataset_id}/batch_exports/{id}/
Permanently deletes a batch export configuration. This action stops all future runs and removes the export setup from the project.
batch_exports_destroy 2 params → 204
POST
/api/datasets/{dataset_id}/batch_exports/{id}/backfill/
Manually triggers a backfill job for a specific historical date range. This allows you to export data that was collected before the batch export was originally created or during a period where the ex…
batch_exports_backfill_create 2 params body → 200
POST
/api/datasets/{dataset_id}/batch_exports/{id}/pause/
Pauses the batch export schedule. New runs will not be triggered until the export is unpaused, but the configuration remains saved.
batch_exports_pause_create 2 params → 200
POST
/api/datasets/{dataset_id}/batch_exports/{id}/unpause/
Resumes a paused batch export. The schedule will restart based on the configured interval.
batch_exports_unpause_create 2 params body → 200

Schemas 11

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

PaginatedBatchExportRunList
object
4 properties
BatchExportUnpause
object
1 property
BatchExportDestination
object
Serializer for an BatchExportDestination model.
2 properties 1 required
BatchExportBackfill
object
2 properties 2 required
BatchExportPauseUnpauseResponse
object
1 property
BatchExportRun
object
Serializer for a BatchExportRun model.
11 properties 7 required
PatchedBatchExport
object
Serializer for a BatchExport model.
12 properties
BatchExport
object
Serializer for a BatchExport model.
12 properties 6 required
S3BatchExportConfig
object
Configuration required to export batches to Amazon S3.
6 properties 6 required
SnowflakeBatchExportConfig
object
Configuration required to export batches to Snowflake.
7 properties 7 required
PaginatedBatchExportList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Pypestream publishes across the network.

Pypestream Actions API
Pypestream Advanced API
Pypestream Agent API
Pypestream Annotations API
Pypestream Cohorts API
Pypestream Configuration API
Pypestream Conversations API
Pypestream Dashboards API
Pypestream Datasets API
Pypestream Display Control API
Pypestream Endpoints API
Pypestream Event Definitions API
Where this information came from

This is an independent, third-party profile of Pypestream 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.