List insights

Returns the insights the Insights page shows: channels, sources, countries, devices and entry pages whose traffic moved sharply against their own recent past. Nobody sets them up. Detection runs once a day for every audience with traffic in the last two days, and again when someone presses Check now in the app.

Each insight compares a window with a baseline, in whole UTC days that end yesterday, so today is never included:

• yesterday against the median of the four same weekdays before it, so a quiet Sunday is compared with other Sundays.
• rolling_7d and rolling_30d against the 7 or 30 days immediately before them.

A change becomes an insight only with enough volume: at least 100 sessions across the window and the baseline, a difference of at least 20 sessions, and at least 15%. Entry pages need 200 entries and a difference of 40. At most 20 are kept per module and window, ranked by impact, and an insight that is no longer true disappears at the next run. severity is low below a 50% change, moderate below 100% and severe from there up.

Every role can call it, Viewer included.

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

Parameters

Response

Each item in content

curl 'https://app.spreelytics.com/api/v1/spreelytics/insights?contactListId=…' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = new URL('https://app.spreelytics.com/api/v1/spreelytics/insights');
url.searchParams.set('contactListId', '…');

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/spreelytics/insights",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"contactListId": "…"},
)
data = res.json()

{
  "content": [
    {
      "id": "string",
      "moduleKey": "string",
      "dimensionKey": "string",
      "displayName": "string",
      "windowKind": "string",
      "title": "string",
      "summary": "string",
      "direction": "string",
      "severity": "string",
      "impactScore": 0,
      "current": 0,
      "baseline": 0,
      "changePct": 0,
      "sharePct": 0,
      "prevSharePct": 0,
      "metricLabel": "string",
      "sparkline": [
        0
      ],
      "windowStart": "string",
      "windowEnd": "string",
      "firstDetectedAt": "string",
      "lastSeenAt": "string"
    }
  ],
  "size": 0,
  "page": 0,
  "totalItems": 0,
  "totalPages": 0
}