---
title: "Get Analytics Data"
method: GET
path: "/analytics"
tags: ["analytics"]
---

# Get Analytics Data

`GET /analytics`

## Request

- Base URL: `https://pro.api.serversmtp.com/api/v2`
- URL: `https://pro.api.serversmtp.com/api/v2/analytics`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `consumerKey` and API key in header `consumerSecret`

Get Analytics Data

## Query parameters

- `page` integer, nullable: Page number. Must be an integer greater than 0.
- `limit` integer, nullable: The number of rows per page to return. Must be an integer greater than 0.
- `from` string, date, required: Start date
- `to` string, date, required: End date
- `status[]` AnalyticMailStatus[]: Filter by Status
- `filter_by` AnalyticFilterByOption[]: Filter by
- `filter` string: Query to search
- `smart_search` boolean, nullable: Smart search
- `orderby` 'subject' | 'sender' | 'recipient' | 'send_time': Field to sort by. Valid values are subject, sender, recipient, or send_time.
- `ordertype` 'asc' | 'desc': Order Ascending or Descending.
- `tz` string: Timezone Offset

## Response `200`

Sucess

Get Analytics Data.

- AnalyticsListSucessResponsetBody
  - `count` integer
  - `results` AnalyticMailItem[]
    - `id` integer: Email Id.
    - `subject` string: Email Subject.
    - `sender` string, email: Email Sender.
    - `recipient` string, email: Email Recipient.
    - `send_time` string: Date Time email was sent.
    - `status` 'NEW' | 'DEFER' | 'SUCCESS' | 'OPEN' | 'CLICK' | 'REPORT' | 'FAIL' | 'SYSFAIL' | 'UNSUB': Send Mail Status: NEW: email has been queued for delivery DEFER: email is in the queue for delivery SUCCESS: email has been delivered. OPEN: email has been opened. CLICK: email has been clicked. REPORT: email has been reported as spam. FAIL: email has bounced. SYSFAIL: email was dropped. UNSUB: email is unsubscribed. Notice that emails that fall into the above statuses can be grouped, ie Turbo-Smtp uses the following groups: 'Clicks' = 'CLICK', 'Unsubscribes' = 'UNSUB', 'Spam' = 'REPORT', 'Drop' = 'SYSFAIL', 'Queued' = 'NEW' or 'DEFER', 'Opens'= 'OPEN' or 'CLICK' or 'UNSUB' or 'REPORT', 'Delivered'= 'SUCCESS' or 'OPEN' or 'CLICK' or 'UNSUB' or 'REPORT', 'Bounce': 'FAIL'.
    - `domain` string: The portion of the sender´s email address after the "@" symbol.
    - `recipient_domain` string: The portion of the recipient´s email address after the "@" symbol.
    - `contact_domain` string: The domain of the contact/recipient.
    - `x_campaign_id` string: Value specified in the x_campaign_id custom header to track campaigns specific data.
    - `error` string: Error returned when delivering the email message.

## Other responses

- `400`: Bad Request ###### Produces: * page_should_be_integer * page_should_be_greater_than_0 * limit_should_be_integer * limit_should_be_greater_than_0 * missing_required_parameter_from * from_format_should_be_yyyy-mm-dd * missing_required_parameter_to * to_format_should_be_yyyy-mm-dd * missing_required_parameter_filter_by * invalid_status_value * filter_by_can_only_be_subject_or_sender_or_recipient_or_domain * smart_search_should_be_true_or_false * orderby_can_only_be_subject_or_sender_or_recipient_or_domain * ordertype_should_be_asc_or_desc
- `401`: Unauthorized This API requires a valid API Key to be provided. (Use [/authentication/authorize](#/authentication/AuthenticationLogin) to obtain an API Key) Produces: * missing_authorization_key * invalid_authorization_key * account_is_inactive

---

[API](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis.md) - [All operations](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis/revisions/8503e099b215?raw)