Upstash Documentation

Get QStash Stats

Retrieves detailed usage statistics for the QStash account including
daily requests, billing, bandwidth, and workflow metrics over time.

1 min read
get/qstash/stats/{id}
Request example
Response
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