Reports

Report parameters

Every /reports/{type} request takes the same parameters. A period is required; everything else is optional.

GET /api/v1/reports/{type}?activity=AC-0006&week=2026-W42
    &fields=agent_code,date,paid_time&format=csv
ParameterDescription
activityActivity codes as shown on the activity (or ids), comma-separated. Leave it out for every activity the key can read.
weekAn ISO week, Monday to Sunday, for example 2026-W42.
monthA calendar month, for example 2026-10.
fromFirst day, YYYY-MM-DD.
toLast day, included. 93 days at most from the first day.
group_byagents only. week: one row per agent per ISO week; month: one row per agent per calendar month. Leave it out for one row per agent over the period.
day_valueWith group_by=week: what the monday … sunday columns hold. One of paid_time, shift_time, productive_time, break_paid, break_unpaid, lunch_time, coffee_time, meeting_time, night_time, time_off_paid, time_off_unpaid. Default paid_time.
fieldsColumns, comma-separated, in the order you want. Custom fields use their key: cf. for agent fields (cf.matricule), ccf. for client fields (ccf.code_campagne).
filter.<field>Keep only the rows that match. Repeat for several conditions (up to 20); all must hold. See Group, filter and sort.
sortColumns to sort by, comma-separated, - in front for descending: sort=-paid_time,agent_code. Up to 5.
label.<field>Name of one column in the output, for example label.agent_code=Matricule.
sourcepublished (default) or live, planned vs actual (needs that access).
durationsdecimal (default, 7.5), hm (7:30) or minutes (450).
formatjson (default) or csv.
limitRows per page, 1 to 1000. Default 500 for JSON. A CSV without limit holds every row.
cursorThe next page: next_cursor from the previous response.

To shape the rows, and to see every column you can ask for: Group, filter and sort · Report types and columns

Report parameters — Planifizer API docs