Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
stripe
/
metrics
Error
A valid request URL is required to generate request examples
{}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Query Parameters

​
from
string<date-time>
required

Start date (required)

​
to
string<date-time>
required

End date (required)

​
periodType
enum<string>
default:daily

Metric granularity

Available options:
daily,
monthly
​
stripeAccountId
string

Filter by specific Stripe account (for multi-account setups)

Response

Array of metric snapshots

The response is of type object.