Skip to main content
GET
How the business is doing over a period

Authorizations

Authorization
string
header
required

A merchant-scoped API key, issued by CloudPay staff or the merchant's owner. Acts with exactly its scopes.

Path Parameters

merchantID
string<uuid>
required

Query Parameters

from
string<date-time>

Inclusive. Default: 30 days before to.

to
string<date-time>

Exclusive. Default: now. At most 366 days after from.

interval
enum<string>

Default by span: day up to 31 days, week up to 180, else month.

Available options:
day,
week,
month
till_id
string<uuid>

Response

Insights.

status
object
required
data
object