Get Sync Status

curl https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>"

{
  "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",
      "status": "created",
      "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",
      "status": "created",
      "type": "scheduled"
    },
    "next_execution_time": "2024-01-01T00:00:00Z"
  }
}

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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Response

dataobject

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors