curl --request GET \
--url https://api.collective.work/{environment}/v1/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.collective.work/{environment}/v1/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.collective.work/{environment}/v1/analytics', 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.collective.work/{environment}/v1/analytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.collective.work/{environment}/v1/analytics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.collective.work/{environment}/v1/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collective.work/{environment}/v1/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"recruiters": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"email": "alex.morgan@example.com",
"fullName": "Alex Morgan"
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"email": "taylor.brooks@example.com",
"fullName": "Taylor Brooks"
}
],
"metadata": {
"organizationId": "organization_example",
"requestedAt": "2026-09-14T09:00:00.000Z",
"filters": {
"recruiterIds": [
"cmubqjl3y0000uzcg6dbkeltw",
"cmubqjl3y0003uzcggumce0gq"
],
"breakdown": "WEEKLY",
"range": "CUSTOM",
"from": "2026-09-07T00:00:00.000Z",
"to": "2026-09-13T23:59:59.999Z",
"sections": [
"usage",
"activity",
"engagement",
"recruiterSummary"
]
}
},
"sections": {
"usage": {
"profileViews": {
"total": 24,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 24
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 24
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"sherlockQueries": {
"total": 8,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 8
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 8
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"searchQueries": {
"total": 14,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 14
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 14
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"postedJobs": {
"total": 1,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 1
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 1
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"applications": {
"total": 4,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 4
}
]
},
"sentMessages": {
"total": 12,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 12
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 12
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"contactTracking": {
"total": 11,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 11
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 11
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
}
},
"activity": {
"sherlockQueries": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 2
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
],
"searchQueries": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 4
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
],
"postedJobs": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 1
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
],
"sentMessages": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 2
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
]
},
"engagement": {
"powerUsers": {
"count": 1,
"recruiters": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 4,
"averageActiveDaysPerWeek": 4
}
]
},
"regularUsers": {
"count": 0,
"recruiters": []
},
"casualUsers": {
"count": 1,
"recruiters": [
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0,
"averageActiveDaysPerWeek": 0
}
]
}
},
"recruiterSummary": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"sherlockQueries": 8,
"searchQueries": 14,
"postedJobs": 1,
"sentMessages": 12,
"activeDays": 4
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"sherlockQueries": 0,
"searchQueries": 0,
"postedJobs": 0,
"sentMessages": 0,
"activeDays": 0
}
]
}
}Get Analytics
Get organization usage, activity, and engagement with your organization API key. Sandbox returns fictional data; production requires production API and analytics access. See the Analytics guide to get started.
Requests that are too complex are rejected. Shorten the timeframe, or adjust the filters or breakdown as indicated by the error message.
curl --request GET \
--url https://api.collective.work/{environment}/v1/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.collective.work/{environment}/v1/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.collective.work/{environment}/v1/analytics', 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.collective.work/{environment}/v1/analytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.collective.work/{environment}/v1/analytics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.collective.work/{environment}/v1/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collective.work/{environment}/v1/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"recruiters": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"email": "alex.morgan@example.com",
"fullName": "Alex Morgan"
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"email": "taylor.brooks@example.com",
"fullName": "Taylor Brooks"
}
],
"metadata": {
"organizationId": "organization_example",
"requestedAt": "2026-09-14T09:00:00.000Z",
"filters": {
"recruiterIds": [
"cmubqjl3y0000uzcg6dbkeltw",
"cmubqjl3y0003uzcggumce0gq"
],
"breakdown": "WEEKLY",
"range": "CUSTOM",
"from": "2026-09-07T00:00:00.000Z",
"to": "2026-09-13T23:59:59.999Z",
"sections": [
"usage",
"activity",
"engagement",
"recruiterSummary"
]
}
},
"sections": {
"usage": {
"profileViews": {
"total": 24,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 24
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 24
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"sherlockQueries": {
"total": 8,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 8
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 8
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"searchQueries": {
"total": 14,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 14
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 14
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"postedJobs": {
"total": 1,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 1
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 1
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"applications": {
"total": 4,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 4
}
]
},
"sentMessages": {
"total": 12,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 12
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 12
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
},
"contactTracking": {
"total": 11,
"timeSeries": [
{
"date": "2026-09-07T00:00:00.000Z",
"total": 11
}
],
"byRecruiter": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"total": 11
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"total": 0
}
]
}
},
"activity": {
"sherlockQueries": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 2
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
],
"searchQueries": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 4
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
],
"postedJobs": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 1
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
],
"sentMessages": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 2
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0
}
]
},
"engagement": {
"powerUsers": {
"count": 1,
"recruiters": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"activeDays": 4,
"averageActiveDaysPerWeek": 4
}
]
},
"regularUsers": {
"count": 0,
"recruiters": []
},
"casualUsers": {
"count": 1,
"recruiters": [
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"activeDays": 0,
"averageActiveDaysPerWeek": 0
}
]
}
},
"recruiterSummary": [
{
"recruiterId": "cmubqjl3y0000uzcg6dbkeltw",
"sherlockQueries": 8,
"searchQueries": 14,
"postedJobs": 1,
"sentMessages": 12,
"activeDays": 4
},
{
"recruiterId": "cmubqjl3y0003uzcggumce0gq",
"sherlockQueries": 0,
"searchQueries": 0,
"postedJobs": 0,
"sentMessages": 0,
"activeDays": 0
}
]
}
}Authorizations
Your organization API key, available in Organisation settings.
Query Parameters
UTC date window. LAST_7/30_DAYS include today; THIS_MONTH/YEAR run through today; LAST_MONTH/YEAR cover the previous complete period. CUSTOM requires from and to. LAST_YEAR requires a non-daily breakdown.
LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, THIS_YEAR, LAST_YEAR, CUSTOM Response
Analytics retrieved. Example: all four sections for two sandbox recruiters over one week, including a recruiter with no activity.
Analytics for the selected recruiters and UTC date range.
Was this page helpful?

