Retrieve dead-letter queue size by time interval

Use this API to retrieve the number of messages in the dead-letter queue for each time interval within a specified time range. The response returns aggregated queue size values grouped by subscription topic and timestamp.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request for retrieving dead-letter queue size metrics.

POST /statistics-reporting/{tenantId}/API/queueMetrics/deadLetterQueueSize

Replace {tenantId} with the ID of the target tenant.

Request headers

The following request headers must be included.


Header	Value	Required
`Content-Type`	`application/json`	Yes
`Authorization`	`Bearer {access_token}`	Yes

Request body

The following table describes the request body parameters, including accepted values and defaults.


Parameter	Type	Required	Description	Accepted values / Default
`from` ⁽¹⁾	Long	Yes	Start time in epoch milliseconds	—
`to` ⁽¹⁾	Long	Yes	End time in epoch milliseconds	—
`env`	String	Yes	Target environment	Example: `prod`, `qa`, `dev`. Default: none
`resolution`	Integer	Yes	Time resolution in milliseconds for aggregating data	—
`subscriptionPattern`	String	Yes	Regex pattern to filter queues	Default: `*`
Note: The time range defined by the `from` and `to` values must not exceed one month. If the specified range exceeds the allowed limit, the API returns an HTTP `416 Range Not Satisfiable` error with the following response: `{ "errors": [ { "message": "Invalid time range." } ] }`

Example request

Use the following example to see how a complete request is structured with headers and a JSON body.

curl -X POST https://{baseUrl}/statistics-reporting/{tenantId}/API/queueMetrics/deadLetterQueueSize \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": 1760770800000,
    "to": 1760771400000,
    "env": "prod",
    "resolution": 60000,
    "subscriptionPattern": ".*crud.*"
  }'

Response fields

The following table describes the fields returned in the response body.


Field	Subfield	Type	Description
`timestamp`		Long	Numeric value representing the start time of the interval in milliseconds
`values`		Array	Array containing one or more name-value pairs
—	`name`	String	Identifier for the destination or topic
—	`value`	Integer	The dead-letter queue size during that time interval

Example response

The following example shows the size of the dead-letter queue over two time intervals.

[
  {
    "timestamp": 1760770800000,
    "values": [
      {
        "name": "API_na07_prod_crud-events_6ZS1234567ef8b97",
        "value": 136421
      }
    ]
  },
  {
    "timestamp": 1760770920000,
    "values": [
      {
        "name": "API_na07_prod_crud-events_6ZS1234567ef8b97",
        "value": 97380
      }
    ]
  }
]

Unify and manage your data