Skip to content

Latest commit

 

History

History
625 lines (374 loc) · 23.6 KB

CampaignsApi.md

File metadata and controls

625 lines (374 loc) · 23.6 KB
Raw

\CampaignsApi

All URIs are relative to https://api.moosend.com/v3

Method HTTP request Description
ABTestCampaignSummary Get /campaigns/{CampaignID}/view_ab_summary.{Format} AB Test Campaign Summary
ActivityByLocation Get /campaigns/{CampaignID}/stats/countries.{Format} Activity By Location
CampaignSummary Get /campaigns/{CampaignID}/view_summary.{Format} Campaign Summary
CloningAnExistingCampaign Post /campaigns/{CampaignID}/clone.{Format} Cloning An Existing Campaign
CreatingADraftCampaign Post /campaigns/create.{Format} Creating A Draft Campaign
DeletingACampaign Delete /campaigns/{CampaignID}/delete.{Format} Deleting A Campaign
GetAllCampaigns Get /campaigns.{Format} Get All Campaigns
GetCampaignStatisticsWithPagingFiltered Get /campaigns/{CampaignID}/stats/{Type}.{Format} Get Campaign Statistics With Paging & Filtered
GetCampaignsByPage Get /campaigns/{Page}.{Format} Get Campaigns By Page
GetCampaignsByPageAndPagesize Get /campaigns/{Page}/{PageSize}.{Format} Get Campaigns By Page And Pagesize
GettingAllYourSenders Get /senders/find_all.{Format} Getting All Your Senders
GettingCampaignDetails Get /campaigns/{CampaignID}/view.{Format} Getting Campaign Details
GettingSenderDetails Get /senders/find_one.{Format} Getting Sender Details
LinkActivity Get /campaigns/{CampaignID}/stats/links.{Format} Link Activity
SchedulingACampaign Post /campaigns/{CampaignID}/schedule.{Format} Scheduling A Campaign
SendingACampaign Post /campaigns/{CampaignID}/send.{Format} Sending a campaign
TestingACampaign Post /campaigns/{CampaignID}/send_test.{Format} Testing a campaign
UnschedulingACampaign Post /campaigns/{CampaignID}/unschedule.{Format} Unscheduling a campaign
UpdatingADraftCampaign Post /campaigns/{CampaignID}/update.{Format} Updating A Draft Campaign

ABTestCampaignSummary

AbTestCampaignSummaryResponse ABTestCampaignSummary($format, $apikey, $campaignID)

AB Test Campaign Summary

Provides a basic summary of the results for a sent AB test campaign, separately for each version (A and B), such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc to date.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the requested AB test campaign

Return type

AbTestCampaignSummaryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ActivityByLocation

ActivityByLocationResponse ActivityByLocation($format, $apikey, $campaignID)

Activity By Location

Returns a detailed report of your campaign opens (unique and total) by country.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the requested campaign

Return type

ActivityByLocationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CampaignSummary

CampaignSummaryResponse CampaignSummary($format, $apikey, $campaignID)

Campaign Summary

Provides a basic summary of the results for any sent campaign such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc. to date.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the requested campaign

Return type

CampaignSummaryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloningAnExistingCampaign

CloningAnExistingCampaignResponse CloningAnExistingCampaign($format, $campaignID, $apikey)

Cloning An Existing Campaign

Creates an exact copy of an existing campaign. The new campaign is created as a draft.

Parameters

Name Type Description Notes
format string
campaignID string
apikey string You may find your API Key or generate a new one in your account settings.

Return type

CloningAnExistingCampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreatingADraftCampaign

CreatingADraftCampaignResponse CreatingADraftCampaign($format, $apikey, $body)

Creating A Draft Campaign

Creates a new campaign in your account. This method does not send the campaign, but rather creates it as a draft, ready for sending or testing. You can choose to send either a regular campaign or an AB split campaign. Campaign content must be specified from a web location. Ignore (A/B Split Campaign Option) if you want to create a regular campaign.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
body CreatingADraftCampaignRequest

Return type

CreatingADraftCampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletingACampaign

DeletingACampaignResponse DeletingACampaign($format, $apikey, $campaignID)

Deleting A Campaign

Deletes a campaign from your account, draft or even sent.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the draft campaign to update.

Return type

DeletingACampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllCampaigns

GetAllCampaignsResponse GetAllCampaigns($format, $apikey)

Get All Campaigns

Returns a list of all campaigns in your account with detailed information. Because the results for this call could be quite big, paging information is required as input.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.

Return type

GetAllCampaignsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCampaignStatisticsWithPagingFiltered

GetCampaignStatisticsWithPagingFilteredResponse GetCampaignStatisticsWithPagingFiltered($format, $apikey, $campaignID, $type_, $page, $pageSize, $from, $to)

Get Campaign Statistics With Paging & Filtered

