Skip to main content
GET
AhaSend Go SDK
The AhaSend API returns the numbers of a campaign, the same numbers as the campaign report in the dashboard. Access requires campaigns:read. Live counters: recipients, delivered, opens, clicks, unsubscribes and complaints are live. Opens and clicks do not include bots. Stored report:
  • report holds the numbers counted from the recipients of the campaign: openers, clickers, bounces, deferrals, recipients by status and bounces by bounce classification. report.computed_at is the time of the count.
  • The report is counted again from time to time. When a request finds the report missing or old, it asks for a new count and answers the stored report. Read the stats again later to get the new numbers.
  • report is null until the first count.
  • recount_failed is true while the last count failed, so report can be old.
Rates: rates gives percentages from 0 to 100 with two decimals. open_rate and click_rate use delivered as the base. bounce_rate and deferral_rate use report.recipients as the base. A rate is null while report is null or its base is zero. To list the recipients behind a number in report.by_status or report.by_bounce_classification, use List Campaign Recipients.

Authorizations

Authorization
string
header
required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

Path Parameters

account_id
string<uuid>
required

Account ID

campaign_id
string<uuid>
required

Campaign ID

Response

Campaign stats

The numbers of a campaign. The counters are live; report is the stored report, which is recounted from time to time. A request never counts: when the report is missing or old, it asks for a recount and answers what is stored, so read again later for the new numbers.

object
enum<string>
required

Object type identifier

Available options:
campaign_stats
campaign_id
string<uuid>
required

Campaign ID

recipients
integer
required

Recipients the campaign sends to

delivered
integer
required

Messages delivered

opens
integer
required

Opens, without bots

clicks
integer
required

Clicks, without bots

unsubscribes
integer
required

Recipients who unsubscribed

complaints
integer
required

Recipients who marked the message as spam

report
object | null
required

The stored report. Null until the campaign's first recount.

rates
object
required

Percentages from 0 to 100 with two decimals. Each is null while report is null or its base is zero.

recount_failed
boolean
required

True while the last recount of the report failed, so report may be old.