Version 1.1

deprecated

Standard Campaigns


List of campaigns in client's profile


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
count 100 100 Record Limit query integer
offset 0 0 Record Offset query integer
status 1 all Campaign Status query reference: (campaign_status)
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/?count=100&offset=1&status=1
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
html_content boolean html_content
status integer(3) campaign_status Campaign Status
create_time ISO8601 Time of creation
source integer(3) campaign_source Source
title string(100) Campaign Title
send_from ISO8601 Send From
send_to ISO8601 Send To
statistics array Statistics
statistics: subscribers integer Subscribers Count
statistics: sent integer Count of Sent Emails
statistics: opens integer Count of Opens
statistics: opens_unique integer Count Opens Unique
statistics: clicks integer Count of Clicks
statistics: clicks_unique integer Count of Clicks Unique
statistics: undelivered integer Count of Undelivered
statistics: unsubscribed integer Count of Unsubscribed
statistics: spam integer Count of Spam
statistics: domain integer Count of Domains
statistics: external_url string External Link
statistics: external_date ISO8601 Date of External Validity
statistics: click_rate float Click-through Rate (%)
statistics: open_rate float Open Rate (%)
settings array Settings
settings: subject string(100) Subject
settings: sender_email string(100) Sender Email
settings: sender_name string(100) Sender Name
settings: folder_id integer Folder ID
settings: plan_time ISO8601 Scheduled Time
lists array Distribution Lists
lists: list_id string(38) List ID
lists: name string(100) Name
lists: subscribers integer Subscribers Count
Response Messages:
Code Status Example Body
200 OK
[
    {
        "campaign_id": "c7e685c3-9b44-2675-31ff-a4aa2e94586d",
        "html_content": true,
        "status": 1,
        "create_time": "2016-05-26T15:23:13+02:00",
        "source": 2,
        "title": "My Campaign",
        "send_from": null,
        "send_to": null,
        "statistics": [],
        "settings": {
            "subject": "My Campaign",
            "sender_email": "my.company@example.com",
            "sender_name": "My Company",
            "folder_id": "root",
            "plan_time": null
        },
        "lists": [
            {
                "list_id": "cec10bc4-6ddb-11e5-b85d-08002789d050",
                "name": "My List",
                "subscribers": 0
            }
        ]
    },
    {
        "campaign_id": "6c54aff6-e777-3aea-97e8-ca4df3de1dfb",
        "html_content": true,
        "status": 1,
        "create_time": "2016-05-30T12:40:05+02:00",
        "source": 2,
        "title": "My Second Campaign",
        "send_from": null,
        "send_to": null,
        "statistics": {
            "subscribers": 46440,
            "sent": 46439,
            "opens": 1966,
            "opens_unique": 1539,
            "clicks": 1043,
            "clicks_unique": 744,
            "undelivered": 0,
            "unsubscribed": 0,
            "spam": 0,
            "domain": 12,
            "external_date": null,
            "external_url": null,
            "click_rate": 0,
            "open_rate": 3.31
        },
        "settings": {
            "subject": "My Second Campaign",
            "sender_email": "my.company@example.com",
            "sender_name": "My Company",
            "folder_id": "root",
            "plan_time": null
        },
        "lists": [
            {
                "list_id": "cec10bc4-6ddb-11e5-b85d-08002789d050",
                "name": "My List",
                "subscribers": 0
            }
        ]
    }
]

