API reference
Analytics
GET
Views, requests and top products of the vendor over range (7d, 30d, 90d).
Requires the analytics:read scope.
apiKey analytics:readheader
AuthorizationBearer <token>An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....
Scope: analytics:read
range?"7d"Value in
"7d"from?stringto?stringgranularity?"day"Value in
"day"Success
application/json- response
data*curl -X GET "https://example.com/api/v1/key/analytics"{ "data": { "products": [ { "product": { "brand": { "id": "string", "name": "string", "slug": "string", "logoUrl": "string" }, "compareAtPrice": 0, "currency": "string", "hasBim": true, "id": "string", "inStock": true, "isNew": true, "name": "string", "price": 0, "priceOnRequest": true, "slug": "string", "type": "string", "coverUrl": "string", "hoverUrl": "string" }, "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "conversion": 0 } ], "brands": [ { "brand": { "id": "string", "name": "string", "slug": "string", "logoUrl": "string" }, "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "conversion": 0 } ], "providers": [ { "provider": { "id": "string", "name": "string", "slug": "string", "status": "pending", "logoUrl": "string" }, "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "conversion": 0 } ], "designers": [ { "designer": { "id": "string", "name": "string", "slug": "string" }, "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "conversion": 0 } ], "requests": { "total": 0, "replied": 0, "resolved": 0, "responseRate": 0, "medianResponseHours": 0, "byType": [ { "type": "price", "count": 0 } ], "byStatus": [ { "status": "quoted", "count": 0 } ], "byCountry": [ { "country": "string", "count": 0 } ] }, "catalogue": { "products": 0, "published": 0, "pending": 0 }, "period": { "range": "7d", "from": "string", "to": "string", "granularity": "day", "days": 0 }, "totals": { "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "conversion": 0, "outbound": 0 }, "previous": { "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "conversion": 0, "outbound": 0 }, "series": [ { "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "date": "string" } ], "previousSeries": [ { "requests": 0, "favorites": 0, "downloads": 0, "views": 0, "visitors": 0, "pageViews": 0, "date": "string" } ], "sources": [ { "count": 0, "source": "social" } ], "countries": [ { "country": "string", "count": 0 } ], "locales": [ { "locale": "string", "count": 0 } ], "audience": [ { "count": 0, "profession": "string" } ] }}