APIAPI referenceAnalytics
Get Timeseries
{ metric; interval; points: { date; value }[] }.
GET/v1/stores/{store_id}/analytics/timeseriesScope analytics:read
- Scope:
analytics:read(scopes and plan access) - Rate limit: 600 requests/min per API key (test keys: 60/min) (rate limits)
`{ metric; interval; points: { date; value }[] }`.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| store_idrequired | path | string | |
| metricrequired | query | string (enum) | |
| fromrequired | query | string | Store-local date, inclusive |
| torequired | query | string | Store-local date, inclusive |
| interval | query | "day" | "week" | "month" | |
| compare | query | "previous_period" | null |
Example request
curl -X GET "https://api.shopassist.coec.dk/v1/stores/sto_01j8000000e008000000000000/analytics/timeseries" \
-H "Authorization: Bearer $SHOPASSIST_API_KEY"Response 200 (Timeseries)
| Field | Type | Description |
|---|---|---|
| intervalrequired | "day" | "week" | "month" | |
| metricrequired | string (enum) | one of conversations, billable_units, ai_replies, widget_opens, resolution_rate, handoff_rate, csat_avg, csat_count, leads, add_to_cart, checkout_clicks, attributed_orders, chat_conversion_rate, attribution_coverage, proactive_ctr, answers_rated_up, answers_rated_down, revenue_add_to_cart, revenue_checkout_link, revenue_assisted_session |
| pointsrequired | TimeseriesPoint[] | |
| points[].daterequired | string | format date |
| points[].valuerequired | number | null |
{
"interval": "day",
"metric": "conversations",
"points": [
{
"date": "2026-10-01",
"value": 1
}
]
}Errors
Every error uses the error envelope; the code field is stable.
400Bad Request401Unauthorized403Forbidden404Not Found422Unprocessable Content429Too Many Requests
Last updated on