Skip to content

Analytics and export ​

Two read-only tools answer reporting questions: how your campaigns and automations performed, and what an account sent on a given day.

Every tool also takes the optional account_id (see Accounts). It is left out of the tables below.

Time zone

Dates are whole days in Swedish time (Europe/Stockholm), whatever your own time zone is.

get-analytics ​

Shows results such as sent, opened, clicked and unsubscribed for campaigns or automations over a date range.

ParameterTypeRequiredDescription
object_typecampaign or automationYesWhat the ids are.
idsarray of numbersYesUp to 50 campaign or automation ids.
date_fromdate (YYYY-MM-DD)YesFirst day, included.
date_todate (YYYY-MM-DD)YesLast day, included.
metricsarrayNoWhich numbers to return. See below.
message_typeemail, text_message or rcsNoEmail, SMS or RCS. Found automatically if left out.

Metrics ​

Returned by default:

MetricMeaning
sent, deliveredEmails sent and delivered
open_uniq, click_uniqSubscribers who opened or clicked at least once
ctrClick rate, in percent
ctorClicks per open, in percent
unsubscribeUnsubscribes
total_bounceBounces
spamSpam complaints

Also available on request: open, click (counting every open and click), ror, soft_bounce, hard_bounce, unsubscribe_rate (percent), browser and browser_uniq.

Good to know ​

  • One total per campaign or automation for the whole range. It is not split by day, and the totals of several ids are not added up (subscribers who opened two campaigns would be counted twice). To compare periods, ask for each period separately.
  • Zero can mean "not found". An id with no data, or from another account, returns zeros. If the numbers look wrong, check which account was used.
  • One channel at a time. Email, SMS and RCS cannot be mixed in one request. Open and browser numbers do not apply to SMS, and browser numbers do not apply to RCS; the assistant tells you.
  • Very large requests can time out. Try a shorter range, fewer ids or fewer metrics.
  • A/B tests, journeys and transactional sends are not covered.

Try asking: "How did campaigns 1201 and 1202 perform in October? Show opens, clicks and unsubscribes."

export-dispatchers ​

Lists everything an account sent on one day, campaigns and automations together, with their tags, filters and tracking values. It returns no subscriber data and no results; use get-analytics for results.

ParameterTypeRequiredDescription
datedate (YYYY-MM-DD)YesThe day, in Swedish time.

What each row means depends on its dispatcher_type:

TypeOne row perTime shown
automail (automation)Email sent. Two identical rows are two sends.When it was sent, in UTC
sendout (journey)Send-outIts first send of the day, in UTC
campaignSent campaignWhen the campaign was created and last saved, in Swedish time. Not when it was sent.
transactionalTransactional senderWhen it was created and last saved, in Swedish time. Not when it was sent.

Good to know ​

  • One day per request. For several days, ask for each day.
  • The rows are not in sending order, because the times mix UTC and Swedish time.
  • Busy days can be too large. Results are not split into pages, and AI clients limit how much a tool can return. A very busy day can be too large: it is then refused with the number of rows, rather than returned incomplete. How many sends fit depends on how much each row contains (for example, how many tags and filters). Check such a day in Rule.
  • Only the account itself is included, not its sub-accounts.

Try asking: "What did we send on 26 October?"