List Logs - Upstash Documentation

GET/v2/logs

cURL

curl --request GET \
  --url https://qstash-{region}.upstash.io/v2/logs \
  --header 'Authorization: Bearer <token>'

200Response

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

Authorization

Authorizationheaderstringrequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cursorquerystring

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

messageIdquerystring

Filter logs by message ID

statequeryenum<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.

Available options:CREATEDACTIVERETRYERRORIN_PROGRESSDELIVEREDCANCEL_REQUESTEDCANCELLED

urlquerystring

Filter logs by destination URL

topicNamequerystring

Filter logs by URL Group name

scheduleIdquerystring

Filter logs by schedule ID

queueNamequerystring

Filter logs by queue name

fromDatequeryinteger

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

toDatequeryinteger

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

countqueryintegerdefault: 100

The number of log entries to return.

labelquerystring[]

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

Response

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[]

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.

bodystring

Base64 encoded body of the message.

stateenum<string>

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

Available 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

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

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

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.