Analytics

The Analytics API provides workspace reporting, conversation trends, Agent performance metrics, customer insights, live monitoring, and analytics export operations.

Endpoints

MethodPathPurpose
GET/analytics/overviewGet Workspace KPIs
GET/analytics/conversationsGet Conversation trends
GET/analytics/agentsGet Agent performance
GET/analytics/insightsGet customer insights
GET/analytics/live/kpisGet live KPI counters
GET/analytics/liveGet live monitor state
GET/analytics/reports/exportExport analytics CSV

The days query parameter defaults to 7 for applicable reporting endpoints.

Example:

GET /analytics/overview?days=7

Authorization: Bearer <AUTH0_ACCESS_TOKEN>

x-workspace-id: <WORKSPACE_ID>

Need Help?

Email: support@ysdesk.com

Documentation: https://docs.ysplugins.com/ys-desk

Next