Sales Engine
API documentation
CampaignsOperation campaigns.analytics

Get campaign analytics

Campaign analytics: totals and rates, a by-day series, per-step results, bounces and unsubscribes.

GET/api/v1/campaigns/{id}/analytics
Scope read: Read anything in the workspace.

Parameters

Path

NameInDescription
idrequiredpathThe record's id.

Query

NameInDescription
rangequeryall, 7d, 30d or 90d.

Example

curl
curl -X GET "https://crm.ashwanth.dev/api/v1/campaigns/{id}/analytics" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine campaigns analytics <id>

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
required
The record's id.
Query
all, 7d, 30d or 90d.
Request
GET /api/v1/campaigns/%7Bid%7D/analytics
Fill the path first.

Also in Campaigns