Returns a detailed list of statistics for a given campaign based on activity such as emails sent, opened, bounced, link clicked, etc. Because the results for this call could be quite big, paging information is required as input.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the requested AB test campaign
type_ string The type of the activity to display results for. This must be one of the following values : * Sent : To get information about when and to which recipients the campaign was sent. * Opened : To get information about who opened the campaign. * LinkClicked : To get information about who clicked on which link. * Forward : To get information about who forwarded the campaign using the relevant link on the email body and when. * Unsubscribed : To get information about who unsubscribed from the campaign by clicking on the unsubscribe link and when. * Bounced : To get information about which email recipients failed to receive the campaign. If not specified, the value Sent will be used by default.
page string The page number to display results for. If not specified, the first page will be returned. [optional]
pageSize string The maximum number of results per page. This must be a positive integer up to 100. If not specified, 50 results per page will be returned. If a value greater than 100 is specified, it will be treated as 100. [optional]
from string A date value that specifies since when to start returning results. If omitted, results will be returned from the moment the campaign was sent. [optional]
to string A date value that specifies up to when to return results. If omitted, results will be returned up to date. [optional]

Return type

GetCampaignStatisticsWithPagingFilteredResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCampaignsByPage

GetCampaignsByPageResponse GetCampaignsByPage($format, $apikey, $page)

Get Campaigns By Page

Returns a list of all campaigns in your account with detailed information. Because the results for this call could be quite big, paging information is required as input.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
page float64 The page number to display results for.

Return type

GetCampaignsByPageResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCampaignsByPageAndPagesize

GetCampaignsByPageAndPagesizeResponse GetCampaignsByPageAndPagesize($format, $apikey, $page, $pageSize, $shortBy, $sortMethod)

Get Campaigns By Page And Pagesize

Returns a list of all campaigns in your account with detailed information. Because the results for this call could be quite big, paging information is required as input.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
page float64 The page number to display results for.
pageSize float64 The maximum number of results per page. This must be a positive integer up to 100. If not specified, 50 results per page will be returned. If a value greater than 100 is specified, it will be treated as 100.
shortBy string The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property [optional]
sortMethod string The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed [optional]

Return type

GetCampaignsByPageAndPagesizeResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GettingAllYourSenders

GettingAllYourSendersResponse GettingAllYourSenders($format, $apikey)

Getting All Your Senders

Gets a list of your active senders in your account. You may specify any email address of these senders when sending a campaign.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.

Return type

GettingAllYourSendersResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GettingCampaignDetails

GettingCampaignDetailsResponse GettingCampaignDetails($format, $apikey, $campaignID)

Getting Campaign Details

Returns a complete set of properties that describe the requested campaign in detail. No statistics are included in the result.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the requested campaign

Return type

GettingCampaignDetailsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GettingSenderDetails

GettingSenderDetailsResponse GettingSenderDetails($format, $email, $apikey)

Getting Sender Details

Returns basic information for the specified sender identified by its email address.

Parameters

Name Type Description Notes
format string
email string
apikey string You may find your API Key or generate a new one in your account settings.

Return type

GettingSenderDetailsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LinkActivity

LinkActivityResponse LinkActivity($format, $apikey, $campaignID)

Link Activity

Returns a list with your campaign links and how many clicks have been made by your recipients, either unique or total.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the requested campaign

Return type

LinkActivityResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SchedulingACampaign

SchedulingACampaignResponse SchedulingACampaign($format, $apikey, $campaignID, $body)

Scheduling A Campaign

Assigns a scheduled date and time at which the campaign will be delivered.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the campaign to be scheduled
body SchedulingACampaignRequest

Return type

SchedulingACampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendingACampaign

SendingACampaignResponse SendingACampaign($format, $apikey, $campaignID)

Sending a campaign

Sends an existing draft campaign to all recipients specified in its mailing list. The campaign is sent immediatelly.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the draft campaign to be sent.

Return type

SendingACampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestingACampaign

TestingACampaignResponse TestingACampaign($format, $apikey, $campaignID, $body)

Testing a campaign

Sends a test email of a draft campaign to a list of email addresses you specify for previewing.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the draft campaign to be tested.
body TestingACampaignRequest

Return type

TestingACampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnschedulingACampaign

UnschedulingACampaignResponse UnschedulingACampaign($format, $apikey, $campaignID)

Unscheduling a campaign

Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the campaign to be scheduled

Return type

UnschedulingACampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatingADraftCampaign

UpdatingADraftCampaignResponse UpdatingADraftCampaign($format, $apikey, $campaignID, $body)

Updating A Draft Campaign

Updates properties of an existing draft A/B campaign in your account. Non-draft campaigns cannot be updated. Ignore (A/B Split Campaign Option) if you want to create a regular campaign.

Parameters

Name Type Description Notes
format string
apikey string You may find your API Key or generate a new one in your account settings.
campaignID string The ID of the draft campaign to update.
body UpdatingADraftCampaignRequest

Return type

UpdatingADraftCampaignResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]