---
title: "View"
method: GET
path: "/orchestrations/view"
tags: ["Orchestrations"]
---

# View

`GET /orchestrations/view`

View push campaign details.

## Query parameters

- `orchestration_id` string, required

## Headers

- `X-Batch-Project` string, required

## Response `200`

Successful response with details about a push campaign.

- PushCampaignDetails — Detailed configuration for a push campaign orchestration.
  - `id` string — Unique identifier for the push campaign.
  - `type` 'campaign' — Type of orchestration.
  - `name` string — Name of the orchestration.
  - `status` 'draft' | 'running' | 'completed' | 'stopped' — Current status of the orchestration.
  - `source` 'dashboard' | 'api' — Source of the orchestration creation.
  - `labels` string[] — Labels associated with the orchestration.
  - `created_date` string, date-time — Date and time when the push campaign was created.
  - `updated_date` string, date-time — Date and time when the push campaign was last updated.
  - `start_time` string, date-time — Date and time when the orchestration starts.
  - `channels` string[] — Channels used by the orchestration.
  - `platforms` string[] — Platforms targeted by the orchestration.
  - `ab_test` object — A/B test configuration for the push campaign.
    - `enabled` boolean — Whether A/B testing is enabled.
    - `automatic_winner_selection` object — Automatic winner selection settings for the A/B test.
      - `test_percentage` integer — Percentage of the audience used during the test phase.
      - `winner_metric` string — Metric used to determine the winning variant.
      - `winner_delay` object — Delay before selecting the winning variant.
        - `value` integer — Delay amount before winner selection.
        - `unit` string — Unit used for the winner selection delay.
  - `targeting` object — Targeting configuration for the push campaign.
    - `languages` string[] — Languages targeted by the orchestration.
    - `regions` string[] — Regions targeted by the orchestration.
    - `query` object — Query used to filter targeted profiles.
  - `messages` object[] — Message definitions for the push campaign. Each item contains the default push content in `push_content`, optional language-specific overrides in `languages`, and, when A/B testing is enabled, an optional `version` identifying the variant. Provide one item per variant.
    - `version` string — Optional identifier of the A/B test variant.
    - `push_content` PushCampaignPushContent — Details and configuration for a push message.
      - `title` string — Title of the message.
      - `body` string — Body of the message.
      - `media` PushCampaignMedia — Media assets attached to the push message.
        - `picture` string, uri — URL of the main picture asset.
        - `icon` string, uri — URL of the icon asset.
      - `ios` object — iOS-specific push message options.
        - `deeplink` string, uri — Deeplink opened on iOS devices.
        - `custom_payload` string — Custom payload sent with the iOS notification.
      - `android` object — Android-specific push message options.
        - `deeplink` string, uri — Deeplink opened on Android devices.
        - `custom_payload` string — Custom payload sent with the Android notification.
        - `media` PushCampaignMedia — Media assets attached to the push message.
          - `picture` string, uri — URL of the main picture asset.
          - `icon` string, uri — URL of the icon asset.
        - `collapse_key` object — Android collapse key configuration.
          - `enabled` boolean — Whether collapse key handling is enabled.
          - `key` string — Collapse key value.
      - `web` object — Web-specific push message options.
        - `deeplink` string, uri — Deeplink opened on web devices.
        - `media` PushCampaignMedia — Media assets attached to the push message.
          - `picture` string, uri — URL of the main picture asset.
          - `icon` string, uri — URL of the icon asset.
      - `mobile_landing` object[] — Mobile landing content attached to the push message.
        - `key` string — Unique identifier of the mobile landing item.
        - `action` string — Action payload triggered by the mobile landing item.
        - `text` string — Text displayed for the mobile landing item.
        - `url` string, uri — URL used by image mobile landing items.
        - `ios` string — iOS-specific override for the mobile landing item.
        - `android` string — Android-specific override for the mobile landing item.
    - `languages` object[] — Optional language-specific overrides for `push_content`.
      - `language` string — Language code for this localized content.
      - `push_content` PushCampaignPushContent — Details and configuration for a push message.
        - `title` string — Title of the message.
        - `body` string — Body of the message.
        - `media` PushCampaignMedia — Media assets attached to the push message.
          - `picture` string, uri — URL of the main picture asset.
          - `icon` string, uri — URL of the icon asset.
        - `ios` object — iOS-specific push message options.
          - `deeplink` string, uri — Deeplink opened on iOS devices.
          - `custom_payload` string — Custom payload sent with the iOS notification.
        - `android` object — Android-specific push message options.
          - `deeplink` string, uri — Deeplink opened on Android devices.
          - `custom_payload` string — Custom payload sent with the Android notification.
          - `media` PushCampaignMedia — Media assets attached to the push message.
            - `picture` string, uri — URL of the main picture asset.
            - `icon` string, uri — URL of the icon asset.
          - `collapse_key` object — Android collapse key configuration.
            - `enabled` boolean — Whether collapse key handling is enabled.
            - `key` string — Collapse key value.
        - `web` object — Web-specific push message options.
          - `deeplink` string, uri — Deeplink opened on web devices.
          - `media` PushCampaignMedia — Media assets attached to the push message.
            - `picture` string, uri — URL of the main picture asset.
            - `icon` string, uri — URL of the icon asset.
        - `mobile_landing` object[] — Mobile landing content attached to the push message.
          - `key` string — Unique identifier of the mobile landing item.
          - `action` string — Action payload triggered by the mobile landing item.
          - `text` string — Text displayed for the mobile landing item.
          - `url` string, uri — URL used by image mobile landing items.
          - `ios` string — iOS-specific override for the mobile landing item.
          - `android` string — Android-specific override for the mobile landing item.

## Other responses

- `401` — The Rest API Key is not valid for this project
- `403` — The provided id resolves to an orchestration that is not a push campaign.
- `404` — The provided orchestration id does not match any orchestration.
- `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)