UPupstash
Logs

List Logs

Changed on

Paginate through logs of published messages

get/v2/logs

Request

Query parameters

cursorstring

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

messageIdstring

Filter logs by message ID

state'CREATED' | 'ACTIVE' | 'RETRY' | 'ERROR' | 'IN_PROGRESS' | 'DELIVERED' | 'CANCEL_REQUESTED' | 'CANCELLED'

Filter logs by message state

ValueDescription
CREATEDThe message has been accepted and stored in QStash
ACTIVEThe task is currently being processed by a worker.
RETRYThe task has been scheduled to retry.
ERRORThe execution threw an error and the task is waiting to be retried or failed.
IN_PROGRESSThe task is in one of ACTIVE, RETRY or ERROR state.
DELIVEREDThe message was successfully delivered.
FAILEDThe task has errored too many times or encountered an error that it cannot recover from.
CANCEL_REQUESTEDThe cancel request from the user is recorded.
CANCELLEDThe cancel request from the user is honored.
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.

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

Response

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.

Changes

  • d30bd0904328Revision changes
    • info

      for the query request parameter label, the type was generalized from string to array

    • info

      added the optional property // to the response with the status

    • info

      response property logs/items/label deprecated

  • d859c277ced2Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      for the query request parameter label, the type was generalized from array to string

    • info

      response property logs/items/label reactivated