curl --request GET \
--url https://your-instance.example.com/api/outreach-metrics \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/outreach-metrics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/outreach-metrics', 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://your-instance.example.com/api/outreach-metrics",
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://your-instance.example.com/api/outreach-metrics"
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://your-instance.example.com/api/outreach-metrics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/outreach-metrics")
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": [
{
"source": "Facebook Lead Ad",
"leads": 120,
"cost": 1500,
"costPerLead": 12.5,
"contactPercentage": 75,
"closePercentage": 18,
"stageDistribution": [
{
"stage": "Contacted",
"count": 60
}
],
"grossProfit": 4400,
"roi": 2.93
}
]
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}Get live outreach metrics per source
Returns live per-source metrics (leads, cost, costPerLead, contactPercentage, closePercentage, stageDistribution, grossProfit, roi) aggregated over the authenticated user’s active outreach configs. Admins can scope to another user via filterUserId, or pass filterUserId=all for an organization-wide view. Date range can be supplied as preset (today/week/month/allTime) or explicit from/to ISO timestamps. Responses are cached for 10 minutes per filter combination.
curl --request GET \
--url https://your-instance.example.com/api/outreach-metrics \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/outreach-metrics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/outreach-metrics', 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://your-instance.example.com/api/outreach-metrics",
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://your-instance.example.com/api/outreach-metrics"
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://your-instance.example.com/api/outreach-metrics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/outreach-metrics")
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": [
{
"source": "Facebook Lead Ad",
"leads": 120,
"cost": 1500,
"costPerLead": 12.5,
"contactPercentage": 75,
"closePercentage": 18,
"stageDistribution": [
{
"stage": "Contacted",
"count": 60
}
],
"grossProfit": 4400,
"roi": 2.93
}
]
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}{
"success": false,
"message": "Configuration is inactive and cannot process outreach requests"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Admin-only. Target a specific user's configs, or 'all' for the whole organization.
Named date range. Mutually exclusive with from/to.
today, week, month, allTime Inclusive lower bound on contact createdAt (ISO timestamp).
Inclusive upper bound on contact createdAt (ISO timestamp).