Skip to main content
GET
Get performance report
Returns orders, approved orders, revenue and commission for a period, grouped by day or by channel. This endpoint has its own limit of 10 requests per minute. Requires scope network:reports:read.

Authorizations

x-api-key
string
header
required

Brand key created in the dashboard.

Query Parameters

from
string<date-time>
required

Start of the period (ISO 8601).

to
string<date-time>
required

End of the period (ISO 8601). At most 90 days after from.

groupBy
enum<string>
default:day

How rows are grouped.

Available options:
day,
channel
page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:20

Items per page. Values above 100 return 400.

Required range: 1 <= x <= 100

Response

Report rows

data
object[]
required
meta
object
required