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"
}
'
import requests

url = "https://api.cal.com/v2/insights/routings/routed-to-per-period"

payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};

fetch('https://api.cal.com/v2/insights/routings/routed-to-per-period', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cal.com/v2/insights/routings/routed-to-per-period",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.cal.com/v2/insights/routings/routed-to-per-period"

payload := strings.NewReader("{\n \"scope\": \"user\",\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-31\",\n \"period\": \"perWeek\",\n \"limit\": 10,\n \"selectedTeamId\": 12,\n \"columnFilters\": [\n {\n \"id\": \"createdAt\",\n \"value\": {\n \"type\": \"dr\",\n \"data\": {\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-31\",\n \"preset\": \"custom\"\n }\n }\n }\n ],\n \"searchQuery\": \"Alice\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/insights/routings/routed-to-per-period")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"user\",\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-31\",\n \"period\": \"perWeek\",\n \"limit\": 10,\n \"selectedTeamId\": 12,\n \"columnFilters\": [\n {\n \"id\": \"createdAt\",\n \"value\": {\n \"type\": \"dr\",\n \"data\": {\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-31\",\n \"preset\": \"custom\"\n }\n }\n }\n ],\n \"searchQuery\": \"Alice\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cal.com/v2/insights/routings/routed-to-per-period")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"user\",\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-31\",\n \"period\": \"perWeek\",\n \"limit\": 10,\n \"selectedTeamId\": 12,\n \"columnFilters\": [\n {\n \"id\": \"createdAt\",\n \"value\": {\n \"type\": \"dr\",\n \"data\": {\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-31\",\n \"preset\": \"custom\"\n }\n }\n }\n ],\n \"searchQuery\": \"Alice\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "users": {
      "data": [
        {
          "id": 101,
          "name": "Alice Doe",
          "email": "alice@example.com",
          "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