ReportsReport types and columns
Totals per agent
One row per agent for the period: days worked, hours, gap to contract.
GET /api/v1/reports/agents?activity=AC-0001&week=2026-W4764 columns
Ask for columns with fields, in the order you want. Without fields you get the ones marked Default.
activity_codeActivity codeDefaultagent_idAgent IDDefaultagent_codeAgent codeDefaultcontract_idContract IDDefaultcontract_typeContractDefaultdays_workedDays workedDefaultshift_timeScheduled timeDefaultSum of shift lengths, breaks included
paid_timePaid timeDefaultShift time minus unpaid breaks, plus paid time off
contract_gapGap to contractDefaultPaid time minus contract hours due
agent_nameAgentPersonalagent_emailEmailPersonalagent_phonePhonePersonalagent_countryCountryagent_statusAgent statusagent_timezoneAgent timezonesupervisorsSupervisorsPersonalThe team in force on the row's day, or during its week or period
contract_weeklyContract hours / weekcontract_startContract startcontract_endContract endcontract_max_dailyMax hours / daycontract_max_daysMax days / weekcontract_vacation_daysVacation days / yearfirst_dayFirst day workedlast_dayLast day workedshift_countShiftsweekend_daysWeekend days workedavg_shiftAverage shiftbreak_countBreaksbreak_paidPaid breaksbreak_unpaidUnpaid breakslunch_timeLunch timecoffee_timeCoffee breaksproductive_timeProductive timeShift time minus all breaks and meetings
meeting_timeMeetingsnight_timeNight hours (9pm–6am)Part of the shifts between 9pm and 6am
time_off_paidPaid time offtime_off_unpaidUnpaid time offcontract_targetContract hours dueWeekly contract hours, prorated to the period
late_countLate startsLive onlylate_minutesTime lateLive onlyTotal of late starts
missed_shiftsMissed shiftsLive onlyclient_nameClientactivity_nameActivityplanning_titlePlanningThe plannings the row's shifts come from
planning_labelPlanning labelClient - Activity - S43 - 2026, the same for every activity, for rows inside one week
sourceSourcecontract_type_idContract type IDclient_codeClient codeclient_idClient IDactivity_idActivity IDplanning_idPlanning IDsupervisor_idsSupervisor IDsIDs of the same supervisors, as in the Supervision page address
Columns for grouped rows
/reports/agents normally gives one row per agent for the whole period. With group_by=week you get one row per agent per ISO week (Monday to Sunday); with group_by=month, one row per agent per calendar month. This is the layout of weekly production feeds such as WIP.
weekWeekgroup_by=weekISO week of the row, such as 2026-W42
week_numberWeek numbergroup_by=weekISO week number of the row, such as 42
monthMonthgroup_by=monthMonth of the row, such as 2026-10
period_startPeriod startgroup_by=week · group_by=monthFirst day the row covers (cut to the requested period)
period_endPeriod endgroup_by=week · group_by=monthLast day the row covers (cut to the requested period)
mondayMondaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
tuesdayTuesdaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
wednesdayWednesdaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
thursdayThursdaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
fridayFridaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
saturdaySaturdaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
sundaySundaygroup_by=weekThe day's value (day_value, paid time by default); empty outside the period
Custom fields
Your workspace's custom fields are columns too: cf.<key> for agent fields and ccf.<key> for client fields. Numbers come without units. GET /reports lists them with their ids.