Get subsequence analytics
curl --request GET \
--url https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences', 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.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"subsequences": [
{
"entry_node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metrics": {
"enrollments_total": 123,
"enrollments_active": 123,
"enrollments_completed": 123,
"conversion_rate": 123,
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sent": 123,
"opened": 123,
"replied": 123,
"bounced": 123,
"label": "<string>"
}
]
},
"label": "<string>",
"trigger_type": "<string>",
"trigger_params": {}
}
],
"summary": {
"total_enrollments": 123,
"total_active": 123,
"overall_conversion_rate": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Analytics
Get subsequence analytics
Get per-branch analytics for a campaign
Returns enrollment, conversion and per-step email metrics for every subsequence branch on a campaign. A campaign with no branches returns empty lists and a zero summary rather than an error.
What comes back
Per branch (subsequences[]):
entry_node_id— the branch’s SUBSEQUENCE entry node. This is the valuePOST /campaigns/{id}/leads/move-to-subsequenceexpects astarget_subsequence_node_id.label,trigger_type,trigger_params— how the branch is entered.metrics.enrollments_total/_active/_completed— leads ever enrolled, currently in the branch, and finished with it.metrics.conversion_rate— replied / enrolled.metrics.steps[]— per-stepsent,opened,replied,bouncedkeyed bynode_id.
Plus a summary rolled up across all branches.
Example
import requests
campaign_id = "550e8400-e29b-41d4-a716-446655440000"
response = requests.get(
f"https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences",
headers={"X-API-Key": "your-api-key"}
)
print(response.json())
GET
/
api
/
public
/
v1
/
analytics
/
campaigns
/
{campaign_id}
/
subsequences
Get subsequence analytics
curl --request GET \
--url https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences', 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.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coldsend.pro/api/public/v1/analytics/campaigns/{campaign_id}/subsequences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"subsequences": [
{
"entry_node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metrics": {
"enrollments_total": 123,
"enrollments_active": 123,
"enrollments_completed": 123,
"conversion_rate": 123,
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sent": 123,
"opened": 123,
"replied": 123,
"bounced": 123,
"label": "<string>"
}
]
},
"label": "<string>",
"trigger_type": "<string>",
"trigger_params": {}
}
],
"summary": {
"total_enrollments": 123,
"total_active": 123,
"overall_conversion_rate": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API key with format cs_live_xxx
Path Parameters
Response
Subsequence analytics retrieved successfully
Was this page helpful?

