v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Model Sync

Get Sync Status

Returns the current status of a model sync.

The response includes a summary of the most recent execution, including its start time, completion time, and record counts. For the complete execution history, use GET /api/syncs/{id}/executions.

get/api/syncs/{id}/status

Path parameters

idstring uuid required

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Response

Example response

{
  "data": {
    "current_execution": {
      "completed_at": "2024-01-01T00:00:00Z",
      "counts": {
        "delete": 42,
        "error": 5,
        "insert": 80,
        "total": 100,
        "update": 15,
        "upserts": 10,
        "warnings": 10
      },
      "created_at": "2024-01-01T00:00:00Z",
      "errors": [
        "something went wrong"
      ],
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "started_at": "2024-01-01T00:00:00Z",
      "type": "scheduled"
    },
    "last_execution": {
      "completed_at": "2024-01-01T00:00:00Z",
      "counts": {
        "delete": 42,
        "error": 5,
        "insert": 80,
        "total": 100,
        "update": 15,
        "upserts": 10,
        "warnings": 10
      },
      "created_at": "2024-01-01T00:00:00Z",
      "errors": [
        "something went wrong"
      ],
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "started_at": "2024-01-01T00:00:00Z",
      "type": "scheduled"
    },
    "next_execution_time": "2024-01-01T00:00:00Z"
  }
}