Versions Compared

Old Version 3

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version Current

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

id

The aggregation to retrieve.Use ./list/aggregations to get a list of all available aggregations with their ids.

If not specified, the system uses the first aggregation in the list abovedefault aggregation. This always is the aggregation with ID "default".

string, Optional

 

The other parameters are included as a JSON object in the request body:

...

totalTotal number of aggregated data rows.int
groupsThe results. The structure may depend on the aggregation but, in general, you will findbuckets

A list of buckets. A bucket is the aggregated value, the total count of records with the value and descriptive information:

  • One row per aggregation bucket (e.g. a status or a month)
  • The value of the bucket (a status code, a date)
  • The count which is the total of records in the bucket
  • The title of the bucket
  • The css class. Can be used in front end settings.
  • The query clause if you need to query the records matching the bucket value ("drill down").
int
propertiesThe details of the selected aggregation. Also see ./list/aggregationsarray<object>

...

An aggregation by job status:

Code Block
{
    "total": 464120,
    "groupsbuckets": [
        {
            "value": 0,
            "title": "Draft",
            "countcss": 360
        },
        {
            "value": 3"status draft",
            "titlequery": "Proposal{status}.Matches(0)",
            "count": 25119
        },
        {
            "value": 52,
            "title": "In progressInactive",
            "countcss": 30
        },
        {
            "value": 6"status inactive",
            "titlequery": "Completed{status}.Matches(2)",
            "count": 491
        }
    ],
    "properties": {
        "id": null"bystatus",
        "name": "Job counts per status",
        "desc": "Indicates total jobs per job status."
    }
}