getSystemSummary

A Graze API GET request that returns a summary of current alerts and Situations in Moogsoft Enterprise.

Request arguments

Endpoint getSystemSummary takes the following request argument:

Name	Type	Required	Description
`auth_token`	String	Yes	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.

Endpoint getSystemSummary takes no other arguments because this endpoint returns data on all alerts and Situations.

Response

Endpoint getSystemSummary 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 system_summary, containing the following statistics:

Name	Type	Description
`total_events`	Number	Total number of events in Moogsoft Enterprise.
`open_sitns`	Number	Number of open Situations in Moogsoft Enterprise.
`open_sitns_up`	Number	Number of open Situations that are trending up.
`open_sitns_down`	Number	Number of open Situations that are trending down.
`avg_events_per_sitn`	Number	Average number of events per Situation.
`avg_alerts_per_sitn`	Number	Average number of events per Situation.
`service_count`	Number	Number of services in Moogsoft Enterprise.
`open_sigs_unassigned`	Number	Number of unassigned Situations.

Examples

The following examples demonstrate typical use of endpoint getSystemSummary:

Request example

Example cURL request to return a summary of alerts and Situations in Moogsoft Enterprise:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSystemSummary"

Response example

Example response returning a summary of alerts and Situations in Moogsoft Enterprise:

{
    "system_summary":
    {
        "total_events":61676,
        "open_sitns":571,
        "avg_events_per_sitn":305,
        "open_sitns_up":565,
        "open_sitns_down":2,
        "avg_alerts_per_sitn":16,
        "open_sigs_unassigned":310,
        "timestamp":1499425056
    }
}