platform
metrics-api

Receive aggregated data result

Receive data response, requested by Query aggregate traffic data. This callback will be invoked only once with POST method.

postWebhookreceive-aggregate-data-result

Payload

requestIdstring required

The identifier of original request returned by Query aggregated traffic data endpoint.

status'SUCCESS' | 'FAILED' required

Status of the request. If successful, the response will contain aggregated data. If failed, it will contain failure message.

failureMessagestring

The message describing the failure. This field is present only if the request failed.

Example payload

{
  "response": {
    "requestedPeriod": {
      "sentSince": "2023-04-01T00:00:00Z",
      "sentUntil": "2023-04-01T00:00:00Z"
    }
  }
}

Response

Your server returns this code if it accepts the callback.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.