Skip to content
Salvo

Examples use fictional data. Every company, person, address and count in them is invented, and their domains use the reserved .example TLD.

Platform

Analytics

Totals, a daily series and a per-campaign breakdown, in the shape a dashboard actually wants.

2 endpoints

GET/v1/analytics/overview

Workspace overview

Everything across every campaign in the window: totals, one row per day, per-campaign stats and the segments replying best.

API key or sessionFree

Query parameters

FieldTypeDescription
daysnumberLength of the window in days. Default 30, maximum 365.
curl "https://beamro.com/api/v1/analytics/overview?days=30" \
  -H "x-api-key: $SALVO_API_KEY"
200 response
{
  "range": {
    "from": "2026-08-01T00:00:00.000Z",
    "to": "2026-08-31T00:00:00.000Z"
  },
  "totals": {
    "leads": 1840,
    "queued": 402,
    "sent": 1438,
    "delivered": 1398,
    "opened": 641,
    "replied": 96,
    "interested": 34,
    "meetings": 14,
    "bounced": 40,
    "unsubscribed": 8,
    "spend_cents": 4314,
    "cost_per_lead_cents": 127
  },
  "series": [
    {
      "date": "2026-08-29",
      "sent": 118,
      "replied": 9,
      "meetings": 2,
      "spend_cents": 354
    },
    {
      "date": "2026-08-30",
      "sent": 122,
      "replied": 7,
      "meetings": 1,
      "spend_cents": 366
    },
    {
      "date": "2026-08-31",
      "sent": 96,
      "replied": 11,
      "meetings": 3,
      "spend_cents": 288
    }
  ],
  "by_campaign": [
    {
      "id": "cmp_1t7k4v9m2q0b6x3n8w",
      "name": "New England venues · autumn",
      "status": "running",
      "stats": {
        "leads": 1840,
        "queued": 402,
        "sent": 1438,
        "delivered": 1398,
        "opened": 641,
        "replied": 96,
        "interested": 34,
        "meetings": 14,
        "bounced": 40,
        "unsubscribed": 8,
        "spend_cents": 4314,
        "cost_per_lead_cents": 127
      }
    }
  ],
  "top_segments": [
    {
      "label": "Event venues",
      "replies": 58,
      "reply_rate": 7.4
    },
    {
      "label": "Wedding planners",
      "replies": 24,
      "reply_rate": 5.1
    }
  ]
}
GET/v1/analytics/campaigns/{campaign_id}

Campaign analytics

The same envelope narrowed to one campaign, so a single component renders both views.

API key or sessionFree

Path parameters

FieldTypeDescription
campaign_idreqstringCampaign identifier.

Query parameters

FieldTypeDescription
daysnumberLength of the window in days. Default 30.
curl "https://beamro.com/api/v1/analytics/campaigns/cmp_1t7k4v9m2q0b6x3n8w?days=30" \
  -H "x-api-key: $SALVO_API_KEY"
200 response
{
  "range": {
    "from": "2026-08-01T00:00:00.000Z",
    "to": "2026-08-31T00:00:00.000Z"
  },
  "totals": {
    "leads": 1840,
    "queued": 402,
    "sent": 1438,
    "delivered": 1398,
    "opened": 641,
    "replied": 96,
    "interested": 34,
    "meetings": 14,
    "bounced": 40,
    "unsubscribed": 8,
    "spend_cents": 4314,
    "cost_per_lead_cents": 127
  },
  "series": [
    {
      "date": "2026-08-31",
      "sent": 96,
      "replied": 11,
      "meetings": 3,
      "spend_cents": 288
    }
  ],
  "by_campaign": [
    {
      "id": "cmp_1t7k4v9m2q0b6x3n8w",
      "name": "New England venues · autumn",
      "status": "running",
      "stats": {
        "leads": 1840,
        "queued": 402,
        "sent": 1438,
        "delivered": 1398,
        "opened": 641,
        "replied": 96,
        "interested": 34,
        "meetings": 14,
        "bounced": 40,
        "unsubscribed": 8,
        "spend_cents": 4314,
        "cost_per_lead_cents": 127
      }
    }
  ],
  "top_segments": [
    {
      "label": "Event venues",
      "replies": 58,
      "reply_rate": 7.4
    }
  ]
}