Analytics

Retrieve campaign totals and engagement

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.

get/api/v1/analytics/campaigns

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/analytics/campaigns
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: analytics:read)

Query parameters

fromstring date-time nullable

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

tostring date-time nullable

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

Response

Campaign statistics

activeinteger required

Campaigns in DRAFT or SCHEDULED.

average_click_ratenumber required
average_open_ratenumber required

Percentage, one decimal place.

completedinteger required
totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.