Skip to main content
POST
/
v2
/
insights
/
routings
/
routed-to-per-period
Get routed-to users per period
curl --request POST \
  --url https://api.cal.com/v2/insights/routings/routed-to-per-period \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "user",
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "period": "perWeek",
  "limit": 10,
  "selectedTeamId": 12,
  "columnFilters": [
    {
      "id": "createdAt",
      "value": {
        "type": "dr",
        "data": {
          "startDate": "2024-01-01",
          "endDate": "2024-01-31",
          "preset": "custom"
        }
      }
    }
  ],
  "searchQuery": "Alice"
}
'
{
  "status": "success",
  "data": {
    "users": {
      "data": [
        {
          "id": 101,
          "name": "Alice Doe",
          "email": "[email protected]",
          "avatarUrl": "https://example.com/avatar.png",
          "performance": "above_average",
          "totalBookings": 12
        }
      ]
    },
    "periodStats": {
      "data": [
        {
          "userId": 101,
          "period_start": "2024-01-01T00:00:00.000Z",
          "total": 3
        }
      ]
    }
  }
}

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:
[
  {
    "id": "createdAt",
    "value": {
      "type": "dr",
      "data": {
        "startDate": "2024-01-01",
        "endDate": "2024-01-31",
        "preset": "custom"
      }
    }
  }
]
​
searchQuery
string
Example:

"Alice"

Response

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

"success"

​
data
object
required