Get QStash Stats - Upstash Documentation

get/qstash/stats/{id}

Request example

curl --request GET \
  --url https://api.upstash.com/v2/qstash/stats/{id}?period=3h \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/qstash/stats/{id}?period=3h"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.upstash.com/v2/qstash/stats/{id}?period=3h', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);

Response

{
  "days": [
    "Wednesday",
    "Thursday",
    "Friday",
    "Saturday",
    "Sunday",
    "Monday",
    "Tuesday"
  ],
  "daily_requests": [
    {
      "x": "2025-10-01 11:33:05.585757103 +0000 UTC",
      "y": 0,
      "workflow_message": 0,
      "workflow_run": 0
    }
  ],
  "daily_billings": [
    {
      "x": "2025-10-01 11:33:05.585757103 +0000 UTC",
      "y": 0
    }
  ],
  "daily_bandwidths": [
    {
      "x": "2025-10-01 11:33:05.585757103 +0000 UTC",
      "y": 0
    }
  ],
  "daily_used": [
    {
      "x": "2025-10-01 11:33:05.585757103 +0000 UTC",
      "y": 0
    }
  ],
  "daily_used_workflow": [
    {
      "x": "2025-10-01 11:33:05.585757103 +0000 UTC",
      "y": 0
    }
  ],
  "daily_qstash_messages": [
    {
      "id": "delivered",
      "data_points": [
        {
          "x": "2023-05-22 10:59:23.426 +0000 UTC",
          "y": 320
        },
        {
          "x": "2023-05-22 11:00:23.426 +0000 UTC",
          "y": 450
        }
      ]
    }
  ],
  "daily_workflow_messages": [
    {
      "id": "canceled",
      "data_points": [
        {
          "x": "2023-05-22 10:59:23.426 +0000 UTC",
          "y": 320
        },
        {
          "x": "2023-05-22 11:00:23.426 +0000 UTC",
          "y": 450
        }
      ]
    }
  ],
  "dlq_message_count": 0,
  "daily_bandwidth_used": [
    {
      "x": "2025-10-01 11:33:05.585757103 +0000 UTC",
      "y": 0
    }
  ],
  "total_monthly_billing": 5.806
}

get/qstash/stats/{id}

Authorization

Authorizationstringheaderrequired#

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded username:password.

Path parameters

idstringrequired#

QStash user ID

Query parameters

periodenum<string>#

Time period for statistics aggregation. Each period returns 60 datapoints
with intervals adjusted to the period length.

Exceptionally for 30 days, it returns 240 datapoints with 3-hour intervals for increased granularity.

Default: "1h"

Options:1h3h12h1d3d7d30d

Responses

application/json

200

Successful response with usage statistics

daysstring[]#

Array of day names for the measurement period, typically representing all days in the current month.
This includes both past and future dates within the current month, so the array covers the entire month regardless of the current day.
Future days are included to align with other daily metrics arrays, allowing for consistent indexing.

daily_requestsobject[]#

Daily request metrics including workflow breakdowns

Show child attributes

xstring#

Timestamp in UTC format

ynumber#

Total request count for this day

workflow_messageinteger#

Number of workflow messages for this day

workflow_runinteger#

Number of workflow runs for this day

daily_billingsobject[]#

Daily billing amounts over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

daily_bandwidthsobject[]#

Daily bandwidth usage over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

daily_usedobject[]#

Request counts for the requested time period
If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

daily_used_workflowobject[]#

Workflow usage metrics for the requested time period
If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

daily_qstash_messagesobject[]#

QStash message counts broken down by metric identifier for the requested time period.
If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Show child attributes

idstring#

Identifier for the time series data

data_pointsobject[]#

Data points for the time series

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

daily_workflow_messagesobject[]#

Workflow metrics broken down by metric identifier for the requested time period.
If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Show child attributes

idstring#

Identifier for the time series data

data_pointsobject[]#

Data points for the time series

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

dlq_message_countinteger#

Current number of messages in the dead letter queue

daily_bandwidth_usedobject[]#

Bandwidth usage for the requested time period
If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Show child attributes

xstringrequired#

Timestamp when measurement was taken

ynumberrequired#

The measured value

total_monthly_billingnumber#

Total billing amount for the current month

Get QStash Get QStash IPv4 Addresses