sync

Get a sync

The full record of one sync: status, per-campaign progress, totals and structured errors. Poll it after Trigger a sync.

Read effectiveStatus: queued and in_progress mean keep polling; stalled means the run has shown no activity for over ten minutes and will be reaped; completed, partial, failed and cancelled are final. partial means some campaigns failed; their errorCode and errorDetails are in progress.campaignDetails[].

Errors

  • 404 NOT_FOUND: no sync with this id in the active Space.
get/api/v1/sync/{id}

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/sync/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The sync id, as returned by Trigger a sync (syncId).

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.