Sign in

v51

latestOpenAPI 3.0.0AGPLv3 or laterraw.githubusercontent.com2026-08-0126276829.1 KB
schedule

Generates the Schedule events grid

get/schedule

Query parameters

eventTypeIdinteger

Filter grid by eventTypeId. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist

fromDtstring

From Date in Y-m-d H:i:s format

toDtstring

To Date in Y-m-d H:i:s format

geoAwareinteger

Flag (0-1), whether to return events using Geo Location

recurringinteger

Flag (0-1), whether to return Recurring events

campaignIdinteger

Filter events by specific campaignId

displayGroupIdsinteger[]

Filter events by an array of Display Group Ids

sortBy'eventId' | 'eventTypeId' | 'name' | 'fromDt' | 'toDt' | 'campaign' | 'campaignId' | 'shareOfVoice' | 'maxPlaysPerHour' | 'isGeoAware' | 'recurringEvent' | 'recurrenceType' | 'recurrenceDetail' | 'recurrenceRepeatsOn' | 'recurrenceRange' | 'isPriority' | 'criteria' | 'createdOn' | 'updatedOn' | 'modifiedByName'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

eventIdinteger

The ID of this Event

eventTypeIdinteger

The Event Type ID

campaignIdinteger

The CampaignID this event is for

commandIdinteger

The CommandId this event is for

userIdinteger

The userId that owns this event.

fromDtinteger

A Unix timestamp representing the from date of this event in CMS time.

toDtinteger

A Unix timestamp representing the to date of this event in CMS time.

isPriorityinteger

Integer indicating the event priority.

displayOrderinteger

The display order for this event.

recurrenceType'None' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Year'

If this event recurs when what is the recurrence period.

recurrenceDetailinteger

If this event recurs when what is the recurrence frequency.

recurrenceRangeinteger

A Unix timestamp indicating the end time of the recurring events.

recurrenceRepeatsOnstring

Recurrence repeats on days - 0 to 7 where 0 is a monday

recurrenceMonthlyRepeatsOninteger

Recurrence monthly repeats on - 0 is day of month, 1 is weekday of week

campaignstring

The Campaign/Layout Name

commandstring

The Command Name

dayPartIdinteger

The Day Part Id

isAlwaysinteger

Is this event an always on event?

isCustominteger

Does this event have custom from/to date times?

syncEventinteger

Flag indicating whether the event should be synchronised across displays

syncTimezoneinteger

Flag indicating whether the event will sync to the Display timezone

shareOfVoiceinteger

Seconds (0-3600) of each full hour that is scheduled that this Layout should occupy

maxPlaysPerHourinteger

The maximum number of plays per hour per display for this event

isGeoAwareinteger

Flag (0-1), whether this event is using Geo Location

geoLocationstring

Geo JSON representing the area of this event

actionTriggerCodestring

For Action event type, Action trigger code

actionTypestring

For Action event type, the type of the Action (navigate to Layout or Command)

actionLayoutCodestring

For Action event type and navigate to Layout Action type, the Layout code

parentCampaignIdinteger

If the schedule should be considered part of a larger campaign

syncGroupIdinteger

For sync events, the id the the sync group

dataSetIdinteger

For data connector events, the dataSetId

dataSetParamsinteger

For data connector events, the data set parameters

modifiedByinteger

The userId of the user that last modified this Schedule

createdOnstring

The Date this Schedule was created on

updatedOnstring

The Date this Schedule was las updated on

namestring

The name of this Scheduled Event

resolutionIdinteger

The resolutionId of this Fullscreen Scheduled Event

layoutDurationinteger

The duration of this Fullscreen Scheduled Event

backgroundColorstring

The background color of this Fullscreen Scheduled Event