> For the complete documentation index, see [llms.txt](https://codemash.gitbook.io/codemash/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codemash.gitbook.io/codemash/cloud/emails/campaigns/details.md).

# Campaign details

The details of one email campaign — status, planned time, template, provider, numbers and batches.

**Where:** Email → Campaigns → **View** · `/projects/<project>/emails/campaigns/<campaignId>/view`

The **Email Campaign** page answers "how is my campaign doing?": its status, when it was sent, which template and provider it used, how many emails went out, and its batches. From here you open the [message log](/codemash/cloud/emails/campaigns/log.md), [stop](/codemash/cloud/emails/campaigns/stop.md) the campaign, or create a new one from it.

## Before you start

* A campaign — [create one](/codemash/cloud/emails/campaigns/new.md). Permission `email:read` to open it.

## Steps

1. In **Email → Campaigns**, press **View** on a row. **General Information** shows:

   | Row                                    | What it shows                                                                                  | Example                                    |
   | -------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------ |
   | (id and badge)                         | The campaign id (copy button) and its status                                                   | `cmp_1Q7siIAh4JJ4WDhTTJIt0U` **Completed** |
   | Initiated                              | When it was created, then when it is delivered: **Instantly**, or the planned time in its zone | `2026-10-06 14:01 —>Deliver Instantly`     |
   | Status                                 | The last status                                                                                | `Completed`                                |
   | Template                               | `[ language ]` and the template name, a link to its editor (system templates are not linked)   | `[ en ] Welcome email`                     |
   | Deliver strategy                       | How recipients were chosen                                                                     | `All users`                                |
   | Deliver with respect to user time zone | Always **No** for campaigns made in Cloud                                                      | `No`                                       |

   <figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-35368ac62d119bed8102eca7071de72885563550%2Fcampaigns-details-1.png?alt=media" alt="Email Campaign page: campaign id with Completed badge, Initiated Deliver Instantly, Status Completed, Template [ en ] Welcome email, Deliver strategy All users"><figcaption><p>General Information of a completed campaign.</p></figcaption></figure>
2. Scroll down. The provider block names the integration (**Email Provider - Fake**, **Test Me (Default)**) with **See integration details**. The four tiles count **Batches**, **Sent Emails**, **Failed** and **Success rate**. Below them is the batch list, with a filter by **Batch ID** (`cmpb_…`) or **Email Address**.

   <figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-f65ba2717ee7e703968bb3d0da5a2859048b9ba4%2Fcampaigns-details-2.png?alt=media" alt="Provider block Test Me (Default), tiles Batches 1, Sent Emails 3, Failed 0, Success rate 100 %, batch filter and one batch with 3 recipient(s)"><figcaption><p>Provider, numbers and the batch list.</p></figcaption></figure>
3. Press a batch (`3 recipient(s)`) to open its messages — see [Read the message log](/codemash/cloud/emails/campaigns/log.md).

## Result

A campaign that went out well shows **Completed**, **Failed 0** and **Success rate 100 %**. A campaign that failed shows a red **Campaign Failed** box listing every error message and its code — for example a template that now misses a project language (`CM-ERRORS-LANGUAGES-004`) or a provider that was disabled before it started (`CM-ERRORS-INTEGRATIONS-005`).

## Change or remove it later

**Actions** in the top right:

<figure><img src="https://712692422-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHy372bqsaex2cqS3ikhL%2Fuploads%2Fgit-blob-1a81949c1b18472dd115fef2070bf9aa3ff4b7f5%2Fcampaigns-details-3.png?alt=media" alt="Actions menu: Create new from this, Delete campaign..., See documentation"><figcaption><p>The Actions menu.</p></figcaption></figure>

* **Create new from this** — opens [the campaign form](/codemash/cloud/emails/campaigns/new.md) with the same template picked (off when the campaign used a system template).
* **Delete campaign...** — only for a Completed, Stopped or Failed campaign. The browser asks "Delete this campaign? Its batches and message log are deleted with it. This cannot be undone."; after **OK** you are back on the list.
* **See documentation** — opens this page.
* **Stop campaign** (red, next to Actions) — while the campaign is scheduled or sending: [Stop a campaign](/codemash/cloud/emails/campaigns/stop.md).

## Do it from code

```ts
const id = 'cmp_7mt3e31YJCj3DNk2oDWxNc';
const { item } = await norbix.hub.notifications.getEmailCampaign({ id });
const { stats } = await norbix.hub.notifications.getEmailCampaignStatistics({ id });
console.log(item.statusHistory.at(-1).status, stats); // Completed { batches: 1, sent: 3, failed: 0, successRate: 100 }
```

```sh
norbix hub notifications email campaign statistics get --id cmp_7mt3e31YJCj3DNk2oDWxNc
```

API: [Get Email Campaign](/codemash/api-reference/notifications/email/get-email-campaign.md) · [Get Email Campaign Statistics](/codemash/api-reference/notifications/email/get-email-campaign-statistics.md) · [Delete Email Campaign](/codemash/api-reference/notifications/email/delete-email-campaign.md)