Listing mitigation statistics for a month¶

Note

This request is only available to super admin users.

Sends a GET request to the endpoint /mitigation-statistic-group/{group}.

Description¶

The Get-Mitigation-Statistics request returns the mitigation statistics for a specified month of the organisation.

Requirements¶

Values of the request: Month {group}

Objects: none

Request¶

To request the mitigation statistics, add the Month {group} (in the format YYYY-MM) to the path of the request.

As a result, the user gets one or more objects MitigationStatisticVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`org`	The name of the organisation.	`string`
`network`	The IP address or the CIDR of the mitigated network.	`string`
`start`	The date and time of the start of the mitigation, in ISO 8601 format.	`string($date-time)`
`end`	The date and time of the end of the mitigation, in ISO 8601 format.	`string($date-time)`
`trigger_type`	The trigger type of the mitigation.	`MANUAL_TRIGGER` `AUTOMATIC_TRIGGER` `OPERATIONS_TRIGGER` `UNKNOWN_TRIGGER`
`actual_bw`	The measured bandwidth in Mbps at the start of the mitigation.	`integer`
`configured_bw`	The configured bandwidth threshold in Mbps.	`integer`
`actual_pps`	The measured packets per second at the start of the mitigation.	`integer`
`configured_pps`	The configured packet rate threshold.	`integer`
`peak_bw`	The peak bandwidth observed during the mitigation, in Mbps.	`integer`
`peak_pps`	The peak packet rate observed during the mitigation.	`integer`
`total_bw`	The total bandwidth received during the mitigation, in bits.	`integer`
`total_pps`	The total packets received during the mitigation.	`integer`
`dropped_bits`	The total bits dropped by the mitigation.	`integer`
`dropped_packets`	The total packets dropped by the mitigation.	`integer`

Example¶

Example response:

{
  "data": [
    {
      "org": "Test Organisation",
      "network": "172.0.0.1",
      "start": "2026-01-01T00:00:00+00:00",
      "end": "2026-01-01T00:00:00+00:00",
      "trigger_type": "MANUAL_TRIGGER",
      "actual_bw": 100,
      "configured_bw": 200,
      "actual_pps": 1500,
      "configured_pps": 2000,
      "peak_bw": 400,
      "peak_pps": 3000,
      "total_bw": 123456,
      "total_pps": 78910,
      "dropped_bits": 10000,
      "dropped_packets": 2000
    }
  ],
  "links": {
    "first": "https://datahub-api.com/api/networks?page=1",
    "last": "https://datahub-api.com/api/networks?page=5",
    "prev": null,
    "next": "https://datahub-api.com/api/networks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "https://datahub-api.com/api/networks?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://datahub-api.com/api/networks",
    "per_page": 15,
    "to": 15,
    "total": 64
  }
}

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.