Sync Progress

Report sync progress for a connected integration.

Returns latest (the most recent run’s progress snapshot, null when there is none), activeRuns (unfinished runs this process can confirm are executing) and unknownActivityCount (unfinished runs owned by another process or an exited worker). An unregistered provider, no active connection for the caller, and a connection revoked or re-owned since it was read all return 404.

Path Parameters

• provider (str): Key of a registered OAuth provider (see GET /api/v1/integrations/status).

Query Parameters

• account_id (Optional[str]): Connection to use (from GET /api/v1/integrations/{provider}/connections); the newest one is used when omitted. An id that is not the caller’s, or a blank one, returns 404 and never falls back to another connection.

GET /api/v1/integrations/{provider}/sync/progress

Sync Progress

cURL

curl --request GET \
  --url https://{tenant}.aws.cognee.ai/api/v1/integrations/{provider}/sync/progress \
  --header 'Authorization: Bearer <token>'

200

{
  "latest": {
    "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "<string>",
    "credentialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startedAt": "2023-11-07T05:31:56Z",
    "phaseStartedAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state": "running",
    "phase": "checking",
    "endedAt": "2023-11-07T05:31:56Z",
    "completed": 1,
    "total": 1,
    "unit": "items",
    "counts": {},
    "reason": "rate_limited",
    "elapsedSeconds": 0,
    "phaseElapsedSeconds": 0,
    "phasePercent": 123,
    "phaseEtaSeconds": 123,
    "executionActive": true
  },
  "activeRuns": [
    {
      "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "<string>",
      "credentialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startedAt": "2023-11-07T05:31:56Z",
      "phaseStartedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": "running",
      "phase": "checking",
      "endedAt": "2023-11-07T05:31:56Z",
      "completed": 1,
      "total": 1,
      "unit": "items",
      "counts": {},
      "reason": "rate_limited",
      "elapsedSeconds": 0,
      "phaseElapsedSeconds": 0,
      "phasePercent": 123,
      "phaseEtaSeconds": 123,
      "executionActive": true
    }
  ],
  "unknownActivityCount": 0
}

Authorizations

BearerAuthApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

provider · string · required

Query Parameters

account_id · string | null

Response

200

application/json

Successful Response

Latest invocation and all locally confirmed active invocations.

Unknown activity counts unresolved durable runs owned by a different process or an exited worker. It is deliberately not reported as a live or failed job count.

latest · SyncProgress · object | null

Last observation plus phase-local estimates; no source text or exception messages.

Show child attributes

activeRuns · SyncProgress · object[]

Show child attributes

unknownActivityCount · integer · default: 0