Aggregates

Grouped totals over any module that supports aggregation.

Every path on this page is plugin-scoped: {pluginInstalledId} is the id of the module instance you are talking to, from Plugins. A deployment can run more than one instance of the same module, and the id is what tells them apart.

11 endpoints. Every one needs Authorization: Bearer <access token>; see Getting Started.

Permissions

The server authorises every call against the signed-in user's permission keys — the same keys the client is held to. An aggregate is authorised as the module it reads: a grouped total over point-of-sale data needs the point-of-sale keys, and one over casino data needs the casino keys. See the Permission Keys reference.

Aggregate get fields

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-get-fields`	Aggregate get fields

Aggregate get numeric fields

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-get-numeric-fields`	Aggregate get numeric fields

Aggregate grouping get fields

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-grouping-get-fields`	Aggregate grouping get fields

Aggregate grouping get fields2

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-grouping-get-fields2`	Aggregate grouping get fields2

Aggregate grouping submit query

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-grouping-submit-query`	Aggregate grouping submit query

Aggregate grouping summary query

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-grouping-summary-query`	Aggregate grouping summary query

Aggregate numeric segments submit query

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-numeric-segments-submit-query`	Gets all possible numeric aggregated values for the requested aggregate fields, broken up by number of seconds.

Aggregate numeric submit query

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-numeric-submit-query`	Gets all possible numeric aggregated values for the requested aggregate fields

Aggregate report

Method	Path	What it does
`POST`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-report`	Aggregate report

`POST` `portal-aggregate/plugins/{pluginInstalledId}/aggregate-report`

Aggregate report.

Payload

Request body

{
  "queryType": "string",
  "entities": [
    "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  ],
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockMinuteResolution": 42,
  "iterations": 42
}

Response

{
  "whereParameters": [
    "string"
  ],
  "options": [
    "string"
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockResolution": 42,
  "iterations": 42,
  "aggregateReportGroupItems": [
    {
      "startingTime": "2026-10-02T21:14:05Z",
      "endingTime": "2026-10-02T21:14:05Z",
      "iteration": 42,
      "entities": [
        {}
      ]
    }
  ],
  "processingTime": 42,
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ]
}

Aggregate report2

Method	Path	What it does
`POST`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-report2`	Aggregate report2

`POST` `portal-aggregate/plugins/{pluginInstalledId}/aggregate-report2`

Aggregate report2.

Payload

Request body

{
  "queryType": "string",
  "entities": [
    "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  ],
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockMinuteResolution": 42,
  "iterations": 42,
  "whereParams": [
    "string"
  ],
  "options": [
    "string"
  ]
}

Response

{
  "whereParameters": [
    "string"
  ],
  "options": [
    "string"
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockResolution": 42,
  "iterations": 42,
  "aggregateReportGroupItems": [
    {
      "startingTime": "2026-10-02T21:14:05Z",
      "endingTime": "2026-10-02T21:14:05Z",
      "iteration": 42,
      "entities": [
        {}
      ]
    }
  ],
  "processingTime": 42,
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ]
}

Aggregate submit query

Method	Path	What it does
`GET`	`portal-aggregate/plugins/{pluginInstalledId}/aggregate-submit-query`	Aggregate submit query

Aggregate get fields​

Aggregate get numeric fields​

Aggregate grouping get fields​

Aggregate grouping get fields2​

Aggregate grouping submit query​

Aggregate grouping summary query​

Aggregate numeric segments submit query​

Aggregate numeric submit query​

Aggregate report​

POST portal-aggregate/plugins/{pluginInstalledId}/aggregate-report​

Aggregate report2​

POST portal-aggregate/plugins/{pluginInstalledId}/aggregate-report2​

Aggregate submit query​