Read the vendor's reach week by week
Retailers' reads of the vendor's products and the distinct retailers reading them, for each of the last 12 complete weeks. Each week is thresholded on its own; there is no daily series and no breakdown by retailer.
- Scopes
analytics:read - Rate classread
/v1/vendor/stats/seriesRetailers' reads of the vendor's products and the distinct retailers reading them, for each of the last 12 complete weeks. Each week is thresholded on its own; there is no daily series and no breakdown by retailer.
Authorization
apiKey An API key (fo_live_… / fo_test_…) as a bearer token
In: header
Header Parameters
Dated API version; pinned per organisation on first use and overridable per request
Value in
- "2026-10-01"
- "2026-10-04"
The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused
Value in
- "live"
- "test"
ETag of a cached representation; a match returns 304
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/vendor/stats/series"{ "object": "vendor_stats_series", "interval": "week", "weeks": [ { "week_start": "2019-08-24", "product_views": { "value": 0, "threshold": 1 }, "retailers": { "value": 0, "threshold": 1 } } ], "computed_at": "2019-08-24T14:15:22Z"}Read the vendor's most read products GET
The vendor's products most read by retailers in the last 30 days, listing only those read by at least k distinct paying retailers, so no single retailer's reading shows.
Read the vendor's reach and data health GET
How many paying retailers carry the vendor's products and how often they read them in the last 30 days, with the catalogue's completeness and freshness. Aggregates only, computed by a platform job: a count below its threshold is withheld, and no retailer is ever named.