Overview
Visits, units, revenue and conversion for products and listings, as a series over a period.
Metrics show how each product and each Listing perform: visits, units sold, revenue and conversion. You read a series over a period, without calling the marketplace. The API only reads data that is already synced.
Where metrics fit in the journey: Grow and track.
Endpoints
| Method | Path | What it does |
|---|---|---|
GET | /v1/products/{productId}/metrics | Product metrics |
GET | /v1/listings/{listingId}/metrics | Listing metrics |
GET | /v1/listings/{listingId}/visits | Listing visits |
All require Authorization: Bearer mk_your_api_key. See Authentication.
The series
Every response has period (from and to, inclusive), granularity (day, week or month) and timezone. The week is ISO and starts on Monday. The period is at most 366 days.
Every bucket in the period appears, even with no data. date is the start of the bucket in timezone.
Values
| Field | What it is |
|---|---|
visits | visits to the listing |
units | units sold |
orders | orders |
revenueInCents | product revenue, in cents |
conversionBps | orders × 10000 ÷ visits, in bps |
Revenue is the value of the product sold: no shipping, before fees and taxes. The net amount is in Finance.
conversionBps is recalculated in each bucket from the sums. It is never an average of ratios.
null is not zero
null means the marketplace does not report the value. 0 means it reported and it was zero. conversionBps is null when visits is 0 or null.
Where sales come from
When the marketplace has no sales series, units, orders and revenueInCents come from the imported orders. The salesSource field tells which source was used:
salesSource | Means |
|---|---|
marketplace | the marketplace's own sales series |
orders | calculated from orders |
mixed | product with listings from different sources |
null | no sales source available |
Pass salesSource=auto (default), marketplace or orders in the query. One source per Connection: the same sale never counts twice. Canceled or refunded orders do not count.
Errors
400:fromafterto, or a period over 366 days.404: resource from another account.409: the product series mixes listings with different time zones (mixed_timezones) or currencies (mixed_currencies).422: the Connection does not offer the required capability.