Get v1enrichmenthlranalytics

GET /v1/enrichment/hlr/analytics

cURL

cURL

curl --request GET \
  --url https://api.comm.com/api/v1/enrichment/hlr/analytics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.comm.com/api/v1/enrichment/hlr/analytics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.comm.com/api/v1/enrichment/hlr/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.comm.com/api/v1/enrichment/hlr/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comm.com/api/v1/enrichment/hlr/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.comm.com/api/v1/enrichment/hlr/analytics")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comm.com/api/v1/enrichment/hlr/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

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

overview · object · required

Show child attributes

retryAnalysis · object · required

Show child attributes

timeBasedMetrics · object · required

Show child attributes

carrierPerformance · object[] · required

Show child attributes

statusBreakdown · object[] · required

Show child attributes

retryPatterns · object[] · required

Show child attributes

costAnalysis · object · required

Show child attributes