Retrieves a list of statistics for up to 100 selected campaigns.
For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
Use List Campaigns to retrieve additional information for your campaigns. Use List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
Use List Statistics to retrieve a list of activity for selected campaigns. Use List Campaigns to retrieve additional information for your campaigns.
Note: If no
activity
is included, this endpoint returns an error.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves information about an email campaign.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Permanently deletes a campaign.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Returns a list of email campaigns.
Default sort by date_updated
in desc
order.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Publishes/sends a specified campaign.
If email_distribution_options
are not supplied, the campaign is only published as a landing page.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Sends a test email for preview purposes. It is heavily throttled - do not use this for regular campaign sending.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Pauses a scheduled campaign. Learn more about market campaign scheduling.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Creates a (draft) copy of an existing campaign.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Triggered each time an email campaign has a new recipient activity.
New recipient activity includes when each email in a campaign is DELIVERED
, OPENED
,
or BOUNCED
. Also, when a URL inside the email is CLICKED
.
The type of activity that triggered the webhook is in actionEvent.body
and can be one of:
delivery
: Email was delivered to recipient.click
: Recipient clicked on a URL in an email.open
: Recipient opened an email.softBounce
: Email soft bounced when sent to a recipient.hardBounce
: Email hard bounced when sent to a recipient.