Skip to Content
SendlySendly
API ReferenceAnalytics

Retrieve campaign totals and engagement

GET
/api/v1/analytics/campaigns

Campaign counts plus average open and click rates.

total and active count campaigns CREATED in the window; completed counts campaigns SENT in it — so a campaign created earlier and sent inside the window appears only in completed. Rates are percentages to one decimal place, averaged over the campaigns sent in the window.

from defaults to 30 days ago and is clamped to at most 90 days back; to defaults to now. A wider request is narrowed rather than refused, and the window field states the range actually covered — read it before comparing two responses.

Requires the analytics:read scope — View your sending analytics and engagement metrics.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

from?|

Start of the window (ISO 8601). Defaults to 30 days ago; clamped to at most 90 days back.

Formatdate-time
to?|

End of the window (ISO 8601). Defaults to now.

Formatdate-time

Response Body

Campaign statistics

application/json
  1. response

Campaign counters and engagement over the window.

total*integer
active*integer

Campaigns in DRAFT or SCHEDULED.

completed*integer
average_open_rate*number

Percentage, one decimal place.

average_click_rate*number
window*

The time range this response was computed over, after the 90-day clamp.

Example Request
curl -X GET 'https://api.sendly.now/api/v1/analytics/campaigns'
Example Response
{  "total": 0,  "active": 0,  "completed": 0,  "average_open_rate": 0,  "average_click_rate": 0,  "window": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z"  }}