Analytics

Aggregated metrics, KPIs, trends, and data exports. Access performance summaries across campaigns, call centers, and executives.

Endpoints

Method	Endpoint	Description	Scope
GET	/analytics/summary	Get aggregated summary metrics and KPIs	analytics:read
GET	/analytics/campaigns	Get per-campaign analytics breakdown	analytics:read
GET	/analytics/call-centers	Get per-call-center analytics breakdown	analytics:read
GET	/analytics/executives	Get per-executive performance metrics	analytics:read
GET	/analytics/trends	Get time-series trend data with granularity	analytics:read
POST	/analytics/export	Start an asynchronous data export job	analytics:export
GET	/analytics/export/{jobId}	Check export job status and download URL	analytics:read

Common Filters

These query parameters are shared across all GET analytics endpoints.

Parameter	Type	Description
dateFrom	ISO 8601	Start date for the analytics period
dateTo	ISO 8601	End date for the analytics period
campaignId	string	Filter by campaign ID
callCenterId	string	Filter by call center ID
engagementId	string	Filter by engagement ID

Trends Granularity

The GET /analytics/trends endpoint accepts an additional granularity parameter.

Value	Description
daily	One data point per day (default)
weekly	One data point per week
monthly	One data point per month

Example Requests

Get summary metrics for a date range:

curl https://api.auralytik.com/v1/analytics/summary?dateFrom=2024-01-01&dateTo=2024-01-31 \
  -H "Authorization: Bearer YOUR_API_KEY"

Get weekly trends for a specific campaign:

curl https://api.auralytik.com/v1/analytics/trends?granularity=weekly&campaignId=camp_789 \
  -H "Authorization: Bearer YOUR_API_KEY"

Start an export job:

curl -X POST https://api.auralytik.com/v1/analytics/export \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dateFrom": "2024-01-01",
    "dateTo": "2024-01-31",
    "format": "csv"
  }'

Example Response

Summary endpoint response:

{
  "dateFrom": "2024-01-01",
  "dateTo": "2024-01-31",
  "totalEvaluations": 1250,
  "completedEvaluations": 1180,
  "averageScore": 7.8,
  "sentimentBreakdown": {
    "positive": 620,
    "neutral": 380,
    "negative": 180
  },
  "averageDurationSeconds": 312,
  "topCampaign": "Q1 Outbound Sales",
  "topCallCenter": "Santiago Central"
}

Advanced analytics coming soon

Custom metric definitions, scheduled report delivery, and real-time streaming analytics are being developed.

Request API Access