getTopServiceSituationStats

A GET request that returns the number of active Situations impacting a top service in the specified time range. Top services are the services that have the most situations impacting them.

Back to Stats API.

Request arguments

Endpoint getTopServiceSituationStats takes the following request arguments.

Name	Type	Description
`auth_token`	String	A valid `auth_token` returned from the `authenticate` request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.
`from`	Number	Start of the reporting time range. This is a Unix epoch timestamp in seconds.
`to`	Number	End of the reporting time range. This is a Unix epoch timestamp in seconds. If this timestamp is within 10 seconds of the current system time, the last datapoint returned is the current state datapoint.
`aggregation`	String	Set to: `accumulate`: Gradually adds data points together over time. `none`: No aggregation of data points.

Response

Endpoint getTopServiceSituationStats returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Successful requests return a JSON object containing the following:

Name	Type	Description
`target`	String	The name of the service
`datapoints`	Number Array	An array of data points. Each data point is an array in the format [data point, timestamp]: Data point: Number of Situations for each status. Timestamp: Calculation time (Unix epoch timestamp in milliseconds). Less than 1 week: Returns the number of Situations each hour in the time period. 1 week to 1 month: Returns the number of Situations each day in the time period. 1 month to 1 year: Returns the number of Situations each week in the time period. More than 1 year: Returns the number of Situations each month in the time period.

Examples

The following examples demonstrate typical use of endpoint getTopServiceSituationStats:

Request example

A cURL request to retrieve the number of Situations impacting top services between 12pm and midnight on Saturday, 15th September 2018:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getServiceSituationStats" --data-urlencode 'from=1537012800' --data-urlencode 'to=1536969600' --data-urlencode 'aggregation=sum'

Response example

A successful response returns the number of Situations each hour for the 12 hour range:

[{
        "datapoints": [
                [10.0, 1538133600000],
                [12.0, 1538133600000],
                [8.0, 1538133600000],
                [5.0, 1538133600000],
                [9.0, 1538133600000],
                [6.0, 1538133600000],
                [10.0, 1538133600000],
                [13.0, 1538133600000],
                [11.0, 1538133600000],
                [7.0, 1538133600000],
                [9.0, 1538133600000],
                [1.0, 1538133600000]
        ],
        "target": "Web Service"
}, {
        "datapoints": [
                [7.0, 1538133600000],
                [3.0, 1538133600000],
                [6.0, 1538133600000],
                [14.0, 1538133600000],
                [9.0, 1538133600000],
                [8.0, 1538133600000],
                [12.0, 1538133600000],
                [11.0, 1538133600000],
                [8.0, 1538133600000],
                [4.0, 1538133600000],
                [6.0, 1538133600000],
                [3.0, 1538133600000]],
        "target": "Cloud Service"
}]

In this section: