Analytics (admin API)
Admin routes of the analytics module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.
GET /v1/admin/analytics/customers
Section titled “GET /v1/admin/analytics/customers”Get customer acquisition and retention metrics
Parameters:
fromin query (string, optional).toin query (string, optional).
Responses:
200: no description. Body: object.
GET /v1/admin/analytics/dashboard
Section titled “GET /v1/admin/analytics/dashboard”Get overview dashboard metrics for today, week and month
Responses:
200: no description.
GET /v1/admin/analytics/funnel
Section titled “GET /v1/admin/analytics/funnel”Get conversion funnel counts and drop-off rates
Parameters:
fromin query (string, optional).toin query (string, optional).
Responses:
200: no description. Body: array of object.
GET /v1/admin/analytics/pixels
Section titled “GET /v1/admin/analytics/pixels”Get tracking pixel configuration
Responses:
200: no description.
PATCH /v1/admin/analytics/pixels
Section titled “PATCH /v1/admin/analytics/pixels”Update tracking pixel configuration
Request body: UpdatePixelsAdminDto.
Responses:
200: no description.
GET /v1/admin/analytics/products
Section titled “GET /v1/admin/analytics/products”Get per-product performance metrics
Parameters:
fromin query (string, optional).toin query (string, optional).
Responses:
200: no description. Body: array of object.
GET /v1/admin/analytics/revenue
Section titled “GET /v1/admin/analytics/revenue”Get revenue breakdown metrics
Parameters:
fromin query (string, optional).toin query (string, optional).
Responses:
200: no description. Body: object.
GET /v1/admin/analytics/search
Section titled “GET /v1/admin/analytics/search”Get search event counts and top query terms
Parameters:
fromin query (string, optional).toin query (string, optional).
Responses:
200: no description. Body: object.
GET /v1/admin/analytics/timeseries
Section titled “GET /v1/admin/analytics/timeseries”Get bucketed time series for orders, revenue or sessions
Parameters:
fromin query (string, optional).granularityin query ("day","hour","week", optional).metricin query ("orders","revenue","sessions", required).toin query (string, optional).
Responses:
200: no description.
Schemas
Section titled “Schemas”UpdatePixelsAdminDto
Section titled “UpdatePixelsAdminDto”googleAnalyticsId(string, pattern^[A-Za-z0-9\-]*$, max length 50, optional).metaPixelId(string, pattern^[0-9]*$, max length 50, optional).tiktokPixelId(string, pattern^[A-Za-z0-9]*$, max length 50, optional).snapPixelId(string, pattern^[A-Za-z0-9\-]*$, max length 50, optional).
