Skip to main content
POST
Reset a data stream

Authorizations

X-API-KEY
string
header
required

Path Parameters

key
string
required

The immutable data stream key

Response

Reset accepted. Poll GET /data_streams/{key}/operations/{id} (also set in the Location header).

Async operation against a data stream (delete or reset). Poll via GET /data_streams/{key}/operations/{id}. An operation only reaches completed once the stream is verified empty in the primary database; if records outlive the wipe (for example, ingestion landing mid-reset), it ends failed with records_remaining > 0 and an error_message asking you to retry.

id
integer
data_stream_id
integer
data_stream_key
string
kind
enum<string>
Available options:
delete,
reset
status
enum<string>
Available options:
pending,
running,
completed,
failed
progress
integer

Percentage 0-100

error_message
string | null
records_remaining
integer | null

Number of records still on the stream when the operation reached a terminal state, counted in the primary database (not the analytics mirror behind records_count, which can lag). 0 on completed; greater than 0 on a failed operation that left records behind; null while pending or running. After a reset, trust this field rather than re-listing /records.

started_at
string<date-time> | null
completed_at
string<date-time> | null
created_at
string<date-time>
requested_by_user_id
integer | null