GET /analytics/summary
Composite analytics summary
Returns the requested metrics[] sections in a single response, plus a
meta block. Resolve the shared scope once and project only the sections a
given view needs, rather than fetching every section on every call.
metrics[] is REQUIRED and accepts 1 to 12 section keys per request.
Omitting it, or passing an empty array, is a 422 whose message enumerates
every valid section key. Requesting more than 12 keys is a 422 asking you to
split into multiple requests — each projection is cached independently per
scope and window, so repeat calls are cheap after the first build. The
response returns exactly the listed sections, in the canonical section order.
Most sections return one aggregate over the whole resolved scope. The
track-streams-daily and track-listeners-daily sections are the per-track
counterpart — one row per date, platform and ISRC, so a request scoped to a
release returns each of its tracks — and both require filter[release_id],
filter[isrc] or filter[upc].
A response that projects a social/UGC section also carries
meta.social_availability, mapping each requested social section across the
UGC platforms; filter[ugc_platform] narrows those sections to one platform.
The date range may span up to 400 days, so a full year (or a year plus a
comparison period) fits in one request. A longer range returns a 422 naming
the limit. Every section reports day-level points at every accepted span. A
range that is within the limit but still too heavy to compute returns a 422
asking you to narrow it — retry with a shorter range or fewer metrics[].
Parameters
- filter[start_date] (query)
- filter[end_date] (query)
- filter[platform] (query)
- filter[ugc_platform] (query)
- filter[release_id] (query)
- filter[isrc] (query)
- filter[upc] (query)
- filter[artist_names][] (query)
- limit (query)
- metrics[] (query)
- filter[label_id] (query)
Responses
- 200
- 503
- 422
- 401