NewsMAN API: sms.allCampaigns

Sections

KB Newsman

HomeAPISmssms.allCampaigns

Newsman Api Method: sms.allCampaigns

Prototype: sms.allCampaigns(list_id, start_date, stop_date, status, start, limit)

Description: Returns a list of campaigns with status $status between $start_date, $stop_date (inclusive)

HTTP method: GET

Endpoint HTTP: /sms.allCampaigns.json

Endpoint XML-RPC: sms.allCampaigns

Return type: struct

Return info: Array with campaigns. Each array item is an hash with keys: campaign_id, subject, status, create_date, stats, view_online_link, visual_report_link, segments

Request parameters GET

Variable	Type	Description
list_id	string\|int	The ID of the list for which to get the campaigns
start_date	datetime\|string\|boolean	Start of the period between which the campaign was created
stop_date	datetime\|string\|boolean	End of the period between which the campaign was created
status	boolean\|int\|string	Status of newsletter can be: all - all newsletters -1 - cancelled 0 - unconfirmed (new) 1 - confirmed 2 - sending 3 - paused 4 - resumed sending 5 - sent (finished) a comma separated combination of previous statuses, eg: 1,5
start	string\|int	Optional, for large lists. The page number to start. Defaults to first page (page = 0).
limit	string\|int	Optional, for large lists. The number of results to return per page. Defaults to 100. Upper limit is 1000.

Response parameters

Parameter	Description
newsletter_id	The id of the campaign
subject	The subject of the campaign
segments	The segments of the campaign (if they exist, array of key / value pairs containing segment_id as key)
status	The status of the campaign
create_date	The date of creation
stats	Array with stats (eg: unique_views, unique_clicks)
view_online_link	The view online link
visual_report_link	The clicks heatmap link

Output example

[
    {
        "campaign_id": "80001",
        "subject": "Some subject here",
        "segments": "[{\"segment_id\":\"2001\",\"segment_name\":\"Test Segment\"}]",
        "status": "-1",
        "create_date": "2017-03-14 17:35:32",
        "stats": {
            "unique_views": 0,
            "total_views": 0,
            "unique_view_rate": 0,
            "unique_clicks": 0,
            "total_clicks": 0,
            "unique_click_rate": 0,
            "total_sent": 0,
            "sent_per_minute": 0,
            "unsubcribes": 0,
            "spam_reports": 0,
            "bounces": 0
        },
        "view_online_link": "the_view_online_link",
        "visual_report_link": "the_visual_report_link"
    },
    {
        "newsletter_id": "80002",
        "subject": "Some other subject here",
        "segments": "[{\"segment_id\":\"2002\",\"segment_name\":\"Test Segment 2\"}]",
        "status": "-1",
        "create_date": "2017-03-13 17:35:32",
        "stats": {
            "unique_views": 0,
            "total_views": 0,
            "unique_view_rate": 0,
            "unique_clicks": 0,
            "total_clicks": 0,
            "unique_click_rate": 0,
            "total_sent": 0,
            "sent_per_minute": 0,
            "unsubcribes": 0,
            "spam_reports": 0,
            "bounces": 0
        },
        "view_online_link": "the_view_online_link",
        "visual_report_link": "the_visual_report_link"
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param start_date	start_date param is required
407	Missing required param stop_date	stop_date param is required
407	Missing required param status	status param is required
407	Missing required param start	start param is required
407	Missing required param limit	limit param is required
101	Not allowed for list_id = %s	Invalid access to list_id

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param start_date",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param stop_date",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param status",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param limit",
    "code": 407
}