./list/aggregations

Returns a list of all aggregations (statistics) that can be obtained for the data. Examples:

Total jobs per job status
Total deadlines per month
etc.

URL

Retrieve all aggregations:

(GET) ./list/aggregations

PARAMETERS

None.

RESULTS

The method returns an object with these properties:

id

A code for the aggregation. This code is used by the API method to retrieve the aggregation.

Null is the default aggregation. Each list always comes with a default.

To actually run an aggregation, use API method:

./list/aggregations/{id} (post)

string?

name

Print title of aggregation

desc

Description

object

EXAMPLES

Aggregations:

[
    {
        "id": null,
        "name": "Job counts per status",
        "desc": "Indicates total jobs per job status"
    },
    {
        "id": "deadline",
        "name": "Total deadlines per month over past one year",
        "desc": "Shows the deadlines falling on a month. Shown for the past 12 months"
    }
]

API v2

./list/aggregations

Analytics

URL

PARAMETERS

RESULTS

EXAMPLES

Related content