getNewEventsPerSituationsStats

A GET request that returns the percentage of noise reduction from events-to-Situations aggregation, deduplication, and clustering in the specified time range.

Back to Stats API.

Request arguments

Endpoint getNewEventsPerSituationsStats 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.

Response

Endpoint getNewEventsPerSituationsStats 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	"New Events per Situation"
`datapoints`	Number Array	An array of data points. Each data point is an array in the format [data point, timestamp]: Data point: Percentage noise reduction (event to Situation reduction). Timestamp: Calculation time (Unix epoch timestamp in milliseconds). [Delete all except the appropriate Time Period box or complete the custom list if not supplied. Delete this para!] Less than 1 week: Returns the percentage noise reduction each hour in the time period. 1 week to 1 month: Returns the percentage noise reduction each day in the time period. 1 month to 1 year: Returns the percentage noise reduction each week in the time period. More than 1 year: Returns the percentage noise reduction each month in the time period.

Name

Type

Description

target

String

"New Events per Situation"

datapoints

Number Array

An array of data points. Each data point is an array in the format [data point, timestamp]:

Data point: Percentage noise reduction (event to Situation reduction).
Timestamp: Calculation time (Unix epoch timestamp in milliseconds).

[Delete all except the appropriate Time Period box or complete the custom list if not supplied. Delete this para!]

Examples

The following examples demonstrate typical use of endpoint getNewEventsPerSituationsStats:

Request example

A cURL request that retrieves the percentage noise reduction for the past month ranging from 10.28am on Sunday, August 26th until 10.28am on Wednesday, September 26th 2018:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getNewEventsPerSituationsStats" --data-urlencode 'from=1533103200' --data-urlencode 'to=1535695200'

Response example

A successful responses returns an 95% to 96% reduction in events to Situations for each week over the past month:

[
        {
        "datapoints":[
                [95.86151338591529,1535279280000],
                [95.79150698161867,1535884080000],
                [95.62050414072417,1536488880000],
                [96.08938014241262,1537093680000],
                [95.96508799542137,1537698480000]
        ],
        "target":"New Events per Situation"
        }
]

In this section: