Skip to main content
GET
Get QStash Stats

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

QStash user ID

Query Parameters

period
enum<string>
default:1h

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.

Available options:
1h,
3h,
12h,
1d,
3d,
7d,
30d

Response

200 - application/json

Successful response with usage statistics

days
string[]

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.

Example:
daily_requests
object[]

Daily request metrics including workflow breakdowns

Example:
daily_billings
object[]

Daily billing amounts over time

Example:
daily_bandwidths
object[]

Daily bandwidth usage over time

Example:
daily_used
object[]

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.

Example:
daily_used_workflow
object[]

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.

Example:
daily_qstash_messages
object[]

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.

Example:
daily_workflow_messages
object[]

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.

Example:
dlq_message_count
integer

Current number of messages in the dead letter queue

Example:

0

daily_bandwidth_used
object[]

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.

Example:
total_monthly_billing
number<float>

Total billing amount for the current month

Example:

5.806