getMTTAPerUserStats

A GET request that returns the mean time it takes a user to acknowledge a Situation within a given time range.

Request arguments

Endpoint getMTTAPerUserStats 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.
`users`	Array	An array of user IDs. If no users 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 getMTTAPerUserStats 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	"Mean Time to Acknowledge (MTTA) (full name)"
`datapoints`	Number Array	An array of data points. Each data point is an array in the format [data point, timestamp]: Data point:MTTA (seconds) for that bucket. Timestamp: Calculation time (Unix epoch timestamp in milliseconds). Less than 1 week: Returns the number of MTTA each hour in the time period. 1 week to 1 month: Returns the number of MTTA each day in the time period. 1 month to 1 year: Returns the number of MTTA each week in the time period. More than 1 year: Returns the number of MTTA each month in the time period.

Examples

The following examples demonstrate typical use of endpoint getMTTAPerUserStats:

Request example

A cURL request for the MTTA for user 5 from 6.34am until 2.35pm on Tuesday, 25th September 2018:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getMTTAPerUserStats" --data-urlencode 'users=[5]' --data-urlencode 'from=1537857295' --data-urlencode 'to=1537886111' --data-urlencode 'aggregation=none'

Response example

A successful response returns the MTTA each hour for the user Robert:

[{
        "datapoints": [
                [221,1537857295000],
                [960,1537860895000], 
                [901,1537864495000], 
                [1196,1537868095000], 
                [671,1537871695000], 
                [1241,1537875295000], 
                [556,1537878895000]
        ],
        "target": "Mean Time to Acknowledge (MTTA)(Robert Richards)"
}]

In this section: