Get Bulk Sync Status | Polytomic Docs

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

{
  "data": {
    "current_execution": {
      "completed_at": "2024-06-10T14:45:00Z",
      "created_at": "2024-06-10T14:00:00Z",
      "error_count": 2,
      "fetch_mode": "incremental",
      "id": "a3f9c1d2-5b7e-4f3a-9c2d-1e4b7f8a9cde",
      "is_partial": false,
      "is_resync": false,
      "is_test": false,
      "output_disposition": "retain",
      "record_count": 1250,
      "schemas": [
        {
          "completed_at": "2024-06-10T14:40:00Z",
          "created_at": "2024-06-10T14:00:00Z",
          "error_count": 1,
          "output_name": "contact",
          "record_count": 800,
          "schema": "contact",
          "started_at": "2024-06-10T14:05:00Z",
          "status": "running",
          "status_message": "Processing contact records",
          "updated_at": "2024-06-10T14:40:00Z",
          "warning_count": 1
        },
        {
          "completed_at": "2024-06-10T14:42:00Z",
          "created_at": "2024-06-10T14:00:00Z",
          "error_count": 1,
          "output_name": "account",
          "record_count": 450,
          "schema": "account",
          "started_at": "2024-06-10T14:10:00Z",
          "status": "running",
          "status_message": "Processing account records",
          "updated_at": "2024-06-10T14:42:00Z",
          "warning_count": 0
        }
      ],
      "started_at": "2024-06-10T14:00:00Z",
      "status": "running",
      "status_message": "Bulk sync is currently running",
      "type": "scheduled",
      "updated_at": "2024-06-10T14:44:00Z",
      "warning_count": 1
    },
    "ingestion_status": {
      "enabled": true,
      "highwater_mark": "2024-06-10T14:30:00Z",
      "is_running": true,
      "position": "offset_12345",
      "position_time": "2024-06-10T14:35:00Z",
      "status": "ok",
      "status_message": "Ingestion operating normally",
      "updated_at": "2024-06-10T14:44:00Z"
    },
    "last_execution": {
      "completed_at": "2024-06-09T12:00:00Z",
      "created_at": "2024-06-09T11:00:00Z",
      "error_count": 0,
      "fetch_mode": "incremental",
      "id": "b4e7d3f1-6c8a-4d2b-9f3e-2d5c8e7a1b2f",
      "is_partial": false,
      "is_resync": false,
      "is_test": false,
      "output_disposition": "retain",
      "record_count": 1200,
      "schemas": [
        {
          "completed_at": "2024-06-09T11:55:00Z",
          "created_at": "2024-06-09T11:00:00Z",
          "error_count": 0,
          "output_name": "contact",
          "record_count": 750,
          "schema": "contact",
          "started_at": "2024-06-09T11:05:00Z",
          "status": "completed",
          "status_message": "Contact records synced successfully",
          "updated_at": "2024-06-09T11:55:00Z",
          "warning_count": 0
        },
        {
          "completed_at": "2024-06-09T11:58:00Z",
          "created_at": "2024-06-09T11:00:00Z",
          "error_count": 0,
          "output_name": "account",
          "record_count": 450,
          "schema": "account",
          "started_at": "2024-06-09T11:10:00Z",
          "status": "completed",
          "status_message": "Account records synced successfully",
          "updated_at": "2024-06-09T11:58:00Z",
          "warning_count": 0
        }
      ],
      "started_at": "2024-06-09T11:00:00Z",
      "status": "completed",
      "status_message": "Bulk sync completed successfully",
      "type": "scheduled",
      "updated_at": "2024-06-09T12:00:00Z",
      "warning_count": 0
    },
    "next_execution_time": "2024-06-11T14:00:00Z"
  }
}

Returns the current status of a bulk sync.

The response includes the sync’s current active/inactive state together with information about the most recent execution — its status, start time, and any errors — making this endpoint well-suited for health checks and monitoring dashboards.

For the complete execution history, use GET /api/bulk/syncs/{id}/executions. For the full details of a specific run, including per-schema breakdowns, use GET /api/bulk/syncs/{id}/executions/{exec_id}.

Returns the current status of a bulk sync. The response includes the sync's current active/inactive state together with information about the most recent execution — its status, start time, and any errors — making this endpoint well-suited for health checks and monitoring dashboards. For the complete execution history, use [`GET /api/bulk/syncs/{id}/executions`](../../../../../api-reference/bulk-sync/executions/list). For the full details of a specific run, including per-schema breakdowns, use [`GET /api/bulk/syncs/{id}/executions/{exec_id}`](../../../../../api-reference/bulk-sync/executions/get).

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

Response

dataobject

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors