GET

api

platform

organisation

analytics

Get Analytics

curl --request GET \
  --url https://unpod.ai/api/v2/platform/organisation/analytics/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/organisation/analytics/"

headers = {
    "Org-Handle": "<org-handle>",
    "Authorization": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};

fetch('https://unpod.ai/api/v2/platform/organisation/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://unpod.ai/api/v2/platform/organisation/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: <api-key>",
    "Org-Handle: <org-handle>"
  ],
]);

$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://unpod.ai/api/v2/platform/organisation/analytics/"

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

	req.Header.Add("Org-Handle", "<org-handle>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/organisation/analytics/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/organisation/analytics/")

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

request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'

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

{
  "status_code": 200,
  "message": "Analytics fetched successfully",
  "data": {
    "total_calls": 1250,
    "completed_calls": 987,
    "failed_calls": 143,
    "avg_duration_seconds": 145.3,
    "total_tasks": 1350,
    "task_status_breakdown": {
      "pending": 45,
      "running": 12,
      "completed": 1180,
      "failed": 113
    }
  }
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

{
  "status_code": 200,
  "message": "Analytics fetched successfully",
  "data": {
    "total_calls": 1250,
    "completed_calls": 987,
    "failed_calls": 143,
    "avg_duration_seconds": 145.3,
    "total_tasks": 1350,
    "task_status_breakdown": {
      "pending": 45,
      "running": 12,
      "completed": 1180,
      "failed": 113
    }
  }
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

Get Analytics

Retrieve call analytics and task status for your organization. Provides insights into call outcomes, success rates, average durations, and task execution summaries. Optionally filter by a specific space using the space_token query parameter.

Prerequisites: Make sure you have your API Token and Org-Handle ready. See Authentication for details.

Headers

Name	Type	Required	Description
Authorization	string	Yes	API Key format: `Token <token>`
Org-Handle	string	Yes	Organization domain handle

You can get the Org-Handle by hitting the Get All Organizations API. The domain_handle field in the response is your Org-Handle.

Query Parameters

Name	Type	Required	Description
space_token	string	No	Filter analytics for a specific space. If omitted, returns org-wide analytics

If space_token is provided, analytics are scoped to that space only. If not provided, analytics aggregate across all contact spaces in the organization.

Response Fields

Field	Type	Description
status_code	integer	HTTP status code
message	string	Response message
data	object	Analytics data

Analytics Data Fields

Field	Type	Description
total_calls	integer	Total number of calls made
completed_calls	integer	Number of successfully completed calls
failed_calls	integer	Number of failed calls
avg_duration_seconds	number	Average call duration in seconds
total_tasks	integer	Total number of tasks across all runs
task_status_breakdown	object	Breakdown of tasks by status

Task Status Breakdown Fields

Field	Type	Description
pending	integer	Number of tasks awaiting execution
running	integer	Number of tasks currently executing
completed	integer	Number of successfully completed tasks
failed	integer	Number of failed tasks

Common Error Codes

Status Code	Description
200	Success - Analytics fetched successfully
400	Bad Request - Missing required headers
401	Unauthorized - Invalid or missing API token
403	Forbidden - Invalid organization handle
404	Not Found - Organization not found
500	Internal Server Error - Server-side error

Code Examples

const axios = require('axios');

const headers = {
  'Authorization': 'Token your-api-token',
  'Org-Handle': 'your-org-handle'
};

// Get org-wide analytics
const getAnalytics = async (spaceToken = null) => {
  const params = spaceToken ? { space_token: spaceToken } : {};
  const response = await axios.get(
    'https://unpod.ai/api/v2/platform/organisation/analytics/',
    { headers, params }
  );
  const data = response.data.data;
  console.log(`Total calls: ${data.total_calls}`);
  console.log(`Completed: ${data.completed_calls}`);
  console.log(`Failed: ${data.failed_calls}`);
  console.log(`Avg duration: ${data.avg_duration_seconds}s`);
  return data;
};

// Get org-wide analytics
getAnalytics();

// Get analytics for a specific space
getAnalytics('8KZAMRAHSXXXXXXMAYNASMJC');

import requests

headers = {
    'Authorization': 'Token your-api-token',
    'Org-Handle': 'your-org-handle'
}

def get_analytics(space_token: str = None):
    """Get call analytics and task status"""
    url = 'https://unpod.ai/api/v2/platform/organisation/analytics/'
    params = {'space_token': space_token} if space_token else {}
    response = requests.get(url, headers=headers, params=params)
    data = response.json()['data']
    print(f"Total calls: {data['total_calls']}")
    print(f"Completed: {data['completed_calls']}")
    print(f"Failed: {data['failed_calls']}")
    print(f"Avg duration: {data['avg_duration_seconds']}s")
    return data

# Get org-wide analytics
get_analytics()

# Get analytics for a specific space
get_analytics('8KZAMRAHSXXXXXXMAYNASMJC')

# Get org-wide analytics
curl -X GET "https://unpod.ai/api/v2/platform/organisation/analytics/" \
  -H "Authorization: Token your-api-token" \
  -H "Org-Handle: your-org-handle"

# Get analytics for a specific space
curl -X GET "https://unpod.ai/api/v2/platform/organisation/analytics/?space_token=8KZAMRAHSXXXXXXMAYNASMJC" \
  -H "Authorization: Token your-api-token" \
  -H "Org-Handle: your-org-handle"

Best Practices

Space Scoping: Use the space_token filter to get analytics for individual campaigns or spaces
Success Rate: Calculate success rate as completed_calls / total_calls * 100 for performance tracking
Task Breakdown: Monitor task_status_breakdown to detect stuck or failed tasks requiring attention
Scheduled Reports: Call this endpoint on a schedule to build trend dashboards
Org-Handle: Ensure the correct organization handle is included for accurate scoping
Security: Keep API tokens secure and rotate them regularly

Authorizations

Authorization

string

header

required

Format: Token

Headers

Org-Handle

string

required

Organization domain handle

Example:

"unpod.tv"

Query Parameters

space_token

string

Example:

"8KZAMRAHSXXXXXXMAYNASMJC"

Response

Analytics data

OverviewIntroduction to the Bridges API

Get Analytics

curl --request GET \
  --url https://unpod.ai/api/v2/platform/organisation/analytics/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/organisation/analytics/"

headers = {
    "Org-Handle": "<org-handle>",
    "Authorization": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};

fetch('https://unpod.ai/api/v2/platform/organisation/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://unpod.ai/api/v2/platform/organisation/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: <api-key>",
    "Org-Handle: <org-handle>"
  ],
]);

$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://unpod.ai/api/v2/platform/organisation/analytics/"

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

	req.Header.Add("Org-Handle", "<org-handle>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/organisation/analytics/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/organisation/analytics/")

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

request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'

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

{
  "status_code": 200,
  "message": "Analytics fetched successfully",
  "data": {
    "total_calls": 1250,
    "completed_calls": 987,
    "failed_calls": 143,
    "avg_duration_seconds": 145.3,
    "total_tasks": 1350,
    "task_status_breakdown": {
      "pending": 45,
      "running": 12,
      "completed": 1180,
      "failed": 113
    }
  }
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

Getting Started

API Lists

Get Analytics

Get Analytics

Headers

Query Parameters

Response Fields

Analytics Data Fields

Task Status Breakdown Fields

Common Error Codes

Code Examples

Best Practices

Authorizations

Headers

Query Parameters

Response

​Get Analytics

​Headers

​Query Parameters

​Response Fields

​Analytics Data Fields

​Task Status Breakdown Fields

​Common Error Codes

​Code Examples

​Best Practices

Authorizations

Headers

Query Parameters

Response

Get Analytics

Headers

Query Parameters

Response Fields

Analytics Data Fields

Task Status Breakdown Fields

Common Error Codes

Code Examples

Best Practices