Get Analytics
get_analyticsRetrieve sales analytics for any date range including revenue, orders, returns, cancellations, and ad spend. Group by product, day, week, month, or category.
Instructions
Get sales analytics for a date range. This is the most powerful analytics tool — use it to answer questions like "show revenue for last week", "top 10 products by orders", "how many cancellations this month".
Available metrics: revenue, ordered_units, delivered_units, returns, cancellations, hits_view_search (search impressions), hits_view_pdp (product page views), hits_tocart (add to cart), session_view_pdp, adv_sum (ad spend), adv_sum_all, position_category.
Available dimensions (group by): sku (by product), day, week, month, category1 (top category), category2, brand, delivery_type.
Dates must be in format "YYYY-MM-DD".
Note: the metrics array in the response corresponds 1:1 (by index) to the metrics array in the request.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order. Default: by first metric DESC | |
| limit | No | Number of rows (default: 1000) | |
| offset | No | Pagination offset | |
| date_to | Yes | End date in format YYYY-MM-DD, e.g. "2024-01-31" | |
| filters | No | Optional filters | |
| metrics | Yes | Metrics to retrieve. At least one required. | |
| date_from | Yes | Start date in format YYYY-MM-DD, e.g. "2024-01-01" | |
| dimension | Yes | Group by dimensions. At least one required. |