# Campaign Overview List

Retrieve delivery and engagement statistics for all drafts, AB Testing objects or sent campaigns. In addition, for each object you will see its type, edit tool used and creation time, as well as general info like the title and subject line for the campaign.

Endpoint: GET /v3/REST/campaignoverview
Version: 1.0.0
Security: basicAuth

## Query parameters:

  - `All` (boolean)
    When true, will retrieve all campaigns, drafts and AB Testing objects that are not deleted (IsDeleted!=0). When false, both deleted and non-deleted ones will be retrieved.

Default value: false

> Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True.

  - `Archived` (boolean)
    When true, will retrieve all archived campaigns, drafts and AB Testing objects. When false, archived ones are excluded from the response.

Default value: false

> Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True.

  - `Drafts` (boolean)
    When true, will retrieve all drafts (and AB Testing objects in Draft mode). When false, both drafts and sent campaigns / AB Testing objects will be retrieved.

Default value: false

> Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True.

  - `ID` (integer)
    Retrieves only the draft, sent campaign or AB testing object linked to this unique numeric ID.

> Note: Mandatory, when the ID query parameter is used.

  - `IDType` (string)
    Retrieves only objects of the specified type:

- Campaign - Sent campaign
- AX - AB Testing object
- NL - Draft

> Note: Mandatory, when the ID query parameter is used.

  - `Programmed` (boolean)
    When true, will retrieve only drafts that are scheduled for sending - i.e. with Programmed status. When false, both programmed and draft / sent / deleted objects will be retrieved.

Default value: false

> Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True.

  - `Sent` (boolean)
    When true, will retrieve only sent campaigns. When false, both sent and not sent objects will be retrieved.

> Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True.

  - `Starred` (boolean)
    When true, will retrieve only starred campaigns, drafts and AB Testing objects. When false, both starred and non-starred ones will be retrieved.

Default value: false

> Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True.

  - `Subject` (string)
    Retrieves only campaigns, drafts and AB Testing objects with the specified subject line.

## Response 200 fields (application/json):

  - `Count` (integer)
    Indicates the number of objects in the Data array.

  - `Data` (array)
    A JSON array containing a list of objects returned by this endpoint.

  - `Data.ClickedCount` (integer)
    Indicates the number of clicked messages for this object.

  - `Data.DeliveredCount` (integer)
    Indicates the number of delivered messages for this object.

  - `Data.EditMode` (string)
    Indicates the type of template editor used for this campaign / draft / AB Testing object:

- tool - Legacy drag-and-drop template editor
- html - Legacy HTML editor
- tool2 - Passport drag-and-drop template editor
- html2 - HTML editor in Passport
- mjml - MJML editor in Passport

  - `Data.EditType` (string)
    Indicates the edit type used for this object:

- full
- unknown

  - `Data.ID` (integer)
    Unique numeric ID of this campaign / draft / AB Testing object.

  - `Data.IDType` (string)
    Indicates the type of the object:

- Campaign - Sent campaign
- AX - AB Testing object
- NL - Draft

  - `Data.OpenedCount` (integer)
    Indicates the number of opened messages for this object.

  - `Data.ProcessedCount` (integer)
    Indicates the number of processed messages for this object.

  - `Data.SendTimeStart` (integer)
    For drafts, this will show the creation time of the draft. For sent campaigns, it will display the sending time. Format - Unix timestamp.

  - `Data.Starred` (boolean)
    Indicates whether this object is marked as starred or not.

  - `Data.Subject` (string)
    Subject line for this campaign / draft / AB Testing object.

  - `Data.Title` (string)
    Internal user-selected title for this campaign / draft / AB Testing object.

  - `Data.Status` (integer)
    The status of the campaign or draft.

  - `Total` (integer)
    Indicates the number of objects in the Data array.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields