Get campaign details

Request

Parameter	In	Type	Required	Description
`CampaignID`	path	string	true	The ID of the campaign that contains the details you are requesting.
`Format`	path	string	true	The supported file format for getting a response. Possible values: `json` and `xml`.
`apikey`	query	string	true	The API key of your account.

Parameter

Type

Required

Description

CampaignID

path

string

true

The ID of the campaign that contains the details you are requesting.

Format

path

string

true

The supported file format for getting a response.

Possible values: json and xml.

apikey

query

string

true

The API key of your account.

RequestResponse

GET https://{hostname}/v3/campaigns/{CampaignID}/view.{Format}?apikey=

Response

Status	Description	Headers	Schema
`200 OK`	The request is successful.	`Content-Type:application/json` `Accept:application/json`	N/A

Status

Description

Headers

Schema

200 OK

The request is successful.

Content-Type:application/json

Accept:application/json

N/A

RequestResponse

{
  "Code": 0,
  "Error": null,
  "Context": {
    "ID": "2fa129d1-a0ab-467a-ab3e-e43fd9f6bfb",
    "Name": "Test",
    "Subject": "Test",
    "WebLocation": null,
    "HTMLContent": someHtmlContent,
    "PlainContent": somePlainContent,
    "Sender": {
      "ID": "28a7ee75-034a-44e0-a946-fe28fc229d6e",
      "Name": "Fanis",
      "Email": "[email protected]",
      "CreatedOn": "/Date(1457684250090+0100)/",
      "IsEnabled": true,
      "SpfVerified": false,
      "DkimVerified": true,
      "DkimPublic": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDmO"
    },
    "DeliveredOn": "/Date(1464339959683+0100)/",
    "ReplyToEmail": {
      "ID": "28a7ee75-034a-4110-a9116-fe34235re6e",
      "Name": "Fanis",
      "Email": "[email protected]",
      "CreatedOn": "/Date(1457684250090+0100)/",
      "IsEnabled": true,
      "SpfVerified": false,
      "DkimVerified": true,
      "DkimPublic": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDmO"
    },
    "CreatedOn": "/Date(1464339921630+0100)/",
    "UpdatedOn": "/Date(1464339949343+0100)/",
    "ScheduledFor": null,
    "Timezone": "GTB Standard Time",
    "FormatType": 0,
    "ABCampaignData": null,
    "MailingLists": [
      {
        "MailingListID": "ad4b18-3sd0-4e1a-a110-481080fa94",
        "SegmentID": 0
      }
    ],
    "ConfirmationTo": "[email protected]",
    "Status": 3,
    "IsTransactional": false
  }
}

Code - the response code. This is 0 if successful.
Error - the response error message. This is null if successful.
Context - an object that contains all the following information for the requested campaign:
ID - the ID of the campaign.
Name - the name of the campaign.
Subject - the subject of the campaign.
WebLocation - the web location of the HTML campaign.
HTMLContent - the HTML content of the campaign.
PlainContent - the content of the campaign in plain text.
Sender - a list that contains the following information about the campaign sender:
- ID - the ID of the sender.
- Name - the name of the sender.
- Email - the email address of the sender.
- CreatedOn - the date that the sender was created.
- IsEnabled - this is true if the sender is enabled and false if it is not.
- SpfVerified - this is true if the SPF record for the sender is enabled and false if it is not.
- DkimVerified - this is true if the DKIM record for the sender is enabled and false if it is not.
- DkimPublic - specifies the sender's email public DKIM.
DeliveredOn - the date-time the campaign was delivered. This is null for a cloned campaign.
ReplyToEmail - an object that contains details about the Reply to email address selected to receive replies from the campaign:
- ID - the ID of the Reply to email receiver.
- Name - the name of the Reply to email receiver.
- Email - the email address of the Reply to email receiver.
- CreatedOn - the date that the Reply to email receiver was created.
- IsEnabled - this is true if the Reply to email receiver is enabled and false if it is not.
- SpfVerified - this is true if the SPF record for the Reply to email receiver is enabled and false if it is not.
- DkimVerified - this is true if the DKIM record for the Reply to email receiver is enabled and false if it is not.
- DkimPublic - specifies the Reply to email receiver's email public DKIM.
CreatedOn - the date-time the campaign was created.
UpdatedOn - the date-time the campaign was updated.
ScheduledFor - the date-time the campaign is scheduled to be delivered. This is null for a cloned campaign.
TimeZone - the selected time zone for the account.
FormatType - the format type of the campaign. This is 0 for HTML, 1 for Template, and 2 for Plain Text.
ABCampaignData - this is null if the campaign is a regular campaign. If the campaign is an A/B split campaign, the object contains the following information :
- ID - the four-digit integer ID of the ABCampaignData.
- SubjectB - if the A/B split campaign is testing the subject, this is the subject line for campaign B.
- PlainContentB - if the A/B split campaign is testing the content, this is the plain text content for campaign B.
- HTMLContentB - if the A/B split campaign is testing the content, this is the HTML content for campaign B.
- WebLocationB - if the A/B split campaign is testing the content, this is the web location for campaign B.
- SenderB - if the A/B split campaign is testing the sender, this is campaign B's sender.
- HoursToTest - the total number of hours to test campaigns A and B of your split test before sending the winning version.
- ListPercentage - specifies the size of your test group in your list.
- ABCampaignType - specifies the type of A/B split campaign. This is 0 for sender, 1 for content, and 2 for subject line
- ABWinnerSelectionType - specifies the type of test that defines the winning version of the campaign. This is 0 for a unique opens test and 1 for a unique clicks test.
- DeliveredOnA - the date-time campaign A was delivered. This is null for a cloned campaign.
- DeliveredOnB - the date-time campaign B was delivered. This is null for a cloned campaign.
MailingLists - a list that contains the email lists or segments that that campaign is sent to.
- MailingListID - the ID of the email list.
- SegmentID - the ID of the selected segment. This is 0 if there is no segment selected.
ConfirmationTo - the email address to which a confirmation message is sent when the campaign has been successfully sent.
Status - status of the campaign.
IsTransactional - specifies whether the campaign was created using SMTP. This can be true or false.

Do you have some feedback for us?

If you have suggestions for improving this article,