ENendclose

Get a data stream operation

Changed on

Poll a delete or reset operation kicked off against this data stream. Returns the serialized DataStreamOperation. On a terminal status, records_remaining is the primary-database count of records left on the stream (0 on completed), so callers can trust the operation instead of re-listing records.

get/data_streams/{key}/operations/{id}

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

keystring required

The immutable data stream key

idstring required

The operation ID returned by DELETE /data_streams/{key} or POST /data_streams/{key}/reset

Response

The operation

idstring uuid
data_stream_idstring uuid
data_stream_keystring
kind'delete' | 'reset'
status'pending' | 'running' | 'completed' | 'failed'
progressinteger

Percentage 0-100

error_messagestring nullable
records_remaininginteger nullable

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_atstring date-time nullable
completed_atstring date-time nullable
created_atstring date-time
requested_by_user_idstring uuid nullable

Changes

  • 159f9ed3dbf4Revision changes
    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

  • c9135e894f51Revision changes
    • info

      added the optional property to the response with the status