Skip to main content
Estimate a sync

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
date_from
string

First invoice date to read, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
date_through
string

Last invoice date to read, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
scope
object

Omit to read the integration’s saved scope. When sent, it replaces the saved scope for this run: every dimension it leaves out reads everything instead of falling back to the saved value.

Response

The estimate started.

id
string<uuid>
required
integration_id
string<uuid>
required
status
enum<string>
required
Available options:
running,
completed,
failed,
cancelled
period
object
required

Invoice dates counted: from is inclusive, to is exclusive.

scope
object
required

The scope counted: the saved one, or the run scope applied over it.

invoice_count
integer | null
required

Invoices a sync of this period and scope would import. Null until completed.

lower_bound
boolean
required

The count stopped at the time limit, so a sync would import at least invoice_count.

configuration_revision_matches
boolean
required

False once the integration scope or credentials changed after the estimate started; the count no longer describes what a sync would read.

created_at
string<date-time>
required
finished_at
string<date-time> | null
required