https://<subdomain>.sendsmaily.net/api/campaign.php


Parameters

All parameters must be URL encoded.



 

Parameter

Value

id

Unique ID of campaign, which is returned on launch. Can be found in Campaing list. Required.

detailed

Include detailed opens/clicks statistics per contact with response. Possible values: 0 - not included; 1 - detailed statistics is included.

offset So-called “page” number, which begins at 0. 0 gives contacts from 0 to 10000. 1 gives 10001 to 20000 etc. If not specified, 0 will be set.
limit Number of subscribers on one “page”. If not specified, 10000 will be set, which is also the maximum value. If set as more than 10000, no error will be given, but the value will be defaulted back to 10000.

Note! Parameters offset and limit are only applied when detailed parameter has value of 1.


Query results

 

Field

Value

name

Email subject.

total_count

Subscriber count.

delivered_count

Successfully delivered count.

click_count

Total number of link clicks.

unique_click_count

Number of unique link clicks. Number of subscribers who have done at least one click.

click_percent

Number of unique clicks divided with total number of link clicks.

view_count

Total number of image views.

unique_view_count

Number of unique image views. Number of subscribers who have viewed images at least once.

view_percent

Number of unique image views divided by total number of image views.

opened_count

Unique opens. Number of subscribers who have at least once either viewed images or clicked on links.

opened_percent

Number of unique opens divided by number of successfully delivered emails, presented as percentage.

addresses

Array of per subscriber detailed statistics. Added only when request parameter detailed value is 1.

 - email

Contact’s email address.

 - sent_at

Delivery date and time. Formatted as YYYY-MM-DD HH:MM:SS.

 - opens

Number of opens. Value includes clicks.

 - clicks

Number of links clicked.

 - links

Array of links clicked.

 - href

Link’s URL in the template.

 - visit_at

Date and time of the first click on this link. Formatted as YYYY-MM-DD HH:MM:SS.

 - count

Number of times clicked on this link