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


Parameters

All parameters must be URL encoded.



 

Parameter

Value

start_at

History range start date. Required. Value has to be in UNIX timestamp.

end_at

History range end date. Required. Value has to be in UNIX timestamp, must not be less than start_at value.

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, no limit will be applied. Value cap is set at 10000. If a larger value is specified, no error will be given.

Response data

Response is returned as array of contacts’ actions that contains entries with following structure. Entries are sorted by time field in ascending order.



 

Field

Value

email

Contact’s email address.

time

Action date and time.

campaign_id

Campaign ID.

campaign_name

Campaign name.

value

Additional information about the action.

action

Action type. Possible values are - optinmodifyviewsendclickoptoutcomplaintbounce.


Example query:


Updating several subscribers at once


Query to update tugi@smaily.com and add info@smaily.com.

  

$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<subdomain>.sendsmaily.net/api/contact.php';
$query = array(
  array(
    'email' => 'tugi@smaily.com',
    'is_unsubscribed' => 1,
  ),
  array(
    'email' => 'info@smaily.com',
    'is_unsubscribed' => 0,
    'kuuluvus_1' => 'ei',
  ),
);

// Query ($query) should be posted as following.
// In our example it will be taken care of by “http_build_query” function.
// 0%5Bemail%5D=tugi%40smaily.com&0%5Bunsubscribed%5D=1&1%5Bemail%5D=info%40smaily.com&1%5Bunsubscribed%5D=0&1%5Bkuuluvus_1%5D=ei

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $location);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($query));
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");

$result = curl_exec($ch);
curl_close($ch);

 

Result for a successful query:

 

{
  'code': 101,
  'message': 'OK'
}

 

See also other possible results from Possible results.


Action types



   

Action

Description

bounce
Delivery to contact's email address failed. Field value contains the SMTP response code received. The most common response codes

click

Contact clicked on a link. Field value contains URL of the link.

complaint

Contact reported email as spam.

modify

Contact’s data was changed. Field value contains new values of contact’s extra data.

optin

Contact was added to Smaily database.

optout

Contact unsubscribed.

send

Contact received an email.

view

Contact viewed/opened an email. Field value contains information about contact’s OS, email client, IP-address and country.