openapi: 3.1.0
x-samples-languages:
- curl
- csharp
- java
- javascript
- node
- python
- php
- ruby
info:
version: 2.1.1
title: Email campaigns
description: 'Create, manage, and report on email campaigns. Use this API to create standard
and split-test campaigns, update campaign content and settings, copy campaigns,
and delete campaigns. Send campaigns immediately, schedule them for a future
time, or use time-optimised sending. Retrieve reporting data including opens,
clicks, page views, replies, ROI, social bookmark views, bounce data, and
aggregate metrics filtered by date range. Supports split-test result retrieval
and custom from-address management.'
externalDocs:
description: Learn more about Dotdigital APIs
url: https://developer.dotdigital.com
servers:
- url: https://{region}-api.dotdigital.com
variables:
region:
default: r1
enum:
- r1
- r2
- r3
description: The Dotdigital region id your account belongs to
security:
- basicAuth: []
paths:
/v2/campaigns:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
post:
summary: Create campaign
deprecated: false
description: Creates a campaign
operationId: create-campaign
tags:
- Email Campaigns
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- name
- subject
- fromName
- htmlContent
- plainTextContent
properties:
name:
type: string
description: The name of the campaign being created
maxLength: 255
subject:
type: string
description: The email subject line of the campaign
fromName:
type: string
description: The from name of the campaign
fromAddress:
type: object
description: 'The registered custom from address you wish to use. Note: Specify either email or id and if not specified, the default fromAddress for the account is used.'
properties:
email:
type: string
description: The registered sender to use by email address
id:
type: integer
description: The registered sender to use by id
format: int32
htmlContent:
type: string
description: The HTML content of the campaign.
plainTextContent:
type: string
description: The plain text content of the campaign
replyAction:
type: string
description: The required action to be taken when a reply to the campaign is sent by the recipient
replyToAddress:
type: string
description: The email address that you would like replies to be forwarded to
type:
type: string
description: Choose a campaign type. Options are "Standard" or "Triggered". Omitting or adding any abnormal value defaults to Standard.
default: Standard
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties: {}
examples:
Result:
summary: Result
value: '{
"id": 6302600,
"name": "New product promotion 2",
"subject": "New product!",
"fromName": "Company name",
"fromAddress": {
"id": 133618,
"email": "products@mycompany.com"
},
"htmlContent": "\r\n\r\n
",
"plainTextContent": "\r\n\r\n---\r\nWant to unsubscribe? $UNSUB$",
"replyAction": "Unset",
"replyToAddress": "",
"isSplitTest": false,
"status": "Unsent"
"type": "Standard"
}'
get:
summary: Get all campaigns
deprecated: true
description: Gets all campaigns
operationId: get-all-campaigns
tags:
- Email Campaigns
parameters:
- name: select
in: query
description: The number of records to select between 1 and 1000 to retrieve.
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 1000
default: 1000
- name: skip
in: query
description: The numbers of records to skip in the result set.
required: false
schema:
type: integer
minimum: 1
format: int32
responses:
'200':
description: '200'
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
default: 0
examples:
- 2
name:
type: string
examples:
- Financial update
subject:
type: string
examples:
- Financial update
fromName:
type: string
examples:
- Company name
fromAddress:
type: object
properties:
id:
type: integer
default: 0
examples:
- 2
email:
type: string
examples:
- demo@apiconnector.com
htmlContent: {}
plainTextContent: {}
replyAction:
type: string
examples:
- Unset
replyToAddress: {}
isSplitTest:
type: boolean
default: true
examples:
- false
status:
type: string
examples:
- Unsent
examples:
Result:
summary: Result
value:
- id: 2
name: Financial update
subject: Financial update
fromName: Company name
fromAddress:
id: 2
email: demo@apiconnector.com
htmlContent: null
plainTextContent: null
replyAction: Unset
replyToAddress: null
isSplitTest: false
status: Unsent
- id: 4
name: New product promotion
subject: New product!
fromName: Company name
fromAddress:
id: 1
email: demo@apiconnector.com
htmlContent: null
plainTextContent: null
replyAction: WebMailForward
replyToAddress: demo@apiconnector.com
isSplitTest: false
status: Sent
/v2/campaigns/split-test:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
post:
summary: Create split test campaign
deprecated: false
description: Creates a split test campaign
operationId: create-split-test-campaign
tags:
- Email Campaigns
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
description: The name of the campaign being created
subjects:
type: array
description: The name of the split test campaign being created
items:
type: string
fromNames:
type: array
description: The from names to be split tested on
items:
type: string
fromAddresses:
type: array
description: The emails of existing custom from addresses to be split tested on
items:
properties:
email:
type: string
description: The from email address
required:
- email
type: object
htmlContents:
type: array
description: The HTML contents of the campaign that lies between the opening and the closing only (the tags themselves should not be used), to be split tested on
items:
type: string
plainTextContents:
type: array
description: The plain text contents of the campaign, to be split tested on
items:
type: string
replyAction:
type: string
description: The required action to be taken when a reply to the campaign is sent by the recipient
enum:
- Unset
- WebMailForward
- Webmail
- Delete
replyToAddress:
type: string
description: The email address that you would like replies to be forwarded to
examples:
Request Example:
value:
name: Split Test Campaign
subjects:
- My subject variation A
- My subject variation B
- My subject variation C
fromNames:
- My name variation A
- My name variation B
- My name variation C
fromAddresses:
- email: hello@my-domain.com
- email: hello@my-other-domain.com
- email: hello@my-experimental-domain.com
htmlContents:
- "\r\n\r\n
"
plainTextContents:
- "\r\n\n---\r\nWant to unsubscribe? $UNSUB$"
- "\r\n\n---\r\nDon't want to hear from us? $UNSUB$"
- "\r\n\n---\r\nRemove me from this list $UNSUB$"
replyAction: Unset
replyToAddress: ''
status: Unsent
/v2/campaigns/{id}:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
put:
summary: Update campaign
deprecated: false
description: Updates a given campaign
operationId: update-campaign
tags:
- Email Campaigns
parameters:
- name: id
in: path
description: The ID of the campaign to be updated
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the campaign being created
subject:
type: string
description: The email subject line of the campaign
fromName:
type: string
description: The from name of the campaign
htmlContent:
type: string
description: The HTML content of the campaign that lies between the opening and the closing only (the tags themselves should not be used)
plainTextContent:
type: string
description: The plain text content of the campaign
examples:
Request Example:
value:
name: New product promotion 2
subject: Check out our newest product!
fromName: Company name
htmlContent: "\r\n\r\n
"
plainTextContent: "\r\n\n---\r\nWant to unsubscribe? $UNSUB$"
replyAction: Unset
replyToAddress: ''
isSplitTest: false
status: Unsent
/v2/campaigns/send:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
post:
summary: Send campaign
deprecated: false
description: Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send
operationId: send-campaign
tags:
- Email Campaigns
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
campaignID:
type: integer
description: The ID of the campaign
format: int32
addressBookIDs:
type: array
description: The array of address book IDs the campaign is to be sent to. This can be just one address book ID if required. You can also use a segment ID if you want to send a segment.
items:
type: integer
format: int32
contactIDs:
type: array
description: The array of contact IDs the campaign is to be sent to. This can be just one contact ID if required.
items:
type: integer
format: int32
sendDate:
type: string
description: The date and time at which you want the campaign to be sent
format: date
splitTestOptions:
type: object
description: The split test options
properties:
testMetric:
type: string
description: The metric to be used to calculate the success rate
enum:
- Opens
- Clicks
- ROI
testPercentage:
type: integer
description: The percentage of recipients to send the two versions of the campaign to before a winner is chosen
format: int32
testPeriodHours:
type: integer
description: The number of hours to run the test over before choosing a winning version of the campaign
format: int32
examples:
Request Example:
value:
campaignId: 1
contactIds:
- 1
sendDate: '2015-10-31T00:00:00'
splitTestOptions:
TestMetric: Opens
TestPercentage: 50
TestPeriodHours: 5
summary: Request Example
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
id:
type: string
examples:
- e8224c2b-a670-461e-b060-4ec776e9e7c2
campaignId:
type: integer
default: 0
examples:
- 1
addressBookIds: {}
contactIds:
type: integer
default: 0
examples:
- 1
sendDate:
type: string
examples:
- '2020-01-01T09:40:18.527Z'
splitTestOptions:
type: object
properties:
TestMetric:
type: string
examples:
- Opens
TestPercentage:
type: integer
default: 0
examples:
- 50
TestPeriodHours:
type: integer
default: 0
examples:
- 5
status:
type: string
examples:
- Sending
examples:
Result:
summary: Result
value:
id: e8224c2b-a670-461e-b060-4ec776e9e7c2
campaignId: 1
addressBookIds: null
contactIds: 1
sendDate: '2020-01-01T09:40:18.527Z'
splitTestOptions:
TestMetric: Opens
TestPercentage: 50
TestPeriodHours: 5
status: Sending
/v2/campaigns/send-time-optimised:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
post:
summary: Send time optimised campaign
deprecated: false
description: Sends a specified campaign to one or more address books, segments or contacts at the most appropriate time based upon their previous opens
operationId: send-time-optimised-campaign
tags:
- Email Campaigns
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
campaignID:
type: integer
description: The ID of the campaign
format: int32
addressBookIDs:
type: array
description: The array of address book IDs the campaign is to be sent to. This can be just one address book ID if required.
items:
type: integer
format: int32
contactIDs:
type: array
description: The array of contact IDs the campaign is to be sent to. This can be just one contact ID if required.
items:
type: integer
format: int32
examples:
Request Example:
value:
campaignId: 1
addressBookIds:
- 1
- 2
- 3
contactIds:
- 1
- 2
- 3
summary: Request Example
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
id:
type: string
examples:
- f415abb9-e98a-4f58-b136-795e69d6d2a0
campaignId:
type: integer
default: 0
examples:
- 1
addressBookIds: {}
contactIds: {}
sendDate:
type: string
examples:
- '2020-02-24T13:06:42.933Z'
splitTestOptions: {}
status:
type: string
examples:
- NotSent
examples:
Result:
summary: Result
value:
id: f415abb9-e98a-4f58-b136-795e69d6d2a0
campaignId: 1
addressBookIds: null
contactIds: null
sendDate: '2020-02-24T13:06:42.933Z'
splitTestOptions: null
status: NotSent
/v2/campaigns/send/{id}:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
summary: Get campaign send status
deprecated: false
description: Gets a campaign send status using send ID
operationId: get-campaign-send-status
tags:
- Email Campaigns
parameters:
- name: id
in: path
description: 'The send ID of the send campaign call. The send ID is a GUID, it looks like: 842d81e8-c619-457f-bb77-ab6c4a17da39.'
required: true
examples:
default:
value: ''
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
id:
type: string
examples:
- 842d81e8-c619-457f-bb77-ab6c4a17da39
campaignId:
type: integer
default: 0
examples:
- 1
addressBookIds: {}
contactIds: {}
sendDate:
type: string
examples:
- '2020-02-24T13:06:42.933Z'
splitTestOptions: {}
status:
type: string
examples:
- Sent
examples:
Result:
summary: Result
value:
id: 842d81e8-c619-457f-bb77-ab6c4a17da39
campaignId: 1
addressBookIds: null
contactIds: null
sendDate: '2020-02-24T13:06:42.933Z'
splitTestOptions: null
status: Sent
/v2/campaigns/{campaignID}/attachments:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
post:
summary: Add campaign attachment
deprecated: false
description: Adds a document to a campaign as an attachment
operationId: add-campaign-attachment
tags:
- Email Campaigns
parameters:
- name: campaignID
in: path
description: The ID of the campaign
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: The ID of the document
format: int32
name:
type: string
description: The name of the document
fileName:
type: string
description: The file name (path) of the document
fileSize:
type: string
description: The size in bytes of the document
dateCreated:
type: string
description: The date and time the document was first uploaded to the system
dateModified:
type: string
description: The date and time the document was last modified within the system
examples:
Request Example:
value:
id: 3
summary: Request Example
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
id:
type: integer
default: 0
examples:
- 3
name:
type: string
examples:
- Directions to Conference.pdf
fileName:
type: string
examples:
- /cmpdoc/5/0/7/4/7/files/3_directions-to-conference.pdf
fileSize:
type: integer
default: 0
examples:
- 24225
dateCreated:
type: string
examples:
- '2020-02-24T13:06:42.933Z'
dateModified:
type: string
examples:
- '2020-02-24T13:06:42.933Z'
examples:
Result:
summary: Result
value:
id: 3
name: Directions to Conference.pdf
fileName: /cmpdoc/5/0/7/4/7/files/3_directions-to-conference.pdf
fileSize: 24225
dateCreated: '2020-02-24T13:06:42.933Z'
dateModified: '2020-02-24T13:06:42.933Z'
get:
summary: Get campaign attachments
deprecated: false
description: Gets documents that are currently attached to a campaign
operationId: get-campaign-attachments
tags:
- Email Campaigns
parameters:
- name: campaignID
in: path
description: The ID of the campaign
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
default: 0
examples:
- 2
name:
type: string
examples:
- Conference schedule.pdf
fileName:
type: string
examples:
- /cmpdoc/5/0/7/4/7/files/1_conference-schedule.pdf
fileSize:
type: integer
default: 0
examples:
- 24225
dateCreated:
type: string
examples:
- '2020-01-01T09:40:18.527Z'
dateModified:
type: string
examples:
- '2020-01-01T09:40:18.527Z'
examples:
Result:
summary: Result
value:
- id: 2
name: Conference schedule.pdf
fileName: /cmpdoc/5/0/7/4/7/files/1_conference-schedule.pdf
fileSize: 24225
dateCreated: '2020-01-01T09:40:18.527Z'
dateModified: '2020-01-01T09:40:18.527Z'
- id: 3
name: Directions to Conference.pdf
fileName: /cmpdoc/5/0/7/4/7/files/2_directions-to-conference.pdf
fileSize: 24225
dateCreated: '2020-02-24T13:06:42.933Z'
dateModified: '2020-02-24T13:06:42.933Z'
/v2/campaigns/{campaignID}/attachments/{documentID}:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
delete:
summary: Remove campaign attachment
deprecated: false
description: Removes an attachment from a campaign
operationId: remove-campaign-attachment
tags:
- Email Campaigns
parameters:
- name: campaignID
in: path
description: The ID of the campaign
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
- name: documentID
in: path
description: The ID of the document
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties: {}
examples:
Result:
summary: Result
value: {}
/v2/campaigns/filtered:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
summary: Get all campaigns (with filters)
deprecated: false
description: Gets all campaigns, with optional filtering.
operationId: get-all-campaigns-with-filters
tags:
- Email Campaigns
parameters:
- name: select
in: query
description: The number of records to select between 1 and 1000 to retrieve.
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 1000
default: 1000
- name: skip
in: query
description: The numbers of records to skip in the result set.
required: false
schema:
type: integer
minimum: 1
format: int32
- name: ~type
in: query
description: Filter to a specific type of email campaign.
required: false
schema:
type: string
enum:
- Standard
- Triggered
- name: ~tags
in: query
description: Filter to campaigns with the specified tags; all tags listed must be assigned to the campaign to be included.
required: false
schema:
type: array
items:
type: string
- name: ~sentDate
in: query
description: Filter for campaigns sent on or after the specified date-time in UTC ISO-8601 format.
required: false
schema:
type: string
format: date
- name: ~statuses
in: query
description: 'Filter by campaign statuses: `Unsent`, `Sent`, `Sending`, `Paused`, `Cancelled`, `RequiresWorkflowApproval`'
required: false
schema:
type: array
items:
type: string
- name: ~scheduledDateFrom
in: query
description: Filter for campaigns scheduled to be sent on or after the specified date-time in UTC ISO-8601 format. Can be used in conjunction with `~scheduledDateTo` to create a date window.
required: false
schema:
type: string
format: date
- name: ~scheduledDateTo
in: query
description: Filter for campaigns scheduled to be sent on or before the specified date-time in UTC ISO-8601 format. Can be used in conjunction with `~scheduledDateFrom` to create a date window.
required: false
schema:
type: string
format: date
responses:
'200':
description: '200'
content:
application/json:
schema:
type: array
items:
type: object
required:
- id
- name
- subject
- fromName
- fromAddress
- htmlContent
- plainTextContent
- replyAction
- replyToAddress
- isSplitTest
- status
- type
- tags
- sentDate
- scheduledDate
properties:
id:
type: integer
default: 0
examples:
- 2
name:
type: string
examples:
- New product promotion
subject:
type: string
examples:
- New product!
fromName:
type: string
examples:
- Company name
fromAddress:
type: object
properties:
id:
type: integer
default: 0
examples:
- 1
email:
type: string
format: email
examples:
- demo@apiconnector.com
htmlContent: {}
plainTextContent: {}
replyAction:
type: string
examples:
- WebMailForward
replyToAddress:
type: string
examples:
- demo@apiconnector.com
isSplitTest:
type: boolean
default: true
examples:
- false
status:
type: string
examples:
- Sent
type:
type: string
description: ''
enum:
- Standard
- Triggered
- Template
- AiTemplate
tags:
type: array
items:
type: string
examples:
- re-engagement
sentDate:
type: string
format: date-time
examples:
- '2025-01-01T09:40:18.00Z'
scheduledDate:
type: string
format: date-time
examples:
- '2025-01-01T09:40:18.00Z'
examples:
Result:
summary: Result
value:
- id: 2
name: New product promotion
subject: New product!
fromName: Company name
fromAddress:
id: 1
email: demo@apiconnector.com
htmlContent: null
plainTextContent: null
replyAction: WebMailForward
replyToAddress: demo@apiconnector.com
isSplitTest: false
status: Sent
type: Triggered
tags:
- re-engagement
- lapsed
sentDate: '2025-01-01T09:40:18.00Z'
scheduledDate: null
- id: 3
name: Financial update
subject: Financial update
fromName: Company name
fromAddress:
id: 2
email: demo@apiconnector.com
htmlContent: null
plainTextContent: null
replyAction: Unset
replyToAddress: null
isSplitTest: false
status: Unsent
type: Standard
tags: []
sentDate: null,
scheduledDate: '2027-01-01T09:40:18.00Z'
'400':
description: '400'
content:
application/json:
schema:
type: object
properties: {}
examples:
Result:
summary: Result
value:
value: ''
'401':
description: '401'
content:
text/plain:
schema:
type: object
properties: {}
examples:
Result:
summary: Result
value: '{
"value": ""
}'
/v2/campaigns/{id}/with-details:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
summary: Get campaign with details
deprecated: false
description: Gets a campaign by ID, along with all its details
operationId: get-campaign-with-details
tags:
- Email Campaigns
parameters:
- name: id
in: path
description: The ID of the campaign
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
id:
type: integer
default: 0
examples:
- 1
name:
type: string
examples:
- New product promotion 2
subject:
type: string
examples:
- New product!
fromName:
type: string
examples:
- Company name
fromAddress:
type: object
properties:
id:
type: integer
default: 0
examples:
- 133618
email:
type: string
examples:
- products@mycompany.com
htmlContent:
type: string
examples:
- "\r\n\r\n
"
plainTextContent: "\r\n\n---\r\nWant to unsubscribe or change your details? $UNSUB$"
version: A
winningVersion: false
resultsActual: 2200
resultsPercentage: 0.4150943
- subjectLine: New product promotion 2
fromName: Company name
fromAddress: products@mycompany.com
htmlContent: "\r\n\r\n
"
plainTextContent: "\r\n\n---\r\nWant to unsubscribe or change your details? $UNSUB$"
version: B
winningVersion: true
resultsActual: 3100
resultsPercentage: 0.5849057
splitTestWinnerMetric: Opens
/v2/custom-from-addresses:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
summary: Get custom from addresses
deprecated: false
description: Gets all custom from addresses which can be used in a campaign
operationId: get-custom-from-addresses
tags:
- Email Campaigns
parameters: []
responses:
'200':
description: '200'
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
default: 0
examples:
- 1
email:
type: string
examples:
- news@company-name123.com
examples:
Result:
summary: Result
value:
- id: 1
email: news@company-name123.com
- id: 2
email: support@company-name123.com
/v2/campaigns/{campaignId}/revenue/since-date/{date}:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
summary: Get campaign revenue since date
deprecated: false
description: ''
operationId: get-campaign-revenue-since-date
tags:
- Email Campaigns
parameters:
- name: campaignId
in: path
description: The unique numeric campaign identifier you want data for
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
- name: date
in: path
description: The date from which any revenue associated with the campaign is collated from in [ISO 8601 format](https://www.w3.org/TR/xmlschema-2/#dateTime)
required: true
examples:
default:
value: ''
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
campaignID:
type: integer
default: 0
examples:
- 248
dateSent:
type: string
examples:
- '2022-05-13T08:20:38.953Z'
currency:
type: string
examples:
- USD
revenue:
type: number
default: 0
examples:
- 233498.94361681378
numOrders:
type: integer
default: 0
examples:
- 3755
conversionRate:
type: number
default: 0
examples:
- 2.495016611295681
examples:
Result:
summary: Result
value:
campaignID: 248
dateSent: '2022-05-13T08:20:38.953Z'
currency: USD
revenue: 233498.94361681378
numOrders: 3755
conversionRate: 2.495016611295681
/v2/campaigns/{campaignId}/activities/{contactId}/revenue:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
summary: Get campaign revenue for contact
deprecated: false
description: ''
operationId: get-campaign-revenue-for-contact
tags:
- Email Campaigns
parameters:
- name: campaignId
in: path
description: The unique numeric campaign identifier you want data for
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
- name: contactId
in: path
description: The unique numeric identifier for the contact you want the data for
required: true
examples:
default:
value: 0
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
campaignID:
type: integer
default: 0
examples:
- 248
dateSent:
type: string
examples:
- '2022-05-13T08:20:38.953Z'
currency:
type: string
examples:
- USD
revenue:
type: number
default: 0
examples:
- 233498.94361681378
numOrders:
type: integer
default: 0
examples:
- 3755
conversionRate:
type: number
default: 0
examples:
- 2.495016611295681
examples:
Result:
summary: Result
value:
campaignID: 248
dateSent: '2022-05-13T08:20:38.953Z'
currency: USD
revenue: 233498.94361681378
numOrders: 3755
conversionRate: 2.495016611295681
/v2/campaigns/metrics:
parameters:
- in: header
name: x-ddg-integration-token
required: false
description: If you are a partner of Dotdigital and have a [verified integration](https://developer.dotdigital.com/docs/partner-integration-verification) then include your [integration tracking token](https://developer.dotdigital.co/docs/verified-integration-tracking) here.
schema:
type: string
pattern: /^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/
example: 5a96bc79-19a7-4544-973b-e2da0c9136f9
get:
tags:
- Email Campaigns
summary: Gets sent campaigns metrics between the specified dates.
description: Gets key campaign metrics between the specified dates in UTC for all campaigns with activity.
operationId: getDailyCampaignMetrics
parameters:
- name: startDate
description: The start date/time for the reporting in UTC [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
in: query
required: true
schema:
type: string
format: date-time
examples:
- '2026-01-01T00:00:00.000Z'
- name: endDate
description: The end date/time for the reporting in UTC [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
in: query
required: true
schema:
type: string
format: date-time
examples:
- '2026-01-07T00:00:00.000Z'
- name: select
in: query
description: The number of records to select between 1 and 1000 to retrieve.
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 1000
default: 1000
- name: skip
in: query
description: The numbers of records to skip in the result set.
required: false
schema:
type: integer
minimum: 1
format: int32
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
allOf:
- type: object
additionalProperties: false
required:
- campaignId
- campaignName
- campaignType
- tags
- subjectLine
- dateSent
- lastDateSent
- sent
- delivered
- uniqueOpens
- clicks
- uniqueClicks
- replies
- hardBounces
- softBounces
- unsubscribes
- forwards
- orders
- assistedOrders
- sendStatusFails
- mailBlocks
- opens
- complaints
- pageViews
- percentageDelivered
- percentageUniqueOpens
- percentageHardBounces
- percentageSoftBounces
- percentageReplies
- percentageUnsubscribes
- percentageUniqueClicks
- percentageUniqueClicksToOpens
- revenue
- assistedRevenue
- conversionRate
properties:
campaignId:
description: The unique id for the campaign.
type: integer
format: int32
examples:
- 12345
campaignName:
description: The friendly name of the campaign.
type: string
examples:
- Re-engagement 1
campaignType:
type: string
description: ''
enum:
- Standard
- Triggered
- Template
- AiTemplate
tags:
description: Any reporting tags assigned ot the campaign.
type: array
minItems: 0
examples:
- Promotion
- Club_card
items:
type: string
subjectLine:
description: The subject line for the campaign.
type: string
examples:
- Hurry before the double deals expire!
dateSent:
description: The date/time the campaign was first sent in UTC ISO-8601 format.
type: string
format: date-time
examples:
- '2026-01-01T09:00:00.000Z'
lastDateSent:
description: The date/time the campaign was last sent in UTC ISO-8601 format.
type: string
format: date-time
sent:
description: The number of email sent.
type: integer
format: int32
minimum: 0
examples:
- 1000
delivered:
description: The total number of delivered emails.
type: integer
format: int32
minimum: 0
examples:
- 900
uniqueOpens:
type: integer
format: int32
clicks:
description: The number of clicks on tracked links.
type: integer
format: int32
minimum: 0
examples:
- 123
uniqueClicks:
description: The number of unique recipients that clicked.
type: integer
format: int32
minimum: 0
examples:
- 110
replies:
description: The number of reply emails received related to this campaign.
type: integer
format: int32
minimum: 0
examples:
- 13
hardBounces:
description: The number of hard bounces (permanent failure to deliver).
type: integer
format: int32
minimum: 0
examples:
- 15
softBounces:
description: The number of soft bounces (temporary failure to deliver).
type: integer
format: int32
minimum: 0
examples:
- 85
unsubscribes:
description: The number of unsubscribe requests for the campaign.
type: integer
format: int32
minimum: 0
examples:
- 25
forwards:
description: The number of times the campaign email has been forwarded.
type: integer
format: int32
minimum: 0
examples:
- 6
orders:
description: The number of orders directly attributed to the campaign.
type: integer
format: int32
minimum: 0
examples:
- 50
assistedOrders:
description: The number of orders influenced by the campaign.
type: integer
format: int32
minimum: 0
examples:
- 35
sendStatusFails:
description: The number of emails that failed to send.
type: integer
format: int32
minimum: 0
examples:
- 0
mailBlocks:
description: The number of mail blocks detected for the campaign.
type: integer
format: int32
minimum: 0
examples:
- 0
opens:
description: The number of email opens.
type: integer
format: int32
minimum: 0
examples:
- 875
complaints:
description: The number of ISP complaints.
type: integer
format: int32
minimum: 0
examples:
- 1
pageViews:
description: The number of pages/forms views related to the campaign.
type: integer
format: int32
minimum: 0
examples:
- 0
percentageDelivered:
description: The percentage of delivered email vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 90
percentageUniqueOpens:
description: The percentage of opens for unique contacts vs. total opens.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 90
percentageHardBounces:
description: The percentage of emails that hard bounces vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 3.5
percentageSoftBounces:
description: The percentage of emails that soft bounces vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 8.9
percentageReplies:
description: The percentage of replies receivied vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 1.6
percentageUnsubscribes:
description: The percentage of unsubscribes vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 5.6
percentageUniqueClicks:
description: The percentage of clicks made by unique contacts vs. total clicks.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 95
percentageUniqueClicksToOpens:
description: The percentage of clicks made by unique contacts vs. opens.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 100
revenue:
description: The revenue attributed to the campaign in the accounts currency.
type: number
format: decimal
minimum: 0
examples:
- 100888.34
assistedRevenue:
description: The assisted revenue attributed to the campaign in the accounts currency.
type: number
format: decimal
minimum: 0
examples:
- 5001
conversionRate:
description: The percentage of unique clicks to orders.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 50
- type: object
additionalProperties: false
required:
- fromName
- fromAddress
- isSplitTest
properties:
fromName:
description: The friendly "from" name used with the campaign.
type: string
fromAddress:
description: The email address the campaign was sent from.
type: string
format: email
isSplitTest:
description: Indicates whether the campaign used split testing or not.
type: boolean
examples:
result:
summary: Array of sent campaigns in time range
value:
- campaignId: 2309633
dateSent: '2026-02-28T03:47:32.73Z'
campaignName: Welcome
campaignType: Standard
sent: 1
delivered: 1
uniqueOpens: 1
clicks: 0
hardBounces: 0
softBounces: 0
replies: 0
unsubscribes: 0
forwards: 0
uniqueClicks: 0
sendStatusFails: 0
mailBlocks: 0
opens: 16
complaints: 0
pageViews: 0
percentageDelivered: 100
percentageUniqueOpens: 100
percentageHardBounces: 0
percentageSoftBounces: 0
percentageReplies: 0
percentageUnsubscribes: 0
percentageUniqueClicks: 0
percentageUniqueClicksToOpens: 0
revenue: 0
conversionRate: 0
assistedRevenue: 0
orders: 0
assistedOrders: 0
tags: []
subjectLine: Redefine your kitchen with our newest arrival U0001F373
fromName: Kitchens Inc
fromAddress: 12345@r1.dotdigital-email.com
isSplitTest: false
components:
schemas:
CampaignReportModelExtended:
allOf:
- type: object
additionalProperties: false
required:
- campaignId
- campaignName
- campaignType
- tags
- subjectLine
- dateSent
- lastDateSent
- sent
- delivered
- uniqueOpens
- clicks
- uniqueClicks
- replies
- hardBounces
- softBounces
- unsubscribes
- forwards
- orders
- assistedOrders
- sendStatusFails
- mailBlocks
- opens
- complaints
- pageViews
- percentageDelivered
- percentageUniqueOpens
- percentageHardBounces
- percentageSoftBounces
- percentageReplies
- percentageUnsubscribes
- percentageUniqueClicks
- percentageUniqueClicksToOpens
- revenue
- assistedRevenue
- conversionRate
properties:
campaignId:
description: The unique id for the campaign.
type: integer
format: int32
examples:
- 12345
campaignName:
description: The friendly name of the campaign.
type: string
examples:
- Re-engagement 1
campaignType:
type: string
description: ''
enum:
- Standard
- Triggered
- Template
- AiTemplate
tags:
description: Any reporting tags assigned ot the campaign.
type: array
minItems: 0
examples:
- Promotion
- Club_card
items:
type: string
subjectLine:
description: The subject line for the campaign.
type: string
examples:
- Hurry before the double deals expire!
dateSent:
description: The date/time the campaign was first sent in UTC ISO-8601 format.
type: string
format: date-time
examples:
- '2026-01-01T09:00:00.000Z'
lastDateSent:
description: The date/time the campaign was last sent in UTC ISO-8601 format.
type: string
format: date-time
sent:
description: The number of email sent.
type: integer
format: int32
minimum: 0
examples:
- 1000
delivered:
description: The total number of delivered emails.
type: integer
format: int32
minimum: 0
examples:
- 900
uniqueOpens:
type: integer
format: int32
clicks:
description: The number of clicks on tracked links.
type: integer
format: int32
minimum: 0
examples:
- 123
uniqueClicks:
description: The number of unique recipients that clicked.
type: integer
format: int32
minimum: 0
examples:
- 110
replies:
description: The number of reply emails received related to this campaign.
type: integer
format: int32
minimum: 0
examples:
- 13
hardBounces:
description: The number of hard bounces (permanent failure to deliver).
type: integer
format: int32
minimum: 0
examples:
- 15
softBounces:
description: The number of soft bounces (temporary failure to deliver).
type: integer
format: int32
minimum: 0
examples:
- 85
unsubscribes:
description: The number of unsubscribe requests for the campaign.
type: integer
format: int32
minimum: 0
examples:
- 25
forwards:
description: The number of times the campaign email has been forwarded.
type: integer
format: int32
minimum: 0
examples:
- 6
orders:
description: The number of orders directly attributed to the campaign.
type: integer
format: int32
minimum: 0
examples:
- 50
assistedOrders:
description: The number of orders influenced by the campaign.
type: integer
format: int32
minimum: 0
examples:
- 35
sendStatusFails:
description: The number of emails that failed to send.
type: integer
format: int32
minimum: 0
examples:
- 0
mailBlocks:
description: The number of mail blocks detected for the campaign.
type: integer
format: int32
minimum: 0
examples:
- 0
opens:
description: The number of email opens.
type: integer
format: int32
minimum: 0
examples:
- 875
complaints:
description: The number of ISP complaints.
type: integer
format: int32
minimum: 0
examples:
- 1
pageViews:
description: The number of pages/forms views related to the campaign.
type: integer
format: int32
minimum: 0
examples:
- 0
percentageDelivered:
description: The percentage of delivered email vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 90
percentageUniqueOpens:
description: The percentage of opens for unique contacts vs. total opens.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 90
percentageHardBounces:
description: The percentage of emails that hard bounces vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 3.5
percentageSoftBounces:
description: The percentage of emails that soft bounces vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 8.9
percentageReplies:
description: The percentage of replies receivied vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 1.6
percentageUnsubscribes:
description: The percentage of unsubscribes vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 5.6
percentageUniqueClicks:
description: The percentage of clicks made by unique contacts vs. total clicks.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 95
percentageUniqueClicksToOpens:
description: The percentage of clicks made by unique contacts vs. opens.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 100
revenue:
description: The revenue attributed to the campaign in the accounts currency.
type: number
format: decimal
minimum: 0
examples:
- 100888.34
assistedRevenue:
description: The assisted revenue attributed to the campaign in the accounts currency.
type: number
format: decimal
minimum: 0
examples:
- 5001
conversionRate:
description: The percentage of unique clicks to orders.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 50
- type: object
additionalProperties: false
required:
- fromName
- fromAddress
- isSplitTest
properties:
fromName:
description: The friendly "from" name used with the campaign.
type: string
fromAddress:
description: The email address the campaign was sent from.
type: string
format: email
isSplitTest:
description: Indicates whether the campaign used split testing or not.
type: boolean
CampaignReportModel:
type: object
additionalProperties: false
required:
- campaignId
- campaignName
- campaignType
- tags
- subjectLine
- dateSent
- lastDateSent
- sent
- delivered
- uniqueOpens
- clicks
- uniqueClicks
- replies
- hardBounces
- softBounces
- unsubscribes
- forwards
- orders
- assistedOrders
- sendStatusFails
- mailBlocks
- opens
- complaints
- pageViews
- percentageDelivered
- percentageUniqueOpens
- percentageHardBounces
- percentageSoftBounces
- percentageReplies
- percentageUnsubscribes
- percentageUniqueClicks
- percentageUniqueClicksToOpens
- revenue
- assistedRevenue
- conversionRate
properties:
campaignId:
description: The unique id for the campaign.
type: integer
format: int32
examples:
- 12345
campaignName:
description: The friendly name of the campaign.
type: string
examples:
- Re-engagement 1
campaignType:
type: string
description: ''
enum:
- Standard
- Triggered
- Template
- AiTemplate
tags:
description: Any reporting tags assigned ot the campaign.
type: array
minItems: 0
examples:
- Promotion
- Club_card
items:
type: string
subjectLine:
description: The subject line for the campaign.
type: string
examples:
- Hurry before the double deals expire!
dateSent:
description: The date/time the campaign was first sent in UTC ISO-8601 format.
type: string
format: date-time
examples:
- '2026-01-01T09:00:00.000Z'
lastDateSent:
description: The date/time the campaign was last sent in UTC ISO-8601 format.
type: string
format: date-time
sent:
description: The number of email sent.
type: integer
format: int32
minimum: 0
examples:
- 1000
delivered:
description: The total number of delivered emails.
type: integer
format: int32
minimum: 0
examples:
- 900
uniqueOpens:
type: integer
format: int32
clicks:
description: The number of clicks on tracked links.
type: integer
format: int32
minimum: 0
examples:
- 123
uniqueClicks:
description: The number of unique recipients that clicked.
type: integer
format: int32
minimum: 0
examples:
- 110
replies:
description: The number of reply emails received related to this campaign.
type: integer
format: int32
minimum: 0
examples:
- 13
hardBounces:
description: The number of hard bounces (permanent failure to deliver).
type: integer
format: int32
minimum: 0
examples:
- 15
softBounces:
description: The number of soft bounces (temporary failure to deliver).
type: integer
format: int32
minimum: 0
examples:
- 85
unsubscribes:
description: The number of unsubscribe requests for the campaign.
type: integer
format: int32
minimum: 0
examples:
- 25
forwards:
description: The number of times the campaign email has been forwarded.
type: integer
format: int32
minimum: 0
examples:
- 6
orders:
description: The number of orders directly attributed to the campaign.
type: integer
format: int32
minimum: 0
examples:
- 50
assistedOrders:
description: The number of orders influenced by the campaign.
type: integer
format: int32
minimum: 0
examples:
- 35
sendStatusFails:
description: The number of emails that failed to send.
type: integer
format: int32
minimum: 0
examples:
- 0
mailBlocks:
description: The number of mail blocks detected for the campaign.
type: integer
format: int32
minimum: 0
examples:
- 0
opens:
description: The number of email opens.
type: integer
format: int32
minimum: 0
examples:
- 875
complaints:
description: The number of ISP complaints.
type: integer
format: int32
minimum: 0
examples:
- 1
pageViews:
description: The number of pages/forms views related to the campaign.
type: integer
format: int32
minimum: 0
examples:
- 0
percentageDelivered:
description: The percentage of delivered email vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 90
percentageUniqueOpens:
description: The percentage of opens for unique contacts vs. total opens.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 90
percentageHardBounces:
description: The percentage of emails that hard bounces vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 3.5
percentageSoftBounces:
description: The percentage of emails that soft bounces vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 8.9
percentageReplies:
description: The percentage of replies receivied vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 1.6
percentageUnsubscribes:
description: The percentage of unsubscribes vs. sent.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 5.6
percentageUniqueClicks:
description: The percentage of clicks made by unique contacts vs. total clicks.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 95
percentageUniqueClicksToOpens:
description: The percentage of clicks made by unique contacts vs. opens.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 100
revenue:
description: The revenue attributed to the campaign in the accounts currency.
type: number
format: decimal
minimum: 0
examples:
- 100888.34
assistedRevenue:
description: The assisted revenue attributed to the campaign in the accounts currency.
type: number
format: decimal
minimum: 0
examples:
- 5001
conversionRate:
description: The percentage of unique clicks to orders.
type: number
format: decimal
maximum: 100
minimum: 0
examples:
- 50
CampaignType:
type: string
description: ''
enum:
- Standard
- Triggered
- Template
- AiTemplate
securitySchemes:
basicAuth:
type: http
scheme: basic