Reference · Report groups
List report groups
/v1/sites/{siteId}/report-groupsA site's report groups: what sales reports group products by, such as Food and Drinks. A page at a time; retired ones only with includeInactive.
Path
siteIdrequiredThe site, from GET /v1/sites.
string
Query
limitHow many records to return, at most.
integer · ≥ 1 · ≤ 200 · default 50
cursornextCursor from the previous page. Omit for the first page.
string
updatedSinceOnly records changed at or after this time (RFC 3339). For a sync, pass the time your previous sync started.
string · date-time
includeInactiveInclude retired records (active false). Off by default.
boolean
Headers
AuthorizationrequiredAn API key from Automation > Access in the Dnero portal, sent as
Authorization: Bearer <key>.string
Responses
- bad_requestinvalid_cursoridempotency_key_required
- missing_keyinvalid_keykey_expired+1 more
- key_revokedassistant_keykey_without_access+7 more
- site_not_foundnot_found
- invalid_requestnot_a_modifier_group
- rate_limited
- server_error
- upstream_unavailable
200 OK
datarequiredThe records, in a stable order.
array of objects
5 fields in each
activerequiredFalse for a retired report group.
boolean
coderequiredThe report group's code.
string
namerequiredThe report group's name.
string
orderrequiredWhere it comes in a report, lowest first.
integer
updatedAtWhen it last changed.
string · date-time
nextCursorPass as cursor to get the next page. Absent on the last page.
string