| Endpoint | Key | Returns |
|---|---|---|
GET /api/public/v1/leads | Brand | Your shopper reservation requests. They contain personal data: retain them according to your privacy notice. Erased rows remain with consumerPiiPurgedAt set and personal fields scrubbed. |
GET /api/public/v1/analytics/funnel | Brand or retailer | Your locator funnel for the requested dates. |
GET /api/public/v1/analytics/attribution | Brands | Clicks from your locator to each shop, under your brand’s account. These are separate from Observed seller actions. |
All three endpoints need api:read. Leads use limit and cursor; a 200 response contains data and nextCursor. A retailer key gets no supplier-owned leads.
curl "https://api.test.stockisto.com/api/public/v1/leads?limit=50" \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
Both analytics reads accept from and to as yyyy-MM-dd. The default window is the trailing 30 days. from after to, or a span over 366 days, returns 400.
curl "https://api.test.stockisto.com/api/public/v1/analytics/funnel?from=2026-09-01&to=2026-09-30" \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
A 200 funnel response contains tenantId, tenantType, from, to, supplier and retailer. The key’s tenant type selects the populated view.
curl "https://api.test.stockisto.com/api/public/v1/analytics/attribution?from=2026-09-01&to=2026-09-30" \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
Attribution returns tenantId, from, to, coveredFrom, data and truncated. Check coveredFrom for the retained window. There is no cursor: when truncated is true, narrow the dates and request again. A retailer key gets an empty attribution list.
Observed seller actions · Authentication, errors and pagination