Detail of standard campaigns


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
html_content boolean HTML Content
status integer(3) campaign_status Campaign Status
create_time ISO8601 Create Time
source integer(3) campaign_source Source
title string(100) Campaign Title
send_from ISO8601 Send From
send_to ISO8601 Send To
statistics array Statistics
statistics: subscribers integer Count of Subscribers
statistics: sent integer Count of Sent Emails
statistics: opens integer Count of Opens
statistics: opens_unique integer Count Opens Unique
statistics: clicks integer Count of Clicks
statistics: clicks_unique integer Count of Clicks Unique
statistics: undelivered integer Count of Undelivered
statistics: unsubscribed integer Count of Unsubscribed
statistics: spam integer Count of Spam
statistics: domain integer Count of Domains
statistics: external_url string External Link
statistics: external_date ISO8601 Date of External Validity
statistics: click_rate float Click-through Rate (%)
statistics: open_rate float Open Rate (%)
settings array Settings
settings: subject string(100) Subject
settings: sender_email string(100) Sender Email
settings: sender_name string(100) Sender Name
settings: folder_id integer Folder ID
settings: plan_time ISO8601 Scheduled Time
lists array Distribution Lists
lists: list_id string(38) List ID
lists: name string(100) Name
lists: subscribers integer Count of Subscribers
content string Content Body
Response Messages:
Code Status Example Body
200 OK
{
    "campaign_id": "b7aec503-55dd-3bfb-507a-3b105a5574ac",
    "html_content": true,
    "status": 6,
    "create_time": "2014-06-12T17:55:42+02:00",
    "source": 1,
    "title": "My Campaign",
    "send_from": "2014-06-12T19:34:27+02:00",
    "send_to": "2014-06-12T19:35:06+02:00",
    "statistics": {
        "subscribers": 179,
        "sent": 179,
        "opens": 12,
        "opens_unique": 11,
        "clicks": 4,
        "clicks_unique": 3,
        "undelivered": 0,
        "unsubscribed": 0,
        "spam": 0,
        "domain": 1,
        "external_date": "2016-07-01T00:00:00+02:00",
        "external_url": "http:\/\/app.clevermonitor.com\/public\/campaign\/stats\/8cb3957e822ab6587a30ff4ab93bde1b",
        "click_rate": 0.2,
        "open_rate": 6.15
    },
    "settings": {
        "subject": "My Campaign",
        "sender_email": null,
        "sender_name": null,
        "folder_id": "root",
        "plan_time": "2014-06-12T19:34:27+02:00"
    },
    "lists": [],
    "content": "Any Content [[date-now]]"
}

Subscribers in a standard campaign

Overview of list of subscribers in a standard campaign.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
count 100 100 Record Limit query integer
offset 0 0 Record Offset query integer
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/subscribers?count=100&offset=0
Response Parameters:
Name Data Type Reference Description
email_id string(38) Email ID
email string(100) Email address
first_name string(100) First Name
last_name string(100) Last Name
Response Messages:
Code Status Example Body
200 OK
[
    {
        "email_id": "b1ea68e3-6b91-92c0-e831-a519faaddfe6",
        "email": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe"
    }
]

Statistics for a standard campaign


Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/statistics
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
subscribers integer Count of Subscribers
sent integer Count of Sent Emails
opens integer Count of Opens
opens_unique integer Count of Opens Unique
clicks integer Count of Clicks
clicks_unique integer Count of Clicks Unique
undelivered integer Count of Undelivered
unsubscribed integer Count of Unsubscribed
spam integer Count of Spam
domain integer Count of Domains
external_url string External Link
external_date ISO8601 External Validity Date
click_rate float Click-through Rate (%)
open_rate float Open Rate (%)
Response Messages:
Code Status Example Body
200 OK
{
    "subscribers": 179,
    "sent": 179,
    "opens": 12,
    "opens_unique": 11,
    "clicks": 4,
    "clicks_unique": 3,
    "undelivered": 0,
    "unsubscribed": 0,
    "spam": 0,
    "domain": 1,
    "external_date": "2016-07-01T00:00:00+02:00",
    "external_url": "http:\/\/app.clevermonitor.com\/www\/public\/campaign\/stats\/8cb3957e822ab6587a30ff4ab93bde1b",
    "click_rate": 0.2,
    "open_rate": 6.15,
    "campaign_id": "b7aec503-55dd-3bfb-507a-3b105a5574ac"
}

External Statistics

Create third-party access to the statistics of a standard campaign


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
external_date 2016-05-18T12:50:57+02:00 NOW + 1 month Validity Date body ISO8601
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/statistics/external
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
external_url string External URL
external_date ISO8601 External Date
Response Messages:
Code Status Example Body
200 OK
{
    "campaign_id": "b7aec503-55dd-3bfb-507a-3b105a5574ac",
    "external_url": "http:\/\/app.clevermonitor.com\/public\/campaign\/stats\/8cb3957e822ab6587a30ff4ab93bde1b",
    "external_date": "2016-07-01T10:07:13+02:00"
}

