Moogsoft Docs

getSystemSummary

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

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getSystemSummary takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

There are no other arguments because this method returns data on all alerts and Situations.

Response

Endpoint getSystemSummary returns the following response:

Successful requests return a JSON object system_summary, containing the following statistics:

Name

Type

Description

total_events

Number

Total number of events in Moogsoft AIOps.

open_sitns

Number

Number of open Situations in Moogsoft AIOps.

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 AIOps.

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 AIOps:

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 AIOps:

{
    "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
    }
}