SautiDesk
SautiDesk API
Workspace configuration

Get the admin dashboard figures

GET
/v1/desk/admin/dashboard

Returns the figures for the admin overview: workspace state, people, numbers and activity. Choose the window with period (with from and to for custom), or return one tile with part.

Requires: desk.admin scope, workspace owner or admin.

Authorization

bearerAuth
AuthorizationBearer <token>

A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.

In: header

Query Parameters

period?string

today, 7d (the default), 30d, month or custom. custom needs from and to.

from?string

Start of a custom period (RFC 3339). Used with period=custom.

to?string

End of a custom period (RFC 3339). Used with period=custom.

part?string

Return one tile of the dashboard on its own (storage, seats, contacts, calls, messages or chart) instead of the whole page.

Response

OK

Example

{}
curl -X GET "https://api.sautidesk.com/v1/desk/admin/dashboard"