Moogsoft Docs

getStats

A GET request that retrieves all available Stats API endpoints along with their description and request parameters.

Back to Stats API.

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.

Endpoint getStats takes no other arguments because it returns data on all available Stats API endpoints.

Response

Endpoint getStats returns the following response:

Examples

The following examples demonstrate typical use of endpoint getStats:

Request example

A cURL request to return all available Stats API endpoints:

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

Response example

A successful response with all of the endpoints, descriptions and associated parameters:

[
 {  
   "endpoint":"getTeamSituationStats",
   "description":"returns the number of active situations assign to a team over time",
   "display_name":"Open Situations by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getTopTeamSituationStats",
   "description":"returns the number of active situations assign to a top team over time",
   "display_name":"Open Situations by Top Team",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getServiceSituationStats",
   "description":"returns the number of active situations impacting a service over time",
   "display_name":"Open Situations by Service",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "services":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getServices",
            "value":"service_id"
         },
         "type":"mapped",
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getTopServiceSituationStats",
   "description":"returns the number of active situations impacting a top service over time",
   "display_name":"Open Situations by Top Service",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getSystemSituationStats",
   "description":"returns the number of active situations in the system over time",
   "display_name":"All Open Situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getStatusSituationStats",
   "description":"returns the number of active situations with specified status over time",
   "display_name":"Open Situations by Status",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "status":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getStatuses",
            "value":"status_id"
         },
         "type":"mapped",
         "required":false
      }
   }
},
{  
   "endpoint":"getSeveritySituationStats",
   "description":"returns the number of active situations with specified severity over time",
   "display_name":"Open Situations by Severity",
   "parameters":{  
      "severity":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getSeverities",
            "value":"severity_id"
         },
         "type":"mapped",
         "required":"false"
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getReoccurringSituationStats",
   "description":"returns the percentage of reoccurring situations in the system",
   "display_name":"Reoccurring situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getMTTAStats",
   "description":"returns the mean time to acknowledge a situation over time",
   "display_name":"Mean Time To Acknowledge",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getMTTDStats",
   "description":"returns the mean time to detect a situation over time",
   "display_name":"Mean Time To Detect",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getMTTRStats",
   "description":"returns the mean time to resolve a situation over time",
   "display_name":"Mean Time To Resolve",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getReassignedSituationStats",
   "description":"returns the number of situations that have been reassigned over time",
   "display_name":"Reassigned Situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getNewSituationsStats",
   "description":"returns the number of new situations over time",
   "display_name":"New Situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getNewAlertsStats",
   "description":"returns the number of new alerts over time",
   "display_name":"New Alerts",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getNewEventsStats",
   "description":"returns the number of new events over time",
   "display_name":"New Events",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getAlertsInNewSituationsStats",
   "description":"returns the number of alerts in new situations over time",
   "display_name":"Alerts In New Situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getNewEventsPerAlertsStats",
   "description":"returns the number of new events divided by the number of new alerts over time",
   "display_name":"Reduction From Events To Alert",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getNewAlertsPerSituationsStats",
   "description":"returns the number of new alerts divided by the number of new situations over time",
   "display_name":"Reduction From Alerts To Situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getNewEventsPerSituationsStats",
   "description":"returns the number of new events divided by the number of new situations over time",
   "display_name":"Reduction From Events To Situations",
   "parameters":{  
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Accumulate",
               "value":"accumulate"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getReassignedSituationsPerTeamStats",
   "description":"returns the number of reassigned situations of a team over time",
   "display_name":"Reassigned Situations by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getSeveritySituationPerTeamStats",
   "description":"returns the number of active situations with specified severity and team over time",
   "display_name":"Open Situations by Severity by Team",
   "parameters":{  
      "severity":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getSeverities",
            "value":"severity_id"
         },
         "type":"mapped",
         "required":"false"
      },
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getStatusSituationPerTeamStats",
   "description":"returns the number of situations with a specified status and team over time",
   "display_name":"Open Situations by Status by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "status":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getStatuses",
            "value":"status_id"
         },
         "type":"mapped",
         "required":"false"
      }
   }
},
{  
   "endpoint":"getServiceSituationPerTeamStats",
   "description":"returns the number of active situations with specified service and team over time",
   "display_name":"Open Situations by Service by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":true
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "services":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getServices",
            "va* Connection #0 to host freida7 left intact 
lue":"service_id"
         },
         "type":"mapped",
         "required":"true"
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getMTTAPerTeamStats",
   "description":"returns the mean time to acknowledge a situation of a team over time",
   "display_name":"Mean Time To Acknowledge by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getMTTRPerTeamStats",
   "description":"returns the mean time to resolve a situation of a team over time",
   "display_name":"Mean Time To Resolve by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getReoccurringSituationPerTeamStats",
   "description":"returns the percentage of reoccurring situations of a team over time",
   "display_name":"Reoccurring situations Per Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      }
   }
},
{  
   "endpoint":"getCommentCountPerTeamStats",
   "description":"returns the number of comments posted on situations by team members over time",
   "display_name":"Number of Comments by Team",
   "parameters":{  
      "teams":{  
         "mapping":{  
            "display_value":"name",
            "endpoint":"getTeams",
            "value":"team_id"
         },
         "type":"mapped",
         "required":false
      },
      "from":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
      },
      "aggregation":{  
         "default":"none",
         "type":"string",
         "static_mapping":[  
            {  
               "display_value":"None",
               "value":"none"
            },
            {  
               "display_value":"Sum",
               "value":"sum"
            }
         ],
         "required":false
      },
      "to":{  
         "description":"A timestamp from epoch in seconds",
         "type":"Long",
         "required":true
       }
     }
  }
]