> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Get

# Package: emailMarketing

# Namespace: CampaignService

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/emails/email-marketing/campaign/get-campaign.md

## Permission Scopes:
Manage Email Marketing: SCOPE.DC-PROMOTE.EMAIL-MARKETING

## Introduction

Retrieves information about an email campaign.

---

## REST API

### Schema

```
 Method: get
 Description: Retrieves information about an email campaign.
 URL: https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  campaignId
 Method parameters: 
   param name: campaignId | type:   none | required: true
   query param name: optionIncludeStatistics | type: optionIncludeStatistics | description: Whether a returned campaign should include `publishingData.statistics`. Default: `false`. 
 Return type: GetCampaignResponse
  - name: campaign | type: Campaign | description: Campaign information. 
     - name: campaignId | type: string | description: Campaign GUID. 
     - name: title | type: string | description: Marketing campaign title. If you don't provide the value, the title automatically gets the value of an email subject. 
     - name: firstImageUrl | type: string | description: URL of the first image after the logo. 
     - name: editorType | type: Enum | description: Editor type. 
         - enum:
         -     UNKNOWN: Unknown editor. This value isn't used.
         -     WEB: Classic web editor.
         -     MOBILE: Classic mobile editor.
         -     MJML: Chat (AI) based web editor.
     - name: status | type: Enum | description: Campaign status. 
         - enum:
         -     UNKNOWN: Unknown campaign. This value isn't used.
         -     ACTIVE: Campaign is active.
         -     ARCHIVED: Campaign is archived.
         -     DELETED: Campaign is deleted.
     - name: visibilityStatus | type: Enum | description: Campaign visibility status. 
         - enum:
         -     UNKNOWN: Unknown status. This value isn't used.
         -     DRAFT: Campaign isn't published yet.
         -     PUBLISHED: Campaign is published.
         -     TEMPLATE: Campaign is a template.
     - name: distributionStatus | type: Enum | description: Campaign distribution status. 
         - enum:
         -     UNKNOWN: Unknown distribution status.
         -     NOT_STARTED: Campaign isn't distributed to recipients yet.
         -     SCHEDULED: Campaign is scheduled for distribution.
         -     IN_DETECTION: Campaign is in screening for malicious content.
         -     IN_MODERATION: Campaign is in review by the site moderators.
         -     SAMPLING: Several recipients are selected for campaign testing, and campaign is sent out to them.
         -     SENDING: Campaign is being sent out to all recipients.
         -     REJECTED: Campaign is rejected.
         -     TERMINATED: Campaign is terminated after a failed sampling test.
         -     DISTRIBUTED: Campaign is fully distributed to all recipients.
         -     PAUSED: Scheduled campaign is paused.
     - name: publishingData | type: PublishingData | description: Publishing data. The field is returned empty if the campaign isn't published. 
        - name: landingPageUrl | type: string | description: Landing page URL. 
        - name: statistics | type: CampaignStatistics | description: Marketing campaign statistics. 
           - name: landingPage | type: LandingPageStatistics | description: Landing page statistics of a marketing campaign. 
              - name: opened | type: integer | description: Number of times when a landing page was loaded or viewed. 
              - name: clicked | type: integer | description: Number of times a link was clicked in a landing page. 
           - name: emailCampaign | type: DistributionStatistics | description: Email distribution statistics of a marketing campaign. 
              - name: delivered | type: integer | description: Number of delivered emails. 
              - name: opened | type: integer | description: Number of recipients who opened an email.  If the same recipient opened the same email twice, it is counted as a one unique open. 
              - name: clicked | type: integer | description: Number of recipients who clicked a link in the email.  If the same recipient clicked the same link twice, it is counted as a one unique click.  If the same recipient clicked different links, it is counted as a one unique click. 
              - name: bounced | type: integer | description: Number of emails that didn't reach the recipient. 
              - name: complained | type: integer | description: Number of recipients who reported the email as a spam. 
              - name: notSent | type: integer | description: Number of emails that weren't sent due to the campaign termination. 
           - name: total | type: TotalStatistics | description: Combined statistics of landing page and email distribution. 
              - name: mailsSent | type: integer | description: Total number of emails sent. 
              - name: opened | type: integer | description: Number of landing page views and opened emails. 
              - name: clicked | type: integer | description: Number of landing page and email link clicks. 
        - name: datePublished | type: string | description: Marketing campaign publish date. 
     - name: dateCreated | type: string | description: Date and time when the campaign was created. 
     - name: dateUpdated | type: string | description: Date and time when the campaign was updated. 


```

