Skip to main content
GET
/
api
/
outreach-metrics
Get live outreach metrics per source
curl --request GET \
  --url https://your-instance.example.com/api/outreach-metrics \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
filterUserId
string

Admin-only. Target a specific user's configs, or 'all' for the whole organization.

​
preset
enum<string>

Named date range. Mutually exclusive with from/to.

Available options:
today,
week,
month,
allTime
​
from
string<date-time>

Inclusive lower bound on contact createdAt (ISO timestamp).

​
to
string<date-time>

Inclusive upper bound on contact createdAt (ISO timestamp).

Response

Metrics returned

​
success
boolean
required
​
data
object[]
required