Back to Documentation Overviewcampaigns
public static campaigns(string uid, string filter_id, integer filter_folder, string filter_fromname, string filter_fromemail, string filter_title, string filter_subject, string filter_sendtimestart, string filter_sendtimeend, boolean filter_exact, integer start, integer limit)
Get the list of campaigns and associated information for a list
- Section:
- Campaign Related
- Parameters:
| uid | the id for your user account. Get by calling login($user, $pass) |
| filter_id | optional - only show campaigns from this list id - get lists using getLists() |
| filter_folder | optional - only show campaigns from this folder id - get folders using campaignFolders() |
| filter_fromname | optional - only show campaigns that have this "From Name" |
| filter_fromemail | optional - only show campaigns that have this "Reply-to Email" |
| filter_title | optional - only show campaigns that have this title |
| filter_subject | optional - only show campaigns that have this subject |
| filter_sendtimestart | optional - only show campaigns that have been sent since this date/time |
| filter_sendtimeend | optional - only show campaigns that have been sent before this date/time |
| filter_exact | optional - flag for whether to filter on exact values when filtering, or search within content for filter values |
| start | optional - control paging of campaigns, start results at this campaign #, defaults to 1st page of data (page 0) |
| limit | optional - control paging of campaigns, number of campaigns to return with each call, defaults to 25 (max=5000) |
- Returns:
- array - list of campaigns and their associated information (see Returned Fields for description)
- Returned Fields:
| string | id | Campaign Id (used for all other campaign functions) |
| string | title | Title of the campaign |
| date | create_time | Creation time for the campaign |
| date | send_time | Send time for the campaign |
| int | emails_sent | Number of emails email was sent to |
| string | status | Status of the given campaign (sent,scheduled,etc.) |
| string | from_name | From name of the given campaign |
| string | from_email | Reply-to email of the given campaign |
| string | subject | Subject of the given campaign |
| string | to_email | Custom "To:" email string using merge variables |
| string | archive_url | Archive link for the given campaign |
|