View Push Campaign

View

get

View push campaign details.

Authorizations

rest_key

AuthorizationstringRequired

API Key Authentication

Authentication is required in order to interact with Batch's APIs.

Batch implements authentication using API Keys, that we call the "REST API Key". You can find it on your dashboard.

Please make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would easily be extractable.

How to authenticate

In order to authenticate your requests, add your REST API Key in the Authorization header and prefix it by Bearer. Example: Authorization: Bearer bcd38d9rfb38ra28.

Query parameters

orchestration_idstringRequired

The id of the push campaign to fetch.

Example: orchestration_0664hyh918hr1gnzka9py5t62nrc0e1q

Header parameters

X-Batch-ProjectstringRequired

The unique project key, identifying a project on the Batch platform

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6

Responses

200

Successful response with details about a push campaign.

application/json

Detailed configuration for a push campaign orchestration.

idstringOptional

Unique identifier for the push campaign.

Example: orchestration_0664hyh918hr1gnzka9py5t62nrc0e1q

typestring · enumOptional

Type of orchestration.

Example: campaignPossible values:

namestringOptional

Name of the orchestration.

Example: Soldes d'été

statusstring · enumOptional

Current status of the orchestration.

Example: runningPossible values:

sourcestring · enumOptional

Source of the orchestration creation.

Example: dashboardPossible values:

labelsstring[]Optional

Labels associated with the orchestration.

Example: ["LABEL1","LABEL2"]

created_datestring · date-timeOptional

Date and time when the push campaign was created.

Example: 2026-03-18T09:15:00Z

updated_datestring · date-timeOptional

Date and time when the push campaign was last updated.

Example: 2026-04-12T16:40:00Z

start_timestring · date-timeOptional

Date and time when the orchestration starts.

Example: 2026-04-20T14:00:00Z

401

The Rest API Key is not valid for this project

application/json

403

The provided id resolves to an orchestration that is not a push campaign.

application/json

404

The provided orchestration id does not match any orchestration.

application/json

429

Too Many Requests

application/json

500

Unexpected error

application/json

503

Batch's services are under maintenance. Please try again later

application/json

get

/orchestrations/view

HTTPcURLJavaScriptPython

GET /2.11/orchestrations/view?orchestration_id=text HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Accept: */*

{
  "id": "orchestration_0664hyh918hr1gnzka9py5t62nrc0e1q",
  "type": "campaign",
  "name": "Soldes d'été",
  "status": "running",
  "source": "dashboard",
  "labels": [
    "LABEL1",
    "LABEL2"
  ],
  "created_date": "2026-03-18T09:15:00Z",
  "updated_date": "2026-04-12T16:40:00Z",
  "start_time": "2026-04-20T14:00:00Z",
  "channels": [
    "push"
  ],
  "platforms": [
    "ios",
    "android",
    "web"
  ],
  "targeting": {
    "languages": [
      "fr"
    ],
    "regions": [
      "FR"
    ],
    "query": {
      "firstname": {
        "$eq": "Jane"
      }
    }
  },
  "messages": [
    {
      "push_content": {
        "title": "The campaign title",
        "body": "The campaign body",
        "media": {
          "picture": "https://example.com/picture.png"
        },
        "ios": {
          "deeplink": "https://example.com/ios",
          "custom_payload": "{\"tag\": \"wake up push\", \"landing_screen\": \"greeting\"}"
        },
        "android": {
          "deeplink": "https://example.com/android",
          "custom_payload": "{\"tag\": \"wake up push\", \"landing_screen\": \"greeting\"}",
          "media": {
            "icon": "https://example.com/android/icon.png"
          },
          "collapse_key": {
            "enabled": true,
            "key": "default"
          }
        },
        "web": {
          "deeplink": "https://example.com/web",
          "media": {
            "icon": "https://example.com/web/icon.png"
          }
        }
      }
    }
  ]
}

Request structure

Route

The orchestration API exposes a GET endpoint that allows you to export message details for a specific Push Campaign. This includes information such as targeting query, push content, mobile landing keys.

/orchestrations/view

Headers and authentication

See Overview → Using Project APIs.

Query parameters

See the API Description.

Responses

Success

A successful GET request to this endpoint will return an HTTP 200 OK response. The body of the response will contain a JSON object with the details for the requested orchestration.

Response Body

The main JSON object contains the following fields:

• id (string): The unique identifier of the push campaign for which details are being returned.

• messages (array): An array of objects, where each object contains the push content. This can include:

  • Variant Detail for A/B tested orchestrations.

  • Multi-language Detail.

{
  "id": "orchestration_0664hyh918hr1gnzka9py5t62nrc0e1q",
  "type": "campaign",
  "name": "Soldes d'été",
  "status": "running",
  "source": "dashboard",
  "labels": [
    "LABEL1",
    "LABEL2"
  ],
  "created_date": "2026-03-18T09:15:00Z",
  "updated_date": "2026-04-12T16:40:00Z",
  "start_time": "2026-04-20T14:00:00Z",
  "channels": [
    "push"
  ],
  "platforms": [
    "ios",
    "android",
    "web"
  ],
  "targeting": {
    "languages": [
      "fr"
    ],
    "regions": [
      "FR"
    ],
    "query": {
      "firstname": {
        "$eq": "Jane"
      }
    }
  },
  "messages": [
    {
      "push_content": {
        "title": "The campaign title",
        "body": "The campaign body",
        "media": {
          "picture": "https://example.com/picture.png"
        },
        "ios": {
          "deeplink": "https://example.com/ios",
          "custom_payload": "{\"tag\": \"wake up push\", \"landing_screen\": \"greeting\"}"
        },
        "android": {
          "deeplink": "https://example.com/android",
          "custom_payload": "{\"tag\": \"wake up push\", \"landing_screen\": \"greeting\"}",
          "media": {
            "icon": "https://example.com/android/icon.png"
          },
          "collapse_key": {
            "enabled": true,
            "key": "default"
          }
        },
        "web": {
          "deeplink": "https://example.com/web",
          "media": {
            "icon": "https://example.com/web/icon.png"
          }
        }
      }
    }
  ]
}

Failure

If the GET data does not meet the API requirements you will receive an actionable error message. Contact us at [email protected] if you need further support.

See the list of potential failures in the API Description.