# Open Statistics (deprecated)

Retrieve aggregated statistics on emails opened at least once by their recipients. If no query parameters are used, the statistics shown will be for open events since 00:00 UTC on the current day.

> Note: This is a legacy endpoint. We advise using /statcounters to retrieve message-based aggregated stats.

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

## Query parameters:

  - `CampaignID` (integer)
    Retrieves open statistics only for the specified Campaign ID.

  - `ContactsList` (integer)
    Retrieves open statistics only for the specified contact list ID.

  - `CustomCampaign` (string)
    Retrieves open statistics only for the campaign with the specified Custom Value.

  - `From` (string)
    Retrieves open statistics only for messages sent from the specified Sender Email address.

  - `FromDomain` (string)
    Retrieves open statistics only for messages sent from the specified domain.

  - `FromID` (integer)
    Retrieves open statistics only for messages sent from the sender address with the specified ID.

  - `FromTS` (string)
    Retrieves open statistics only for messages sent after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

> If no query parameters are used, FromTS defaults to the current day at 00:00 UTC.

  - `FromType` (integer)
    Retrieves open statistics only for a specific type of messages:

- 1 - Transactional
- 2 - Marketing
- 3 - Unknown

  - `IsDeleted` (boolean)
    When true, will retrieve open statistics only for deleted campaigns. When false, stats for deleted campaigns will be excluded from the response.

  - `IsNewsletterTool` (boolean)
    When true, will retrieve open statistics only for campaigns created with the Legacy template builder. When false, campaigns created with the Legacy builder will be excluded from the response.

  - `IsStarred` (boolean)
    When true, will retrieve open statistics only for starred campaigns. When false, starred campaigns will be excluded from the response.

  - `MessageStatus` (integer)
    Retrieves open statistics only for messages with the specified status:

- 0 (Processed)
- 1 (Queued)
- 2 (Sent)
- 3 (Opened)
- 4 (Clicked)
- 5 (Bounce)
- 6 (Spam)
- 7 (Unsub)
- 8 (Blocked)
- 9 (SoftBounce)
- 10 (HardBounce)
- 11 (Deferred)

  - `Period` (string)
    Retrieves open statistics only for messages sent between the start of the selected period and the current timestamp.

- Day - since the start of the current day
- Week - since the start of the current week
- Month - since the start of the current month
- Year - since the start of the current year

  - `ToTS` (string)
    Retrieves open statistics only for messages sent before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

## 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.OpenedCount` (integer)
    Number of opened messages.

  - `Data.OpenedDelay` (number)
    Average delay (in seconds) between the sending of the message and the open event.

  - `Data.ProcessedCount` (integer)
    Number of processed messages.

  - `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