Content Body

Get a content of a standard campaign


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/content
Response Parameters:
Name Data Type Reference Description
body string Campaign Body
Response Messages:
Code Status Example Body
200 OK
{
    "body": "<html><body><h1>Your Campaign<\/h1><\/body><\/html>"
}

Delete


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "campaign_id": "e84deca4-03d5-b02d-bf56-a5afd299c25a",
    "message": "Campaign has been deleted!"
}

Send


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
plan_time 2016-05-18T12:50:57+02:00 NOW Scheduled Time body ISO8601
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/send
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
plan_time ISO8601 Scheduled Time
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "campaign_id": "377f1c53-2ec2-d650-538c-90d324901260",
    "plan_time": "2016-05-26T15:16:15+02:00",
    "message": "Campaign has been send!"
}

Send Testing Email


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
email john.doe@example.com null Email address body string
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/test
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
email string Email
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "id": "c7e685c3-9b44-2675-31ff-a4aa2e94586d",
    "email": "john.doe@clevermonitor.com",
    "message": "Test email was sent"
}

Cancel Sending

Cancellation of a selected campaign in a progress of sending


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777/stop
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "campaign_id": "377f1c53-2ec2-d650-538c-90d324901260",
    "message": "Campaign has been canceled!"
}

Create a New Campaign


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
title My Campaign null Tite body string(100)
html_content true true HTML Content body boolean
settings empty Settings body array
settings: subject My Campaign null Subject body string(200)
settings: sender_mail john.doe@example.com null Sender Email body string(100)
settings: sender_name John Doe null Sender Name body string(100)
settings: folder_id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Folder ID body string(38)
lists empty Lists body array
lists: list_id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Sender Name body string(38)
subscribers empty Subscribers body array
subscribers: email_id / email e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Email or Email ID body string(100)
content <html></html> null Content Body body string
Request Example:
{
    "title": "My Campaign",
    "html_content": true,
    "settings": {
        "subject": "My Campaign",
        "sender_email": "john.doe@example.com",
        "sender_name": "John Doe",
        "folder_id": "root"
    },
    "content": "<html><\/html>",
    "lists": [
        "cec10bc4-6ddb-11e5-b85d-08002789d050"
    ],
    "subscribers": [
        "b64752a6-1a34-6548-0db7-3f3faf34916b",
        "mike.johnson@example.com"
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
html_content boolean HTML Content
status integer(3) campaign_status Campaign Status
create_time ISO8601 Time of Creation
source integer(3) campaign_source Source
title string(100) Campaign Title
send_from ISO8601 Send From
send_to ISO8601 Send To
settings array Settings
settings: subject array Subject
settings: subject: subject string(100) Subject
settings: subject: record_status integer record_status Record_status
settings: sender array Sender
settings: sender: email string(100) Sender Email
settings: sender: name string(100) Sender Name
settings: sender: record_status integer record_status Record_status
settings: folder array Folder
settings: folder: folder_id integer Folder ID
settings: folder: record_status integer record_status Record_status
settings: plan_time ISO8601 Scheduled Time
lists array Distribution Lists
lists: list_id string(38) List ID
lists: record_status integer(3) record_status Body
subscribers array Subscribers
subscribers: email_id string(38) Email ID
subscribers: email string(100) Email address
subscribers: record_status integer(3) record_status Body
content array Content
content: body string Body
content: record_status integer(3) record_status Record Status
Response Messages:
Code Status Example Body
201 OK
{
    "settings": {
        "folder": {
            "folder_id": "root",
            "record_status": 200
        },
        "subject": {
            "subject": "My Campaign",
            "record_status": 200
        },
        "sender": {
            "email": "john.doe@example.com",
            "name": null,
            "record_status": 402
        }
    },
    "campaign_id": "209877f9-1d26-aa45-3d96-85d75b0f22a3",
    "html_content": true,
    "status": 1,
    "create_time": "2016-05-31T14:35:39+02:00",
    "source": 2,
    "title": "My Campaign",
    "content": {
        "body": "<html><\/html>",
        "record_status": 200
    },
    "lists": [
        {
            "list_id": "cec10bc4-6ddb-11e5-b85d-08002789d050",
            "record_status": 200
        }
    ],
    "subscribers": [
        {
            "email_id": "b64752a6-1a34-6548-0db7-3f3faf34916b",
            "email": "mike.johnson@example.com",
            "record_status": 200
        },
        {
            "email_id": "b64752a6-1a34-6548-0db7-3f3faf34916b",
            "email": "mike.johnson@example.com",
            "record_status": 202
        }
    ]
}

Update


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Campaign ID path string(38)
title My Campaign Tite body string(100) NOT NULL
html_content true true HTML Content? body boolean
settings empty Settings body array
settings: subject My Campaign null Subject body string(200)
settings: sender_mail john.doe@example.com null Sender Email body string(100)
settings: sender_name John Doe null Sender Name body string(100)
settings: folder_id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Folder ID body string(38)
lists empty Lists body array
lists: list_id e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Sender Name body string(38)
subscribers empty Subscribers body array
subscribers: email_id / email e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 null Email or Email ID body string(100)
content <html></html> null Content Body body string
Request Example:
{
    "title": "My Campaign",
    "html_content": true,
    "settings": {
        "subject": "My Campaign",
        "sender_email": "john.doe@example.com",
        "sender_name": "John Doe",
        "folder_id": "root"
    },
    "content": "<html><\/html>",
    "lists": [
        "cec10bc4-6ddb-11e5-b85d-08002789d050"
    ],
    "subscribers": [
        "b64752a6-1a34-6548-0db7-3f3faf34916b",
        "mike.johnson@example.com"
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/campaigns/standard/e77ced3a-89f2-2cf4-bf1f-42c5d49ed777
Response Parameters:
Name Data Type Reference Description
campaign_id string(38) Campaign ID
html_content boolean HTML Content
status integer(3) campaign_status Campaign Status
create_time ISO8601 Time of Creation
source integer(3) campaign_source Source
title string(100) Campaign Title
send_from ISO8601 Send From
send_to ISO8601 Send To
settings array Settings
settings: subject array Subject
settings: subject: subject string(100) Subject
settings: subject: record_status integer record_status Record status
settings: sender array Sender
settings: sender: email string(100) Sender Email
settings: sender: name string(100) Sender Name
settings: sender: record_status integer record_status Record status
settings: folder array Folder
settings: folder: folder_id integer Folder ID
settings: folder: record_status integer record_status Record_status
settings: plan_time ISO8601 Scheduled Time
lists array Distribution Lists
lists: list_id string(38) List ID
lists: record_status integer(3) record_status Body
subscribers array Subscribers
subscribers: email_id string(38) Email ID
subscribers: email string(100) Email address
subscribers: record_status integer(3) record_status Body
content array Content
content: body string Body
content: record_status integer(3) record_status Record Status
Response Messages:
Code Status Example Body
200 OK
{
    "settings": {
        "folder": {
            "folder_id": "root",
            "record_status": 200
        },
        "subject": {
            "subject": "My Campaign",
            "record_status": 200
        },
        "sender": {
            "email": "john.doe@example.com",
            "name": null,
            "record_status": 402
        }
    },
    "campaign_id": "209877f9-1d26-aa45-3d96-85d75b0f22a3",
    "html_content": true,
    "status": 1,
    "create_time": "2016-05-31T14:35:39+02:00",
    "source": 2,
    "title": "My Campaign",
    "content": {
        "body": "<html><\/html>",
        "record_status": 200
    },
    "lists": [
        {
            "list_id": "cec10bc4-6ddb-11e5-b85d-08002789d050",
            "record_status": 200
        }
    ],
    "subscribers": [
        {
            "email_id": "b64752a6-1a34-6548-0db7-3f3faf34916b",
            "email": "mike.johnson@example.com",
            "record_status": 200
        },
        {
            "email_id": "b64752a6-1a34-6548-0db7-3f3faf34916b",
            "email": "mike.johnson@example.com",
            "record_status": 202
        }
    ]
}

Copyright © CleverMonitor, 2017