Skip to main content
cURL

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The Etsy listing ID. A listing outside the workspace is 404.

Pattern: ^[0-9]{1,20}$
Example:

"1834720561"

Query Parameters

​
from
string

The first day (UTC, inclusive). Default: the first day of the shop's sales coverage (the listing's creation day for a shop with none), or to when that is earlier.

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

The last day (UTC, inclusive). Default: the shop's last complete day (yesterday for a shop with no coverage), or from when that is later.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
interval
enum<string>

The series interval: day, week (UTC weeks from Monday), month (default), quarter or year. At most 366 points.

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

"month"

​
currency
string

Convert every money value into this currency at current exchange rates (conversion says so). Default: the listing's own price currency.

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

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

Response

OK

​
object
string
required
Allowed value: "workspace.listing_stats"
​
listing_id
string
required

Etsy ID, as a string.

​
from
string
required

The first day of the range (UTC, inclusive).

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

The last day of the range (UTC, inclusive).

Pattern: ^\d{4}-\d{2}-\d{2}$
​
interval
enum<string>
required
Available options:
day,
week,
month,
quarter,
year
​
currency
string
required

ISO 4217 code of every money value: the listing's own price currency unless currency was asked for.

​
totals
object
required

The range's totals over the days Alura's sales data covers (coverage); a known-gap day is left out and partial_range says so. Sales values are null when no day of the range is covered (sales_not_covered).

​
series
object[] | null
required

One point per interval, oldest first; null when the shop has no sales coverage at all.

​
lifetime
object
required

Etsy's lifetime counters (no history of them exists).

​
metrics
object
required
​
coverage
object | null
required

The shop's sales coverage; null when Alura has none for the shop yet (sales_not_covered).

​
conversion
object | null
required

What was converted into currency: all history at the exchange rates of rate_date (current rates, not each day's). null when nothing was converted.

​
notices
object[]
required

Why a value is null or partial (sales_not_covered, partial_range, refunds_partial, reviews_not_synced), and currency_converted_at_current_rate; empty when nothing is.

​
as_of
string | null
required

When the shop's orders, which the sales come from, were last synced (ISO 8601, UTC); null when never.