### Examples

### Get Campaign
```curl
curl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns/98b5a0b3-549b-4e58-b933-a8bd40923a14' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.emailMarketing.CampaignService.get(campaignId, options)
 Description: Retrieves information about an email campaign.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  campaignId
 Method parameters: 
   param name: campaignId | type: string | description: Campaign GUID. | required: true
   param name: options | type: GetOptions  none 
        - name: optionIncludeStatistics | type: boolean | description: Whether a returned campaign should include `publishingData.statistics`. Default: `false`. 
 Return type: PROMISE<Campaign>
  - name: campaignId | type: string | description: Campaign GUID. 
  - name: title | type: string | description: Marketing campaign title. If you don't provide the value, the title automatically gets the value of an email subject. 
  - name: firstImageUrl | type: string | description: URL of the first image after the logo. 
  - name: editorType | type: Enum | description: Editor type. 
     - enum:
     -     UNKNOWN: Unknown editor. This value isn't used.
     -     WEB: Classic web editor.
     -     MOBILE: Classic mobile editor.
     -     MJML: Chat (AI) based web editor.
  - name: status | type: Enum | description: Campaign status. 
     - enum:
     -     UNKNOWN: Unknown campaign. This value isn't used.
     -     ACTIVE: Campaign is active.
     -     ARCHIVED: Campaign is archived.
     -     DELETED: Campaign is deleted.
  - name: visibilityStatus | type: Enum | description: Campaign visibility status. 
     - enum:
     -     UNKNOWN: Unknown status. This value isn't used.
     -     DRAFT: Campaign isn't published yet.
     -     PUBLISHED: Campaign is published.
     -     TEMPLATE: Campaign is a template.
  - name: distributionStatus | type: Enum | description: Campaign distribution status. 
     - enum:
     -     UNKNOWN: Unknown distribution status.
     -     NOT_STARTED: Campaign isn't distributed to recipients yet.
     -     SCHEDULED: Campaign is scheduled for distribution.
     -     IN_DETECTION: Campaign is in screening for malicious content.
     -     IN_MODERATION: Campaign is in review by the site moderators.
     -     SAMPLING: Several recipients are selected for campaign testing, and campaign is sent out to them.
     -     SENDING: Campaign is being sent out to all recipients.
     -     REJECTED: Campaign is rejected.
     -     TERMINATED: Campaign is terminated after a failed sampling test.
     -     DISTRIBUTED: Campaign is fully distributed to all recipients.
     -     PAUSED: Scheduled campaign is paused.
  - name: publishingData | type: PublishingData | description: Publishing data. The field is returned empty if the campaign isn't published. 
     - name: landingPageUrl | type: string | description: Landing page URL. 
     - name: statistics | type: CampaignStatistics | description: Marketing campaign statistics. 
        - name: landingPage | type: LandingPageStatistics | description: Landing page statistics of a marketing campaign. 
           - name: opened | type: integer | description: Number of times when a landing page was loaded or viewed. 
           - name: clicked | type: integer | description: Number of times a link was clicked in a landing page. 
        - name: emailCampaign | type: DistributionStatistics | description: Email distribution statistics of a marketing campaign. 
           - name: delivered | type: integer | description: Number of delivered emails. 
           - name: opened | type: integer | description: Number of recipients who opened an email.  If the same recipient opened the same email twice, it is counted as a one unique open. 
           - name: clicked | type: integer | description: Number of recipients who clicked a link in the email.  If the same recipient clicked the same link twice, it is counted as a one unique click.  If the same recipient clicked different links, it is counted as a one unique click. 
           - name: bounced | type: integer | description: Number of emails that didn't reach the recipient. 
           - name: complained | type: integer | description: Number of recipients who reported the email as a spam. 
           - name: notSent | type: integer | description: Number of emails that weren't sent due to the campaign termination. 
        - name: total | type: TotalStatistics | description: Combined statistics of landing page and email distribution. 
           - name: mailsSent | type: integer | description: Total number of emails sent. 
           - name: opened | type: integer | description: Number of landing page views and opened emails. 
           - name: clicked | type: integer | description: Number of landing page and email link clicks. 
     - name: datePublished | type: Date | description: Marketing campaign publish date. 
  - name: dateCreated | type: Date | description: Date and time when the campaign was created. 
  - name: dateUpdated | type: Date | description: Date and time when the campaign was updated. 


```

### Examples

