List Logs

Paginate through logs of published messages

1 min read

get/v2/logs

Request example

curl --request GET \
  --url https://qstash-eu-central-1.upstash.io/v2/logs?cursor=%3Cstring%3E&messageId=%3Cstring%3E&state=CREATED&url=%3Cstring%3E&topicName=%3Cstring%3E&scheduleId=%3Cstring%3E&queueName=%3Cstring%3E&fromDate=1&toDate=1&count=100&label=%3Cstring%3E \
  --header 'Authorization: Bearer <token>'

Response

{
  "cursor": "<string>",
  "logs": [
    {
      "time": 1,
      "messageId": "<string>",
      "header": {},
      "body": "<string>",
      "state": "CREATED",
      "error": "<string>",
      "nextDeliveryTime": 1,
      "url": "<string>",
      "topicName": "<string>",
      "endpointName": "<string>",
      "scheduleId": "<string>",
      "queueName": "<string>",
      "responseStatus": 1,
      "responseBody": "<string>",
      "responseHeaders": {},
      "timeout": 1,
      "method": "<string>",
      "callback": "<string>",
      "callbackHeaders": {},
      "failureCallback": "<string>",
      "failureCallbackHeaders": {},
      "maxRetries": 1,
      "retryDelayExpression": "<string>",
      "label": "<string>",
      "labels": [
        "<string>"
      ]
    }
  ]
}

get/v2/logs

Authorization

Authorizationstringheaderrequired#

QStash authentication token

1 alternative authorization method available — see the spec for details.

Query parameters

cursorstring#

By providing a cursor you can paginate through all of the logs

messageIdstring#

Filter logs by message ID

stateenum<string>#

Filter logs by message state

Value	Description
CREATED	The message has been accepted and stored in QStash
ACTIVE	The task is currently being processed by a worker.
RETRY	The task has been scheduled to retry.
ERROR	The execution threw an error and the task is waiting to be retried or failed.
IN_PROGRESS	The task is in one of ACTIVE, RETRY or ERROR state.
DELIVERED	The message was successfully delivered.
FAILED	The task has errored too many times or encountered an error that it cannot recover from.
CANCEL_REQUESTED	The cancel request from the user is recorded.
CANCELLED	The cancel request from the user is honored.

Options:CREATEDACTIVERETRYERRORIN_PROGRESSDELIVEREDCANCEL_REQUESTEDCANCELLED

urlstring#

Filter logs by destination URL

topicNamestring#

Filter logs by URL Group name

scheduleIdstring#

Filter logs by schedule ID

queueNamestring#

Filter logs by queue name

fromDateinteger#

Filter logs by starting date, in milliseconds (Unix timestamp). This is inclusive.

toDateinteger#

Filter logs by ending date, in milliseconds (Unix timestamp). This is inclusive.

countinteger#

The number of log entries to return.

Default: 100

Range: <= 100

labelstring[]#

Filter logs by label. Supports multi-value filtering. You can pass multiple values to match messages with any of the given labels (OR logic).

Examples:

label=my_label
label=label_1&label=label_2

Responses

application/json

200

List of logs

cursorstring#

A cursor which you can use in subsequent requests to paginate through all logs.
If no cursor is returned, you have reached the end of the logs.

logsobject[]#

Show child attributes

timeinteger#

The timestamp of the log entry in Unix milliseconds

messageIdstring#

The message ID associated with the log entry

headerobject#

The headers of the message.

Show child attributes

{key}string[]#

bodystring#

Base64 encoded body of the message.

stateenum<string>#

The state of the message at the time of the log entry.

Options:CREATEDACTIVERETRYERRORDELIVEREDFAILEDCANCEL_REQUESTEDCANCELLED

errorstring#

The error message if the log entry corresponds to an error state.

nextDeliveryTimeinteger#

The next scheduled time of the message. (Unix timestamp in milliseconds)

urlstring#

The URL to which the message is being delivered.

topicNamestring#

The URL Group (a.k.a. topic) name if this message was sent to a URL Group.

endpointNamestring#

The endpoint name of the message if the endpoint is given a name within the URL group.

scheduleIdstring#

The scheduleId of the message if the message is triggered by a schedule

queueNamestring#

The name of the queue if the message is enqueued to a queue.

responseStatusinteger#

The status code of the response. Only set if the state is ERROR

responseBodystring#

The base64 encoded body of the response. Only set if the state is ERROR

responseHeadersobject#

The headers of the response. Only set if the state is ERROR

Show child attributes

{key}string[]#

timeoutinteger#

The timeout(in milliseconds) of the outgoing http requests, after which Qstash cancels the request

methodstring#

HTTP method of the message for outgoing request

callbackstring#

Callback is the URL address where QStash sends the response of a publish

callbackHeadersobject#

The headers sent to the callback URL

Show child attributes

{key}string[]#

failureCallbackstring#

Failur eCallback is the URL address where QStash sends the response of a failed message after all retries are exhausted

failureCallbackHeadersobject#

The headers sent to the failure callback URL

Show child attributes

{key}string[]#

maxRetriesinteger#

The maximum number of retries for the message

retryDelayExpressionstring#

The retry delay expression used for calculating retry delays

labelstringdeprecated#

The label assigned to the message. Deprecated in favor of labels.

labelsstring[]#

The list of labels assigned to the message.

Rotate Signing Keys Overview