Sign in
latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Orchestrations

View

View push campaign details.

get/orchestrations/view

Query parameters

orchestration_idstring required

The id of the push campaign to fetch.

Headers

X-Batch-Projectstring required

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

Response

Successful response with details about a push campaign.

idstring

Unique identifier for the push campaign.

type'campaign'

Type of orchestration.

namestring

Name of the orchestration.

status'draft' | 'running' | 'completed' | 'stopped'

Current status of the orchestration.

source'dashboard' | 'api'

Source of the orchestration creation.

labelsstring[]

Labels associated with the orchestration.

created_datestring date-time

Date and time when the push campaign was created.

updated_datestring date-time

Date and time when the push campaign was last updated.

start_timestring date-time

Date and time when the orchestration starts.

channelsstring[]

Channels used by the orchestration.

platformsstring[]

Platforms targeted by the orchestration.