Skip to main content
GET
Get analytics

Authorizations

Authorization
string
header
required

Your organization API key, available in Organisation settings.

Query Parameters

recruiterIds
string[]

IDs from the response’s recruiters array. Omit for everyone, including inactive members. Repeat for multiple IDs: recruiterIds=id1&recruiterIds=id2. Maximum 1,000 supplied values. Sandbox accepts only its fictional IDs.

Maximum array length: 1000
Minimum string length: 1
breakdown
enum<string>
default:DAILY

Time-series grouping in UTC. Weeks start Monday; months and years start on their first day.

Available options:
DAILY,
WEEKLY,
MONTHLY,
YEARLY
range
enum<string>
default:LAST_30_DAYS

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.

Available options:
LAST_7_DAYS,
LAST_30_DAYS,
THIS_MONTH,
LAST_MONTH,
THIS_YEAR,
LAST_YEAR,
CUSTOM
from
string<date>

Inclusive UTC start date (YYYY-MM-DD). Required with CUSTOM; otherwise omit. Must be on or before to.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string<date>

Inclusive UTC end date (YYYY-MM-DD). Required with CUSTOM; otherwise omit.

Pattern: ^\d{4}-\d{2}-\d{2}$
sections
enum<string>[]

Sections to return; omit for all four. Repeat to select several: sections=usage&sections=engagement. Maximum four supplied values.

Maximum array length: 4
Available options:
usage,
activity,
engagement,
recruiterSummary

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.

recruiters
object[]
required

Match section rows to these identities. Includes inactive and former members still attached to the organization.

metadata
object
required
sections
object
required

Only requested sections are present. Allow additional section and metric keys.