Get a timeseries

One Overview metric over time: a point for every bucket of the range, oldest first, with 0 in buckets that had nothing. A bucket is one interval of the chosen granularity. The last part of the path picks the metric, and each point has date plus the fields listed here:

• visitors-sessions: uniqueVisitors, sessionCount, returningVisitors, pageViews and topSources.
• bounce-rate: uniqueVisitors and bounceRate.
• new-vs-returning: uniqueVisitors, newVisitors and returningVisitors.
• avg-session-duration: avgSessionDuration.
• revenue: revenue, refundedRevenue and topSources. Only this path takes model and window.
• conversion-rate: conversionRate.
• revenue-per-visitor: revenuePerVisitor.

Sessions and their visitors count in the bucket the session started in; page views and payments count in the bucket they happened in. A visitor active in three buckets counts in each of them, so adding up the buckets gives more than the range's visitor total.

Keys: an account key. Getting started explains both kinds.

Paths

Parameters

Response

An array of objects.

curl 'https://app.spreelytics.com/api/v1/event/analytics/web-analytics/timeseries/visitors-sessions?contactListId=…&startDate=…&endDate=…&granularity=…' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = new URL('https://app.spreelytics.com/api/v1/event/analytics/web-analytics/timeseries/visitors-sessions');
url.searchParams.set('contactListId', '…');
url.searchParams.set('startDate', '…');
url.searchParams.set('endDate', '…');
url.searchParams.set('granularity', '…');

const res = await fetch(url, {
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
});
const data = await res.json();

import requests

res = requests.get(
    "https://app.spreelytics.com/api/v1/event/analytics/web-analytics/timeseries/visitors-sessions",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"contactListId": "…", "startDate": "…", "endDate": "…", "granularity": "…"},
)
data = res.json()

[
  {
    "date": "string",
    "uniqueVisitors": 0,
    "sessionCount": 0,
    "returningVisitors": 0,
    "pageViews": 0,
    "topSources": [
      {
        "revenue": 0,
        "uniqueVisitors": 0,
        "name": "string"
      }
    ]
  }
]