Get Campaign Analytics

Get comprehensive analytics for a specific campaign.

GET/api/v1/campaigns/:id/analytics

Analytics endpoints provide detailed metrics about campaign performance including call statistics, success rates, quality metrics, and cost analysis.

Authorization

Parameter Type Description

Parameter	Type	Description
`x-api-key`required	`string`	Your API key Example: `dk_...`

x-api-keyrequired

string

Your API key

Example: dk_...

Path Parameters

Parameter	Type	Description
`id`required	`string`	The campaign ID

Query Parameters

Parameter	Type	Description
`dateFrom`	`string`	Start date for filtering (YYYY-MM-DD format)
`dateTo`	`string`	End date for filtering (YYYY-MM-DD format)

Responses

{
  "data": {
    "campaign": {
      "id": "357b188c-c618-4f95-84b1-cbe26b8ce3e0",
      "name": "Q1 Provider Outreach",
      "status": "active"
    },
    "metrics": {
      "callStats": {
        "totalCalls": 150,
        "completedCalls": 120,
        "failedCalls": 10,
        "cancelledCalls": 5,
        "pendingCalls": 15
      },
      "successMetrics": {
        "humanContactRate": 0.75,
        "objectiveSuccessRate": 0.68,
        "callbackRate": 0.12
      },
      "qualityMetrics": {
        "avgSentimentScore": 0.72,
        "avgCallDuration": 180
      },
      "complianceMetrics": {
        "doNotCallRate": 0.02
      },
      "costMetrics": {
        "totalCost": 245.5,
        "avgCostPerCall": 1.64
      }
    },
    "meta": {
      "calculatedAt": "2024-01-20T15:00:00Z",
      "isStale": false
    }
  }
}

GET /api/v1/campaigns/:id/analytics

curl -X GET "https://voice.evryhealth.com/api/v1/campaigns/:id/analytics" \
  -H "x-api-key: YOUR_API_KEY"

Response200

{
  "data": {
    "campaign": {
      "id": "357b188c-c618-4f95-84b1-cbe26b8ce3e0",
      "name": "Q1 Provider Outreach",
      "status": "active"
    },
    "metrics": {
      "callStats": {
        "totalCalls": 150,
        "completedCalls": 120,
        "failedCalls": 10,
        "cancelledCalls": 5,
        "pendingCalls": 15
      },
      "successMetrics": {
        "humanContactRate": 0.75,
        "objectiveSuccessRate": 0.68,
        "callbackRate": 0.12
      },
      "qualityMetrics": {
        "avgSentimentScore": 0.72,
        "avgCallDuration": 180
      },
      "complianceMetrics": {
        "doNotCallRate": 0.02
      },
      "costMetrics": {
        "totalCost": 245.5,
        "avgCostPerCall": 1.64
      }
    },
    "meta": {
      "calculatedAt": "2024-01-20T15:00:00Z",
      "isStale": false
    }
  }
}

Additional Endpoints

Get Analytics Summary

GET/api/v1/campaigns/{id}/analytics/summary

Get a quick KPI summary for a campaign. This is a lightweight endpoint optimized for dashboards.

// Response
{
  "data": {
    "totalCalls": 150,
    "completedCalls": 120,
    "humanContactRate": 0.75,
    "objectiveSuccessRate": 0.68,
    "avgSentimentScore": 0.72
  }
}

Get Realtime Analytics

GET/api/v1/campaigns/{id}/analytics/realtime

Get real-time metrics for an active campaign. Optimized for polling with sub-100ms response times.

// Response
{
  "data": {
    "activeCalls": 5,
    "queuedCalls": 25,
    "callsCompletedToday": 45,
    "currentCallRate": 12.5,
    "lastCallAt": "2024-01-20T14:58:30Z"
  }
}

This endpoint is optimized for frequent polling. We recommend polling every 5-10 seconds for real-time dashboards.

Get Inbound Analytics

GET/api/v1/campaigns/{id}/analytics/inbound

Get inbound-specific metrics for campaigns with direction set to inbound.

// Response
{
  "data": {
    "totalInboundCalls": 250,
    "answeredCalls": 230,
    "missedCalls": 20,
    "avgWaitTime": 12,
    "avgHandleTime": 180,
    "peakHour": "14:00",
    "callsByHour": {
      "09": 15,
      "10": 28,
      "11": 35,
      "12": 22,
      "13": 30,
      "14": 45,
      "15": 38,
      "16": 25,
      "17": 12
    }
  }
}

List Campaign Runs

GET/api/v1/campaigns/{id}/runs

Get a list of campaign runs. A run represents a period when the campaign was active.

// Response
{
  "data": {
    "runs": [
      {
        "id": "run_abc123",
        "startedAt": "2024-01-15T09:00:00Z",
        "endedAt": "2024-01-15T17:00:00Z",
        "totalCalls": 120,
        "completedCalls": 105
      },
      {
        "id": "run_def456",
        "startedAt": "2024-01-16T09:00:00Z",
        "endedAt": null,
        "totalCalls": 30,
        "completedCalls": 15
      }
    ]
  }
}

Get Run Analytics

GET/api/v1/campaigns/{id}/runs/{runId}/analytics

Get detailed analytics for a specific campaign run. Useful for comparing performance across different runs.

Get Analytics Overview

GET/api/v1/analytics/overview

Get aggregated analytics across all campaigns in your workspace.

// Response
{
  "data": {
    "totalCampaigns": 12,
    "activeCampaigns": 3,
    "totalCalls": 5420,
    "totalCallDuration": 892500,
    "avgHumanContactRate": 0.72,
    "avgObjectiveSuccessRate": 0.65,
    "topPerformingCampaign": {
      "id": "357b188c-c618-4f95-84b1-cbe26b8ce3e0",
      "name": "Q1 Provider Outreach",
      "objectiveSuccessRate": 0.82
    },
    "period": {
      "from": "2024-01-01",
      "to": "2024-01-20"
    }
  }
}

Metrics Reference

Category	Metrics
`callStats`	Total, completed, failed, cancelled, pending calls
`successMetrics`	Human contact rate, objective success rate, callback rate
`qualityMetrics`	Average sentiment score, average call duration
`complianceMetrics`	Do-not-call rate
`costMetrics`	Total cost, average cost per call