Get cross-product analytics overview
Returns reliability, usage, and attention signals across the workspace’s products.
/api/v2/analytics/overviewAuthorizationBearer token (Anlyon API key) · headerrequiredWorkspace API key sent as Authorization: Bearer <key>.
better-auth.session_tokenAPI key · cookierequiredBrowser session used by dashboard-only operations.
startDatestring<date-time>Start date for filtering (ISO 8601 format)
endDatestring<date-time>End date for filtering (ISO 8601 format)
granularitystringhourdayweekmonthenvironmentIdstring<uuid>Optional environment scope for session-authenticated requests.
limitintegerX-Request-IdstringOptional caller correlation ID. Unsafe or oversized values are replaced.
Cross-product workspace analytics returned.
successbooleanrequiredtruedataAnalyticsOverviewDatarequiredShow propertiesHide properties
rangeAnalyticsRangeMetadatarequiredShow propertiesHide properties
startDatestring<date-time>requiredendDatestring<date-time>requiredgranularitystringrequiredhourdayweekmonthtruncatedbooleanrequiredTrue when the requested range exceeded plan retention.
retentionDaysinteger | nullrequiredNull means unlimited retention.
scopeAnalyticsScopeMetadatarequiredShow propertiesHide properties
workspaceIdstring<uuid>requiredenvironmentIdstring<uuid> | nullrequiredsummaryobjectrequiredShow propertiesHide properties
agentRunsintegerrequiredagentRunSuccessRatenumberrequiredmessagesDeliveredintegerrequiredmessageSuccessRatenumberrequiredworkflowRunsintegerrequiredworkflowSuccessRatenumberrequiredactionInvocationsintegerrequiredactionSuccessRatenumberrequiredpendingApprovalsintegerrequiredusageobjectrequiredseriesAnalyticsUsage[]requiredShow propertiesHide properties
AnalyticsUsagedatestring<date>requiredmessagesPublishedintegerrequiredmessagesDeliveredintegerrequiredmessagesFailedintegerrequiredschedulesExecutedintegerrequiredbandwidthBytesintegerrequiredmemoryOperationsintegerrequiredembeddingTokensintegerrequiredllmTokensintegerrequiredrerankOperationsintegerrequiredmemoryStorageBytesintegerrequiredeventPublishesintegerrequiredfileStorageBytesintegerrequiredcacheLookupsintegerrequiredcacheHitsintegerrequiredactionInvokesintegerrequiredattentionobject[]requiredShow propertiesHide properties
objectproductstringrequiredagentsdeliveryworkflowsactionsapprovalslabelstringrequiredcountintegerrequiredhrefstringrequiredBad Request - Invalid input data
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobjectUnauthorized - Invalid or missing API key
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobjectAuthenticated credential lacks the required scope or workspace access.
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobjectToo Many Requests - Rate limit exceeded
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobject
