getServiceSituationStats

A GET request that returns the number of active Situations impacting a service in the specified time range.

Request arguments

Endpoint getServiceSituationStats 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.
`services`	Array	An array of services IDs. If no services are provided, the endpoint does not return any data.
`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 getServiceSituationStats 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	Service name(s).
`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 impacting services. 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 getServiceSituationStats :

Request example

A cURL request to retrieve the number of Situations impacting the Commerce/Compute service between 12pm and 6pm on Friday, August 10th 2018:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getServiceSituationStats" --data-urlencode 'services=[1,2]' --data-urlencode 'from=1533902400' --data-urlencode 'to=1533924000' --data-urlencode 'aggregation=sum'

Response example

A successful response returns six data points for each hour during the six hour time range:

[{
        "datapoints": [
                [95.0,1533902400000],
                [85.0,1533906000000],
                [47.0,1533909600000],
                [7.0,1533913200000],
                [33.0,1533916800000],
                [66.0,1533920400000]
        ],
        "target":"Commerce/Compute"
}]

In this section: