GET
/
v1
/
enrichment
/
hlr
/
analytics
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/enrichment/hlr/analytics \
  --header 'Authorization: Bearer <token>'
{
  "overview": {
    "totalRequests": 123,
    "successfulRequests": 123,
    "failedRequests": 123,
    "successRate": 123,
    "averageResponseTime": 123,
    "totalCost": 123
  },
  "retryAnalysis": {
    "totalRetriedCalls": 123,
    "retriesSuccessful": 123,
    "retrySuccessRate": 123,
    "averageRetriesPerCall": 123,
    "maxRetries": 123,
    "costOfRetries": 123
  },
  "timeBasedMetrics": {
    "peakHours": [
      "<string>"
    ],
    "averageRetryDelay": 123,
    "fastestRetrySuccess": 123,
    "slowestRetrySuccess": 123
  },
  "carrierPerformance": [
    {
      "carrier": "<string>",
      "requests": 123,
      "successRate": 123,
      "avgResponseTime": 123
    }
  ],
  "statusBreakdown": [
    {
      "status": "<string>",
      "count": 123,
      "percentage": 123,
      "color": "<string>"
    }
  ],
  "retryPatterns": [
    {
      "retryAttempt": 123,
      "successRate": 123,
      "count": 123
    }
  ],
  "costAnalysis": {
    "costPerRequest": 123,
    "costPerRetry": 123,
    "totalSavings": 123,
    "roiPercentage": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

campaign_id
string<uuid> | null
team_id
string<uuid> | null
campaign_send_id
string<uuid> | null
object_type
enum<string> | null
Available options:
call,
sms
start_date
string | null
end_date
string | null

Response

200
application/json

The response is of type object.