Skip to main content
POST
Run KPI HTTP sync now

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

id identifier

kpiId
string
required

kpiId identifier

syncId
string
required

syncId identifier

Body

application/json

Defaults to preview. Snapshot writes require explicit confirmation.

Defaults to dry-run preview. Writing an api_poll snapshot requires both write_snapshot true and the exact confirm string.

write_snapshot
boolean

Omit or false for preview. Must be true to write a snapshot.

confirm
enum<string>

Required exactly when write_snapshot is true.

Available options:
write api_poll snapshot

Response

Successful response

mode
enum<string>
Available options:
preview,
write
result
object

Sanitized execution result. Raw response bodies, secret values, and third-party payloads are never returned.

run
object