Skip to main content
POST
Get routed-to users per period

Authorizations

Authorization
string
header
required

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

Body

application/json
scope
enum<string>
required
Available options:
user,
team,
org
Example:

"user"

startDate
string
required

Inclusive start date for routing insights

Example:

"2024-01-01"

endDate
string
required

Inclusive end date for routing insights

Example:

"2024-01-31"

period
enum<string>
required
Available options:
perDay,
perWeek,
perMonth
Example:

"perWeek"

limit
number
required
Required range: x <= 100
Example:

10

selectedTeamId
number

Team ID for team-scoped routing insights

Example:

12

columnFilters
object[]

Data-table column filters (discriminated union by type: ss, ms, t, n, dr). Date range filters use id=createdAt.

Example:
searchQuery
string
Example:

"Alice"

Response

200 - application/json
status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object
required