---
title: "Stats"
method: GET
path: "/orchestrations/stats"
tags: ["Orchestrations"]
---

# Stats

`GET /orchestrations/stats`

Get statistics about an orchestration.

## Query parameters

- `orchestration_id` string, required
- `from` string, date, required
- `to` string, date, required
- `include_platforms` boolean

## Headers

- `X-Batch-Project` string, required

## Response `200`

Successful response with statistics about an orchestration.

- union
  - object — Statistics about a Campaign, Recurring or Warmup orchestration.
    - `id` string — Unique identifier for the orchestration.
    - `details` object[]
      - `sent` integer — Number of messages sent.
      - `delivered` integer — Number of messages delivered.
      - `sent_optin` integer — Number of messages sent to opt-in users.
      - `unique_open` integer — Number of unique open of the message.
      - `unique_direct_open` integer — Number of unique direct open of the message.
      - `total_open` integer — Total number of opened messages.
      - `unique_machine_open` integer — Number of unique machine open of the message.
      - `unique_click` integer — Number of unique click on the message.
      - `total_click` integer — Total number of clicks on the message.
      - `spam` integer — Number of messages flagged as spam.
      - `unsubscribe` integer — Number of unsubscription from the message.
      - `total_bounce` integer — Total number of rejected messages.
      - `skipped` integer — Total number of skipped messages.
      - `unique_conversion` integer — Number of unique conversions attributed to the message.
      - `total_conversion` integer — Total number of conversions attributed to the message.
      - `total_revenue` number, float — Total revenue attributed to the message.
      - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
      - `dismissed` integer — Number of times the push notification was dismissed by the user.
      - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
      - `date` string, date — Date of the statistic.
      - `platform` object[] — Statistics broken down by platform.
        - `platform` 'ANDROID' | 'IOS' | 'WEB' — The platform name.
        - `sent` integer — Number of messages sent.
        - `delivered` integer — Number of messages delivered.
        - `sent_optin` integer — Number of messages sent to opt-in users.
        - `unique_open` integer — Number of unique open of the message.
        - `unique_direct_open` integer — Number of unique direct open of the message.
        - `total_open` integer — Total number of opened messages.
        - `unique_machine_open` integer — Number of unique machine open of the message.
        - `unique_click` integer — Number of unique click on the message.
        - `total_click` integer — Total number of clicks on the message.
        - `spam` integer — Number of messages flagged as spam.
        - `unsubscribe` integer — Number of unsubscription from the message.
        - `total_bounce` integer — Total number of rejected messages.
        - `skipped` integer — Total number of skipped messages.
        - `unique_conversion` integer — Number of unique conversions attributed to the message.
        - `total_conversion` integer — Total number of conversions attributed to the message.
        - `total_revenue` number, float — Total revenue attributed to the message.
        - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
        - `dismissed` integer — Number of times the push notification was dismissed by the user.
        - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
      - `versions` object[] — Statistics about each version of the orchestration when A/B testing.
        - `sent` integer — Number of messages sent.
        - `delivered` integer — Number of messages delivered.
        - `sent_optin` integer — Number of messages sent to opt-in users.
        - `unique_open` integer — Number of unique open of the message.
        - `unique_direct_open` integer — Number of unique direct open of the message.
        - `total_open` integer — Total number of opened messages.
        - `unique_machine_open` integer — Number of unique machine open of the message.
        - `unique_click` integer — Number of unique click on the message.
        - `total_click` integer — Total number of clicks on the message.
        - `spam` integer — Number of messages flagged as spam.
        - `unsubscribe` integer — Number of unsubscription from the message.
        - `total_bounce` integer — Total number of rejected messages.
        - `skipped` integer — Total number of skipped messages.
        - `unique_conversion` integer — Number of unique conversions attributed to the message.
        - `total_conversion` integer — Total number of conversions attributed to the message.
        - `total_revenue` number, float — Total revenue attributed to the message.
        - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
        - `dismissed` integer — Number of times the push notification was dismissed by the user.
        - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
        - `version` string — The version identifier, ranging from `a` to `d`.
        - `platform` object[] — Statistics broken down by platform.
          - `platform` 'ANDROID' | 'IOS' | 'WEB' — The platform name.
          - `sent` integer — Number of messages sent.
          - `delivered` integer — Number of messages delivered.
          - `sent_optin` integer — Number of messages sent to opt-in users.
          - `unique_open` integer — Number of unique open of the message.
          - `unique_direct_open` integer — Number of unique direct open of the message.
          - `total_open` integer — Total number of opened messages.
          - `unique_machine_open` integer — Number of unique machine open of the message.
          - `unique_click` integer — Number of unique click on the message.
          - `total_click` integer — Total number of clicks on the message.
          - `spam` integer — Number of messages flagged as spam.
          - `unsubscribe` integer — Number of unsubscription from the message.
          - `total_bounce` integer — Total number of rejected messages.
          - `skipped` integer — Total number of skipped messages.
          - `unique_conversion` integer — Number of unique conversions attributed to the message.
          - `total_conversion` integer — Total number of conversions attributed to the message.
          - `total_revenue` number, float — Total revenue attributed to the message.
          - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
          - `dismissed` integer — Number of times the push notification was dismissed by the user.
          - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
  - object — Statistics about a Trigger Automation orchestration.
    - `id` string — Unique identifier for the orchestration.
    - `details` object[]
      - `sent` integer — Number of messages sent.
      - `delivered` integer — Number of messages delivered.
      - `sent_optin` integer — Number of messages sent to opt-in users.
      - `unique_open` integer — Number of unique open of the message.
      - `unique_direct_open` integer — Number of unique direct open of the message.
      - `total_open` integer — Total number of opened messages.
      - `unique_machine_open` integer — Number of unique machine open of the message.
      - `unique_click` integer — Number of unique click on the message.
      - `total_click` integer — Total number of clicks on the message.
      - `spam` integer — Number of messages flagged as spam.
      - `unsubscribe` integer — Number of unsubscription from the message.
      - `total_bounce` integer — Total number of rejected messages.
      - `skipped` integer — Total number of skipped messages.
      - `unique_conversion` integer — Number of unique conversions attributed to the message.
      - `total_conversion` integer — Total number of conversions attributed to the message.
      - `total_revenue` number, float — Total revenue attributed to the message.
      - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
      - `dismissed` integer — Number of times the push notification was dismissed by the user.
      - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
      - `date` string, date — Date of the statistic.
      - `platform` object[] — Statistics broken down by platform.
        - `platform` 'ANDROID' | 'IOS' | 'WEB' — The platform name.
        - `sent` integer — Number of messages sent.
        - `delivered` integer — Number of messages delivered.
        - `sent_optin` integer — Number of messages sent to opt-in users.
        - `unique_open` integer — Number of unique open of the message.
        - `unique_direct_open` integer — Number of unique direct open of the message.
        - `total_open` integer — Total number of opened messages.
        - `unique_machine_open` integer — Number of unique machine open of the message.
        - `unique_click` integer — Number of unique click on the message.
        - `total_click` integer — Total number of clicks on the message.
        - `spam` integer — Number of messages flagged as spam.
        - `unsubscribe` integer — Number of unsubscription from the message.
        - `total_bounce` integer — Total number of rejected messages.
        - `skipped` integer — Total number of skipped messages.
        - `unique_conversion` integer — Number of unique conversions attributed to the message.
        - `total_conversion` integer — Total number of conversions attributed to the message.
        - `total_revenue` number, float — Total revenue attributed to the message.
        - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
        - `dismissed` integer — Number of times the push notification was dismissed by the user.
        - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
      - `message_steps` object[] — Statistics about each message steps.
        - `sent` integer — Number of messages sent.
        - `delivered` integer — Number of messages delivered.
        - `sent_optin` integer — Number of messages sent to opt-in users.
        - `unique_open` integer — Number of unique open of the message.
        - `unique_direct_open` integer — Number of unique direct open of the message.
        - `total_open` integer — Total number of opened messages.
        - `unique_machine_open` integer — Number of unique machine open of the message.
        - `unique_click` integer — Number of unique click on the message.
        - `total_click` integer — Total number of clicks on the message.
        - `spam` integer — Number of messages flagged as spam.
        - `unsubscribe` integer — Number of unsubscription from the message.
        - `total_bounce` integer — Total number of rejected messages.
        - `skipped` integer — Total number of skipped messages.
        - `unique_conversion` integer — Number of unique conversions attributed to the message.
        - `total_conversion` integer — Total number of conversions attributed to the message.
        - `total_revenue` number, float — Total revenue attributed to the message.
        - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
        - `dismissed` integer — Number of times the push notification was dismissed by the user.
        - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
        - `step_id` string — The API identifier of the step.
        - `platform` object[] — Statistics broken down by platform.
          - `platform` 'ANDROID' | 'IOS' | 'WEB' — The platform name.
          - `sent` integer — Number of messages sent.
          - `delivered` integer — Number of messages delivered.
          - `sent_optin` integer — Number of messages sent to opt-in users.
          - `unique_open` integer — Number of unique open of the message.
          - `unique_direct_open` integer — Number of unique direct open of the message.
          - `total_open` integer — Total number of opened messages.
          - `unique_machine_open` integer — Number of unique machine open of the message.
          - `unique_click` integer — Number of unique click on the message.
          - `total_click` integer — Total number of clicks on the message.
          - `spam` integer — Number of messages flagged as spam.
          - `unsubscribe` integer — Number of unsubscription from the message.
          - `total_bounce` integer — Total number of rejected messages.
          - `skipped` integer — Total number of skipped messages.
          - `unique_conversion` integer — Number of unique conversions attributed to the message.
          - `total_conversion` integer — Total number of conversions attributed to the message.
          - `total_revenue` number, float — Total revenue attributed to the message.
          - `revenue_per_mille` number, float — Revenue generated per thousand messages sent.
          - `dismissed` integer — Number of times the push notification was dismissed by the user.
          - `displayed` integer — Number of in-app messages displayed as a result of a push notification click. Only present for push notification orchestrations.
  - object — Statistics about an InApp Orchestration.
    - `id` string — Unique identifier for the orchestration.
    - `details` object[]
      - `date` string, date — Date of the statistic.
      - `delivered` number — Number of delivered mobile landings.
      - `unique_click` number — Number of unique clicks on the mobile landing.
      - `total_click` number — Total number of clicks on the mobile landing.
      - `dismissed` number — Number of times the mobile landing was dismissed.
      - `versions` object[] — Statistics about each version of the orchestration when A/B testing.
        - `delivered` number — Number of delivered mobile landings.
        - `unique_click` number — Number of unique clicks on the mobile landing.
        - `total_click` number — Total number of clicks on the mobile landing.
        - `dismissed` number — Number of times the mobile landing was dismissed.

## Other responses

- `400` — The request is malformed
- `401` — The Rest API Key is not valid for this project
- `429` — Too Many Requests
- `500` — Unexpected error
- `503` — Batch's services are under maintenance. Please try again later

---

[API](https://skmtc.net/batch/apis/batch-rest-api.md) · [All operations](https://skmtc.net/batch/apis/batch-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/batch/batch-rest-api/revisions/ec696334ff35/schema)
