Skip to main content
cURL

Authorizations

​
Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

​
shop_id
string[]

Only these connected shops, comma-separated; default every connected shop of the workspace. A shop outside the workspace is 404.

​
period
enum<string>

The last 7, 30, 90 or 365 days, ending on the newest day every included shop has data for. Default 30d. Not with from/to.

Available options:
7d,
30d,
90d,
365d
​
from
string

First day of the range (UTC), inclusive. Needs to.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
​
to
string

Last day of the range (UTC), inclusive. Needs from.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
​
interval
enum<string>

Adds series, one point per UTC day, week (from Monday), month, quarter or year; at most 366 points.

Available options:
day,
week,
month,
quarter,
year
Example:

"week"

​
compare
enum<string>

previous_period adds compare: the equal period just before, with the change per metric.

Available options:
previous_period
Example:

"previous_period"

​
group_by
enum<string>

shop adds by_shop, the same values for each shop.

Available options:
shop
Example:

"shop"

​
currency
string

Serve the money in this currency, converted at today's rate. Default each shop's own (Etsy payment account) currency.

Pattern: ^[A-Za-z]{3}$
​
fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

​
expand
string

Comma-separated related objects to include: revenue_detail, fees, marketing, seller_services, ratios, balance. Free.

Response

OK

​
object
string
required
Allowed value: "workspace.stats"
​
shop_ids
string[]
required
​
from
string
required
​
to
string
required
​
interval
enum<string> | null
required
Available options:
day,
week,
month,
quarter,
year
​
currency
string | null
required

The money's currency; null for a single shop whose Etsy payment account currency is unknown.

​
sales
object | null
required

Revenue (Etsy payment account: sales after refunds and taxes Etsy collects), orders, items sold, average order value (gross sales per order), refunds (amount and count) and the refund rate (refunds per order).

​
costs
object | null
required

Total costs (Etsy costs plus your own when you have entered them), Etsy fees, marketing (ads, Etsy Plus, Pattern) and seller services (shipping labels), as positive amounts.

​
profit
object | null
required

Net profit (revenue minus total costs) and margin (net profit per revenue). net_before_your_costs: revenue minus Etsy costs when a shop has no own costs entered (then net profit holds Etsy costs only), else null.

​
reviews
object | null
required

Reviews received, their average rating and the review rate (reviews per item sold).

​
conversion
object | null
required

What was converted: from these currencies into to, all history at the rate of rate_date (today's rates, not each day's). null when nothing was converted.

​
coverage
object[]
required
​
as_of
string<date-time> | null
required

The oldest included shop's financials sync time.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
​
freshness
object[]
required
​
notices
object[]
required
​
revenue_detail
object | null

Gross sales, and the sales tax and VAT Etsy collected from buyers.

​
fees
object | null

Etsy fees by kind, all Etsy costs, and your own costs (null when you have entered none).

​
marketing
object | null

Ad spend (Etsy Ads and Offsite Ads), Etsy Plus and Pattern.

​
seller_services
object | null

Shipping labels bought on Etsy.

​
ratios
object | null

Each cost as a share of revenue, Etsy-only profit and margin (before your own costs), and items per order.

​
balance
object | null

Payments to and from Etsy (positive amounts) and the payment account balance on the last day.

​
series
object[]
​
compare
object
​
by_shop
object[]