API reference / analytics
Get analytics overview
GET
/v1/analytics/overviewPermission analytics:readReturns aggregate KPIs and daily engagement series for a date range and channels.
Headers
AuthorizationstringREQUIREDBearer followed by your API key.
Foxli-WorkspacestringTarget workspace ID. Required if account owns or admins more than one workspace.
Query parameters
workspace_idstringAlternative way to pass workspace ID.
fromstringtostringstart_datestringend_datestringchannel_idsarrayErrors
400
validation_failedInvalid parameters or missing workspace context.401
invalid_api_keyMissing, invalid, or revoked API key.403
insufficient_scopeAPI key lacks required scope: analytics:read429
rate_limitedToo many requests. Check Retry-After seconds.curl https://api.foxli.app/v1/analytics/overview \ -H "Authorization: Bearer $FOXLI_API_KEY" \ -H "Foxli-Workspace: ws_brand_primary"
Response200 OK
{
"success": true
}