Read the vendor's most read products
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.
- Scopes
analytics:read - Rate classread
/v1/vendor/stats/productsThe 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.
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/products"{ "object": "vendor_product_stats", "period": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }, "threshold": 1, "products": [ { "product": "string", "title": "string", "views": 0, "retailers": 0 } ], "computed_at": "2019-08-24T14:15:22Z"}Read an agreement and where the organisation stands GET
The newest published version of the agreement, with its full text and hash, the organisation's newest acceptance, and its standing: `accepted`, `grace` (an earlier acceptance counts until `accept_by`), `required` or `unpublished`. Vendors only: a retailer answers 403 `permission_denied`.
Read the vendor's reach week by week GET
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.