List Logs - Upstash Documentation

Authorizations

Authorization

string

header

required

QStash authentication token

Query Parameters

cursor

string

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

messageId

string

Filter logs by message ID

state

enum<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:

CREATED,

ACTIVE,

RETRY,

ERROR,

IN_PROGRESS,

DELIVERED,

CANCEL_REQUESTED,

CANCELLED

url

string

Filter logs by destination URL

topicName

string

Filter logs by URL Group name

scheduleId

string

Filter logs by schedule ID

queueName

string

Filter logs by queue name

fromDate

integer<int64>

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

toDate

integer<int64>

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

count

integer

default:100

The number of log entries to return.

Required range: x <= 100

order

enum<string>

default:latestFirst

The sorting order of logs by timestamp.

Available options:

latestFirst,

earliestFirst

label

string

Filter logs by the label of the message assigned by the user

Response

200 - application/json

List of logs

cursor

string

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.

logs

object[]

Show child attributes

logs.time

integer<int64>

The timestamp of the log entry in Unix milliseconds

logs.messageId

string

The message ID associated with the log entry

logs.header

object

The headers of the message.

Show child attributes

logs.header.{key}

string[]

logs.body

string

Base64 encoded body of the message.

logs.state

enum<string>

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

Available options:

CREATED,

ACTIVE,

RETRY,

ERROR,

DELIVERED,

FAILED,

CANCEL_REQUESTED,

CANCELLED

logs.error

string

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

logs.nextDeliveryTime

integer<int64>

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

logs.url

string

The URL to which the message is being delivered.

logs.topicName

string

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

logs.endpointName

string

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

logs.scheduleId

string

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

logs.queueName

string

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

logs.responseStatus

integer

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

logs.responseBody

string

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

logs.responseHeaders

object

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

Show child attributes

logs.responseHeaders.{key}

string[]

logs.timeout

integer

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

logs.method

string

HTTP method of the message for outgoing request

logs.callback

string

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

logs.callbackHeaders

object

The headers sent to the callback URL

Show child attributes

logs.callbackHeaders.{key}

string[]

logs.failureCallback

string

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

logs.failureCallbackHeaders

object

The headers sent to the failure callback URL

Show child attributes

logs.failureCallbackHeaders.{key}

string[]

logs.maxRetries

integer

The maximum number of retries for the message

logs.retryDelayExpression

string

The retry delay expression used for calculating retry delays

logs.label

string

The label assigned to the message