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


List of campaigns is sorted by creation date, ascendingly.

Parameters

All parameters must be URL encoded.


Parameter

Value

limit

Limit number of records to return per request. If this parameter has not been provided or has value of 0, then limit is not applied and all records are returned.

page

Defines record set offset. Applies only if parameter limit has “truthy” value. Default value is 1.

status

Filter records by status. Possible values are - DRAFT, PENDING, COMPLETED. To apply multiple status filters include status parameter in URI as status[]=DRAFT&status[]=PENDING.

tags Filter records by tags. To apply multiple tag filters include tags parameter in URI as tags[]=Tag1&tags[]=Tag2.

sort_by

Field to sort loaded entries by. At the moment only created_at value is allowed, that will also be applied by default.

sort_order

Entries sorting direction. Possible values are: ASC -ascending order; DESC - descending order. By default entries will be sorted in ascending order.


Query results


Field

Value

id

Unique ID of campaign. Numeric.

name

Email subject.

template

Template used in the campaign. Value can be either an array or DELETED. Latter means that template has been deleted from the system.

 - id

Template ID.

- name Template name.

- preview_url

URL to template preview.

tags
Tags names.

created_at

Creation date. Formatted as YYYY-MM-DD HH:MM:SS.

completed_at

Completion date. This field has value only if campaign has COMPLETED status. Formatted as YYYY-MM-DD HH:MM:SS.

status

Status. Possible values: DRAFT; PENDING - sending still in progress; COMPLETED.