Skip to main content
GET
Get Sales Analytics

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

organizationId
string

Required for session auth. API keys already belong to one organization.

Maximum string length: 160
from
string

First day of the range (YYYY-MM-DD). Defaults to 29 days before to.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

Last day of the range, inclusive (YYYY-MM-DD). Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$
marketplace
string

Comma-separated marketplaces, for example shopee,lazada.

Maximum string length: 200
country
string

Comma-separated countries. One country selects its currency.

Maximum string length: 200
store
string

Comma-separated store (account) ids from GET /api/v1/marketplaces/connected.

Maximum string length: 1000
currency
string

ISO currency. Only orders in this currency are counted; amounts are not converted. Defaults to the single country's currency, otherwise SGD.

Maximum string length: 3
timeZone
string

IANA time zone that defines each day, for example Asia/Kuala_Lumpur. Defaults to Asia/Singapore.

Maximum string length: 80

Response

Sales analytics.

ok
boolean
required
apiVersion
string
required
Allowed value: "developer_v1"
operationId
string
required
status
enum<string>
required
Available options:
accepted,
completed,
failed
warnings
string[]
required
recommendations
string[]
required
data
object
required
jobId
string
productId
string