Get a replay job's progress
GET
/v1/replays/{id}
Where a replay has got to. replayed against total_estimate is the progress; the counters update after each page, so polling every second or two shows it move.
Authorizations
apiKey
Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Responses
The replay job.
application/json
JSON "id": "rpj_01M2Y", "endpoint": "ep_01JX9", "state": "string", "since": "string", "until": "string", "status": "string", "destinations": [ "string" ], "replay_id": "string", "stop_requested": true, "total_estimate": 0, "scanned": 0, "replayed": 0, "enqueued": 0, "skipped": 0, "excluded": 0, "resumed_from": 0, "destinations_used": [ "string" ], "error": "string", "created_at": "string", "started_at": "string", "finished_at": "string"
{
}