Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
stats
Get Campaign Stats
curl --request GET \
  --url https://api.example.com/api/v1/campaigns/{campaign_id}/stats \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/campaigns/{campaign_id}/stats"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/stats', 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.example.com/api/v1/campaigns/{campaign_id}/stats",
  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.example.com/api/v1/campaigns/{campaign_id}/stats"

	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.example.com/api/v1/campaigns/{campaign_id}/stats")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/stats")

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
{
  "total_leads": 0,
  "total_steps": 0,
  "campaign_status": "",
  "replied": 0,
  "bounced": 0,
  "unsubscribed": 0,
  "emails_sent": 0,
  "deduped_emails_sent": 0,
  "emails_delivered": 0,
  "emails_bounced": 0,
  "emails_complained": 0,
  "total_clicks": 0,
  "clicked_count": 0,
  "total_opens": 0,
  "opened_count": 0,
  "open_rate": "0.0",
  "click_rate": "0.0",
  "reply_rate": "0.0",
  "bounce_rate": "0.0",
  "delivery_rate": "0.0",
  "processed_leads": 0,
  "progress_percentage": 0,
  "linkedin_requests_sent": 0,
  "linkedin_accepted": 0,
  "linkedin_acceptance_rate": "0.0",
  "linkedin_replied": 0
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

campaign_id
string<uuid>
required

Response

Successful Response

Response model for single campaign stats (detail page).

total_leads
integer
default:0
total_steps
integer
default:0
campaign_status
string
default:""
replied
integer
default:0
bounced
integer
default:0
unsubscribed
integer
default:0
emails_sent
integer
default:0
deduped_emails_sent
integer
default:0
emails_delivered
integer
default:0
emails_bounced
integer
default:0
emails_complained
integer
default:0
total_clicks
integer
default:0
clicked_count
integer
default:0
total_opens
integer
default:0
opened_count
integer
default:0
open_rate
string
default:0.0
click_rate
string
default:0.0
reply_rate
string
default:0.0
bounce_rate
string
default:0.0
delivery_rate
string
default:0.0
processed_leads
integer
default:0
progress_percentage
integer
default:0
linkedin_requests_sent
integer
default:0
linkedin_accepted
integer
default:0
linkedin_acceptance_rate
string
default:0.0
linkedin_replied
integer
default:0