Description

Returns aspect sentiment scores over time. Supports two query modes
based on the provided parameters.

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

Fetches aspect scores for each specified cycle.

• rakeIds (number[], required) — List of rake IDs to retrieve scores
  for
• aspectIds (string[], optional) — Filter results to specific aspects
• tags (optional) — Filter by tags
• tagsToInclude (string, optional) — Additional tag inclusion filter

Mode 2: Post Interaction Surveys — By Date Range

Fetches aspect 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, required) — Time grouping granularity
  (e.g. day, week, month)

• aspectIds (string[], optional) — Filter results to specific aspects

• tags (optional) — Filter by tags

• tagsToInclude (string, optional) — Additional tag inclusion filter

  Response: OverTimeAspectScoresByRakeIdResponse — a map of time-period
  keys to aspect score results.

  ▎ 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.