GET
/
api
/
v1
/
reports

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
type
enum<string>
required

Type of the report to query.

Available options:
workspace_activity
​
metric
enum<string>

Specific metric of interest in the report.

Available options:
sync_run_triggered,
total_sync_run_rows,
all
​
connector_ids
integer[]

IDs of the connectors.

​
time_period
enum<string>

Time period for the report.

Available options:
one_week,
one_day

Response

200 - application/json
​
data
object

Was this page helpful?

Suggest edits
List Sync RecordsList Roles