Outreach Metrics

Get live outreach metrics per source

GET
/api/outreach-metrics

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.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

filterUserId?string

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

preset?string

Named date range. Mutually exclusive with from/to.

Value in

  • "today"
  • "week"
  • "month"
  • "allTime"
from?string

Inclusive lower bound on contact createdAt (ISO timestamp).

Formatdate-time
to?string

Inclusive upper bound on contact createdAt (ISO timestamp).

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/outreach-metrics"
{  "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    }  ]}