Description

Returns overall sentiment scores (with aspect labels) over time.
Supports two query modes based on the provided parameters.

Mode 1: Managed Surveys — By Rake IDs (when rakeIds is provided)

Fetches overall scores for each specified rake wave, with optional
current/comparison rake highlighting.

• rakeIds (number[], required) — List of cycle IDs to retrieve scores
  for
• surveyType (string, optional) — Filter by survey type
• tags (optional) — {"ethnicity": [id1, id2, ...], "ageGroup": [id4, id5]} Filter by tags

Mode 2: Post Interaction Surveys — By Date Range

Fetches overall scores aggregated over a time range, grouped by
granularity.

• startDate (string/date, required) — Start of the date range

• endDate (string/date, required) — End of the date range

• surveyId (string, required) — Survey to query

• groupBy (Granularity enum, optional) — Time grouping granularity
  (e.g. day, week, month)

• tags (optional) — Filter by tags

  Response: A map of time-period keys to OverallScoreWithAspectLabel[] —
  each entry contains overall scores enriched with aspect metadata.

  ▎ Note: In date-range mode, if the survey's creation date is later
  than startDate, the effective start date is automatically adjusted to
  the survey creation date.