Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

Get Transform Checkpoints

Get checkpoint statistics and state size information for a transform job.

Returns checkpoint counts, summary statistics (state size, duration, etc.), latest checkpoint details, and checkpoint history.

Args: transform_id: The transform ID

Returns: TransformCheckpointsInfo: Checkpoint statistics and history None: If transform job not found or no checkpoints available

GET/transforms/{transform_id}/checkpoints
Authorization
AuthorizationBearer token · headerrequired
Path parameters
transform_idstringrequired
Query parameters
include_operator_breakdownboolean
default: true
Responses
200

Successful Response

Any of:
TransformCheckpointsInfo
job_idstringrequired
countsobjectrequired
summaryobjectrequired
latestTransformCheckpointHistory | null
Show properties
Any of:
TransformCheckpointHistory
idintegerrequired
statusstringrequired
is_savepointbooleanrequired
trigger_timestampintegerrequired
latest_ack_timestampintegerrequired
state_sizeintegerrequired
end_to_end_durationintegerrequired
alignment_bufferedintegerrequired
num_subtasksintegerrequired
num_acknowledged_subtasksintegerrequired
null
null
historyTransformCheckpointHistory[]
default: []
Show properties
Array of TransformCheckpointHistory
idintegerrequired
statusstringrequired
is_savepointbooleanrequired
trigger_timestampintegerrequired
latest_ack_timestampintegerrequired
state_sizeintegerrequired
end_to_end_durationintegerrequired
alignment_bufferedintegerrequired
num_subtasksintegerrequired
num_acknowledged_subtasksintegerrequired
operator_breakdownTransformOperatorState[]
default: []
Show properties
Array of TransformOperatorState
operator_idstringrequired
operator_namestringrequired
state_sizeintegerrequired
checkpointed_sizeintegerrequired
end_to_end_durationintegerrequired
parallelismintegerrequired
null
null
422

Validation Error

detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X GET 'https://api.streamkap.com/transforms/string/checkpoints' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "job_id": "string",
  "counts": {},
  "summary": {},
  "latest": {
    "id": 0,
    "status": "string",
    "is_savepoint": true,
    "trigger_timestamp": 0,
    "latest_ack_timestamp": 0,
    "state_size": 0,
    "end_to_end_duration": 0,
    "alignment_buffered": 0,
    "num_subtasks": 0,
    "num_acknowledged_subtasks": 0
  },
  "history": [],
  "operator_breakdown": []
}