Get analytics summary

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/dashboard/analytics \
  --header 'Authorization: Bearer YOUR_API_KEY'

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

fetch('https://api.teamfollowup.ai/api/dashboard/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.teamfollowup.ai/api/dashboard/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.teamfollowup.ai/api/dashboard/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/dashboard/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

{
  "success": true,
  "data": {
    "totalLeads": 420,
    "totalCalls": 612,
    "totalAppointments": 48,
    "totalCallbacks": 31,
    "totalTransfers": 22,
    "attemptedTransfers": 28,
    "totalFailedTransfers": 6,
    "killSwitch": 3,
    "avgCallDuration": 92,
    "callsPerLead": 1.46,
    "bookingRate": 11.43,
    "appointmentConversionRate": 7.84,
    "pickupRate": 48.69,
    "conversationRate": 29.58,
    "conversationToPickupRate": 60.74,
    "transferRate": 6.67,
    "transferSuccessRate": 78.57,
    "cached": false,
    "queryTime": 42,
    "generatedAt": "2026-07-08T16:00:00.000Z"
  }
}

{
  "success": false,
  "error": "BadRequest",
  "message": "dateToUTC must be a valid ISO 8601 UTC date-time"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "InsufficientScope",
  "message": "This API key does not have the required scope.",
  "requiredScope": "dashboard:read"
}

{
  "success": false,
  "error": "TooManyRequests"
}

{
  "success": false,
  "error": "Unexpected server error."
}

GET

api

dashboard

analytics

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/dashboard/analytics \
  --header 'Authorization: Bearer YOUR_API_KEY'

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

fetch('https://api.teamfollowup.ai/api/dashboard/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.teamfollowup.ai/api/dashboard/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.teamfollowup.ai/api/dashboard/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/dashboard/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

{
  "success": true,
  "data": {
    "totalLeads": 420,
    "totalCalls": 612,
    "totalAppointments": 48,
    "totalCallbacks": 31,
    "totalTransfers": 22,
    "attemptedTransfers": 28,
    "totalFailedTransfers": 6,
    "killSwitch": 3,
    "avgCallDuration": 92,
    "callsPerLead": 1.46,
    "bookingRate": 11.43,
    "appointmentConversionRate": 7.84,
    "pickupRate": 48.69,
    "conversationRate": 29.58,
    "conversationToPickupRate": 60.74,
    "transferRate": 6.67,
    "transferSuccessRate": 78.57,
    "cached": false,
    "queryTime": 42,
    "generatedAt": "2026-07-08T16:00:00.000Z"
  }
}

{
  "success": false,
  "error": "BadRequest",
  "message": "dateToUTC must be a valid ISO 8601 UTC date-time"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "InsufficientScope",
  "message": "This API key does not have the required scope.",
  "requiredScope": "dashboard:read"
}

{
  "success": false,
  "error": "TooManyRequests"
}

{
  "success": false,
  "error": "Unexpected server error."
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

dateFromUTC

string<date-time>

Start of the reporting window as a UTC ISO timestamp.

dateToUTC

string<date-time>

End of the reporting window as a UTC ISO timestamp.

projectName

string

Optional project filter. Restricted to projects the caller can access.

Minimum string length: 1

campaignId

string

Restrict the summary to the leads one campaign dialled. Only V2 activity carries campaign attribution.

Minimum string length: 1

masterCampaignId

string

Restrict the summary to the leads an entire master campaign dialled, across every linked project the caller can see. A master campaign is fanned out into one child campaign per project, each with its own id, so filtering by a single campaignId returns one project's share of it. Mutually exclusive with campaignId: the two are contradictory scopes rather than narrowing ones, and sending both is a 400.

Minimum string length: 1

Response

Analytics summary metrics.

success

boolean

required

Example:

true

data

object

required

Minimal, non-billing performance summary. Counts plus derived rate percentages.

Show child attributes

Agents

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Authorizations

Query Parameters

Response