A valid request URL is required to generate request examples[
{
"task_id": "<string>",
"job_history_id": "<string>",
"affected_rows": 123,
"status": "<string>",
"details": "<string>",
"run_type": "<string>",
"start_position": "<string>",
"last_checkpoint": "<string>",
"records_inserted": 123,
"records_merged": 123,
"records_deleted": 123,
"error_message": "<string>",
"query": "<string>",
"table": "<string>",
"runtime": "<string>",
"run_start_at": "2023-11-07T05:31:56Z",
"run_end_at": "2023-11-07T05:31:56Z",
"instance_id": "<string>",
"error": "<string>"
}
]{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}Get task run history
A valid request URL is required to generate request examples[
{
"task_id": "<string>",
"job_history_id": "<string>",
"affected_rows": 123,
"status": "<string>",
"details": "<string>",
"run_type": "<string>",
"start_position": "<string>",
"last_checkpoint": "<string>",
"records_inserted": 123,
"records_merged": 123,
"records_deleted": 123,
"error_message": "<string>",
"query": "<string>",
"table": "<string>",
"runtime": "<string>",
"run_start_at": "2023-11-07T05:31:56Z",
"run_end_at": "2023-11-07T05:31:56Z",
"instance_id": "<string>",
"error": "<string>"
}
]{
"code": 123,
"message": "<string>",
"error": "<string>",
"error_code": "INVALID_REFERENCE",
"provider_id": "<string>",
"item_name": "<string>"
}Authorizations
A Sync user auth token. Generate one via POST /v2/users/generate-token.
Response
Task history records
The task run status, e.g. SUCCESS, RETRY SUCCESS, PARTIAL_SUCCESS, RETRY PARTIAL_SUCCESS, FAILED, RETRY FAILED, ERROR, or SKIPPED. PARTIAL_SUCCESS (and RETRY PARTIAL_SUCCESS) indicates that at least one chunk succeeded and at least one chunk failed.
A detailed message for the status. For failed or partial-success tasks this is the error message; for successful tasks it is a summary such as "Records affected: N". Returned as a flat string for backward compatibility.
Replication run type reported by ReplicateEngine for upgraded jobs (statusversion >= 26.3), e.g. FULL_SNAPSHOT, INCREMENTAL_SNAPSHOT, PARTITIONED_SNAPSHOT, INCREMENTAL, or CDC. Null when unavailable.
Position the run started from, such as a timestamp or CDC position. Null when unavailable.
Last checkpoint reached by the run. Null when unavailable.
Records inserted by the run, summed across automatic retries that keep previous writes. Null when unavailable.
Records merged by the run, summed across automatic retries that keep previous writes. Null when unavailable.
Records deleted by the run, summed across automatic retries that keep previous writes. Null when unavailable.
Error message of a failed or partially successful completed run. Null otherwise.