Get an analytics time series
Returns one traffic time series bucketed by unit (year, month, day, hour, or minute). series selects which: pageviews returns parallel pageviews and sessions arrays with one point per time bucket (and accepts compare — prev or yoy — to request comparison data for the previous period or year), while events returns tracked custom-event counts as one events point per event name per time bucket. Only the requested series’ fields are present in the response. startAt and endAt are Unix epoch milliseconds; timezone is an IANA name (e.g. America/New_York) that controls bucket boundaries; optional filter parameters narrow the data. The series is capped to the most recent maxPoints time buckets (default 30, max 500); a truncated field reports when the cap was applied. Requires a plan that includes analytics (403 otherwise); empty until the website is published and has traffic.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Path Parameters
1Query Parameters
0 <= x <= 90071992547409910 <= x <= 9007199254740991^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$year, month, day, hour, minute 11 <= x <= 500Which time series to return: pageviews for page views and sessions per bucket, events for tracked custom-event counts per event name per bucket.
pageviews, events Request comparison data alongside the primary series: prev for the previous period, yoy for the same range one year earlier. Only valid when series is pageviews.
prev, yoy Response
The requested time series: pageviews and sessions per bucket, or events per event name per bucket.
Page views per time bucket. Present only when series is pageviews.
Distinct sessions per time bucket. Present only when series is pageviews.
One point per event name per time bucket. Present only when series is events.
Present only when the series exceeded maxPoints and was capped to the most recent time buckets.