connectors

Where the caller's sync stands (any role)

The progress of the caller's own subject: for a practice system each member signs in to, the caller's own session (404 while they are not signed in); for a system the firm connected once, the firm's connector, whatever its status (a connector waiting on its team step is read and has progress as a connected one has). state is running while a sync of it is going on. first is true until the subject's matters are in for the first time (its first whole read has committed them; the read-back that follows has no say in it), which is what member.system_link.synced on GET /v1/me says too and what Release waits for. total is how many matters the read answers in all and is null until the system's first page has said so; done is how many of them are in. failed says the last run ended in an error and carries no text. Read from a route of its own because GET /v1/connector gains no key. 404 while the firm has no connector.

get/v1/connector/sync/progress

Request

  • Base URL
    https://api.sixminute.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Response

The sync's state and count.

state'idle' | 'running' required
firstboolean required
totalinteger nullable required
doneinteger required
started_atstring date-time nullable required
finished_atstring date-time nullable required
failedboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.