Reports
Find what you need
Common questions and the request that answers each one, for the current week or month. Replace AC-0001 with one of your activity codes.
Hours per agent and day, for one week
One row per agent and day. The usual feed for a production or payroll tool, week by week.
GET /api/v1/reports/agent-days
?activity=AC-0001
&week=2026-W47
&fields=agent_code,date,weekday,first_start,last_end,paid_timeWeekly hours per agent, Monday to Sunday
One row per agent per week with each day's paid hours and the week's total: the layout of WIP-style production feeds.
GET /api/v1/reports/agents
?activity=AC-0001
&month=2026-11
&group_by=week
&fields=agent_code,week,monday,tuesday,wednesday,thursday,friday,saturday,sunday,paid_time
&sort=agent_code,weekMonthly totals per agent, for payroll
One row per agent per calendar month: days worked, paid hours, night hours, paid time off, gap to contract.
GET /api/v1/reports/agents
?month=2026-11
&group_by=month
&fields=activity_code,agent_code,month,days_worked,paid_time,night_time,time_off_paid,contract_gapAgents over their contract, week by week
Weekly totals filtered on contract_gap above zero, largest gap first.
GET /api/v1/reports/agents
?activity=AC-0001
&month=2026-11
&group_by=week
&fields=agent_code,week,paid_time,contract_target,contract_gap
&filter.contract_gap.gt=0
&sort=-contract_gapEvery shift with its start and end
One row per shift. A night shift belongs to the day it starts; shift_end_date says when it ends.
GET /api/v1/reports/shifts
?activity=AC-0001
&week=2026-W47
&fields=agent_code,date,shift_start,shift_end,shift_end_date,break_unpaid,paid_timeLate starts, latest first
Planned vs actualLive shifts that started after their planned time, sorted by delay. start_delta is in minutes. Needs planned vs actual access.
GET /api/v1/reports/shifts
?activity=AC-0001
&week=2026-W47
&source=live
&fields=agent_code,date,live_status,planned_start,shift_start,start_delta
&filter.start_delta.gt=0
&sort=-start_deltaTime off over a month
One row per time off, with dates, duration, paid or not, and the reason.
GET /api/v1/reports/time-off
?month=2026-11Agents with their codes, contract and supervisors
The agent directory, with agent custom fields. Names and emails only with personal details access.
GET /api/v1/agents
?activity=AC-0001What changed since your last sync
Published plannings changed after a time you give. Re-read only those weeks.
GET /api/v1/plannings
?changed_since=2026-11-19T00:00:00ZActivity and client codes
The codes the activity parameter takes, with each activity's client, timezone and client field values.
GET /api/v1/activitiesEvery column you can ask for
Each report type with its columns, plus your workspace's custom fields and their ids.
GET /api/v1/reports