### Gets email campaign by ID (with elevated permissions)
```javascript
import { campaigns } from '@wix/email-marketing';
import { auth } from '@wix/essentials';

const elevatedGetCampaign = auth.elevate(campaigns.getCampaign);

// Sample campaignId value: 'ff61204b-b19a-5cc8-823b-7eed8ae5fc28'
  
// Sample options value:
//   {
//     optionIncludeStatistics: true,
//   }
 
export async function myGetCampaignFunction(campaignId, options) {
  try {
    const result = elevatedGetCampaign(campaignId, options);

    console.log('Success! Retrieved results:', result);
    return result;
  } catch (error) {
    console.error(error);
    }
  }

/* Promise resolves to:
 * {
 *   "campaign":{
 *     "campaignId": "b98a4436-10f5-47bd-9c6f-370962adfe54",
 *     "title": "A New Tutorial for You",
 *     "firstImageUrl": "https://static.wixstatic.com/media/6191b8_77d27f7d028a4b50850b7f92dadcd578~mv2.png",
 *     "editorType": "WEB",
 *     "status": "ACTIVE",
 *     "visibilityStatus": "PUBLISHED",
 *     "distributionStatus": "DISTRIBUTED",
 *     "publishingData": {
 *       "landingPageUrl": "https://shoutout.wix.com/so/54OdUqUrf?languageTag=en",
 *       "statistics": {
 *         "landingPage": {
 *           "opened": 150,
 *           "clicked": 80
 *         },
 *         "emailCampaign": {
 *           "delivered": 700,
 *           "opened": 200,
 *           "clicked": 0,
 *           "bounced": 0,
 *           "complained": 0,
 *           "notSent": 0
 *         },
 *         "total": {
 *           "mailsSent": 1,
 *           "opened": 200,
 *           "clicked": 500
 *         }
 *       },
 *       "datePublished": "2023-08-10T09:40:59.000Z",
 *       "wasResentToNonOpeners": false
 *     },
 *     "dateCreated": "2023-08-10T09:40:47.000Z",
 *     "dateUpdated": "2023-08-10T09:40:59.045Z",
 *     "sendingState": "SENT",
 *     "campaignType": "EMAIL_MARKETING"
 *  }
 * }
 */
```

### Gets email campaign by ID
```javascript
import { campaigns } from '@wix/email-marketing';

// Sample campaignId value: 'ff61204b-b19a-5cc8-823b-7eed8ae5fc28'
  
// Sample options value:
//   {
//     optionIncludeStatistics: true,
//   }
 
export async function myGetCampaignFunction(campaignId, options) {
  try {
    const result = campaigns.getCampaign(campaignId, options);

    console.log('Success! Retrieved results:', result);
    return result;
  } catch (error) {
    console.error(error);
    }
  }

/* Promise resolves to:
 * {
 *   "campaign":{
 *     "campaignId": "b98a4436-10f5-47bd-9c6f-370962adfe54",
 *     "title": "A New Tutorial for You",
 *     "firstImageUrl": "https://static.wixstatic.com/media/6191b8_77d27f7d028a4b50850b7f92dadcd578~mv2.png",
 *     "editorType": "WEB",
 *     "status": "ACTIVE",
 *     "visibilityStatus": "PUBLISHED",
 *     "distributionStatus": "DISTRIBUTED",
 *     "publishingData": {
 *       "landingPageUrl": "https://shoutout.wix.com/so/54OdUqUrf?languageTag=en",
 *       "statistics": {
 *         "landingPage": {
 *           "opened": 150,
 *           "clicked": 80
 *         },
 *         "emailCampaign": {
 *           "delivered": 700,
 *           "opened": 200,
 *           "clicked": 0,
 *           "bounced": 0,
 *           "complained": 0,
 *           "notSent": 0
 *         },
 *         "total": {
 *           "mailsSent": 1,
 *           "opened": 200,
 *           "clicked": 500
 *         }
 *       },
 *       "datePublished": "2023-08-10T09:40:59.000Z",
 *       "wasResentToNonOpeners": false
 *     },
 *     "dateCreated": "2023-08-10T09:40:47.000Z",
 *     "dateUpdated": "2023-08-10T09:40:59.045Z",
 *     "sendingState": "SENT",
 *     "campaignType": "EMAIL_MARKETING"
 *  }
 * }
 */
```

### getCampaign (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { campaigns } from '@wix/email-marketing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { campaigns },
  // Include the auth strategy and host as relevant
});


async function getCampaign(campaignId,options) {
  const response = await myWixClient.campaigns.getCampaign(campaignId,options);
};
```

---