Skip to content
Developers
Pilot. The API is open to a small number of organisations and may change — every change is in the changelog.

Reference · Report groups

Create a report group

POST/v1/sites/{siteId}/report-groups

Adds a report group to a site. The response is the report group, with the code to use from then on.

Needs Catalogue: writeChanges live data

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

Headers

  • Authorizationrequired

    An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

    string

  • Idempotency-Key

    A value you choose, unique to what this request creates: a UUID, or your own id for it. Sending it again with the same body returns the first response and creates nothing more. Required.

    string · at most 255 characters

Body

  • namerequired

    Its name.

    string · 1–200 characters

  • active

    False to create it retired. Defaults to true.

    boolean

Responses

201 Created

  • activerequired

    False for a retired report group.

    boolean

  • coderequired

    The report group's code.

    string

  • namerequired

    The report group's name.

    string

  • orderrequired

    Where it comes in a report, lowest first.

    integer

  • updatedAt

    When it last changed.

    string · date-time