Actions33
- Account Data Actions
- General Data Actions
- Integration Actions
- Project Actions
- Tracked Account Actions
- Tracked Individual Video Actions
- Video Data Actions
General Data → Get KPIs
AI-generatedSummary
Retrieves aggregate key performance indicators (KPIs) for tracked videos across specified platforms and date ranges.
Inputs
- dateRangeFrom (required) — Start date (YYYY-MM-DD). Defaults to 14 days ago.
- dateRangeTo (required) — End date (YYYY-MM-DD). Defaults to today.
- filters — Filter configuration including accounts, content types, platforms, and projects.
- options.simplifyOutput — If true, returns a simplified object with only high-level metrics (videoCount, viewCount, etc.) instead of raw data.
Output shape
a single object with aggregate metrics
If simplifyOutput is enabled, returns a compact object with top-level counts and engagement rate. Otherwise, returns the raw API response.
Examples
Example 1: Get KPIs for the last 7 days across all platforms
dateRangeFrom: 14 days ago, dateRangeTo: today, filters: empty
Example 2: Get KPIs for TikTok videos in a specific project
filters.platforms: ['tiktok'], filters.projects: [project_id], dateRangeFrom: '2023-01-01', dateRangeTo: '2023-01-31'