Getting graph data of a mitigation¶

Note

SOC accounts cannot call this endpoint with a personal access token. There is no organisation-related token equivalent for it. Instead, use the access options via the web application (session authentication).

Sends a GET request to the endpoint /mitigations/{mitigation}/data/{dataType}/{field}.

Description¶

The Get-Mitigation-Data request returns the graph data for a specific mitigation, filtered by data type and field.

Requirements¶

Values of the request: Mitigation ID {mitigation}; Data type {dataType}; Field {field}

Objects: none

Request¶

To request the graph data of a mitigation, add the Mitigation ID {mitigation}, the Data type {dataType}, and the Field {field} to the path of the request.

Data type {dataType} defines the type of data to retrieve, for example bandwidth or protocol.

Field {field} defines the field to retrieve, for example bits or packets.

As a result, the user gets an array of series for a graphical visualisation.

The object provides the following information:

Attributes	Description	Values
`name`	The name of the series.	`string`
`data`	The array of data points of the series. Each point provides the attributes `x` and `y`.	`array`

Example¶

Example response:

[
  {
    "data": [
      {
        "x": 0,
        "y": 0
      }
    ],
    "name": "string"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.