Broadsign Air API

The Broadsign Air API allows developers to generate a playlist.

The Broadsign Air API supports an HTTP authentication token that is included in the “Authorization” header of the HTTPS requests to the REST API, as defined in RFC 7235.

Broadsign Air Hostname

The Broadsign Air hostname is https://air.broadsign.com/.

The following playlist service behavior applies:

Rate Limiting:

  • If a player requests a playlist more frequently than once per minute, it will receive a 429 Too Many Requests error.

Playlist Generation and Caching:

  • The playlist service generates playlists based on the requested duration (or defaults to one hour if no duration is specified).
  • If the playlist includes Broadsign Reach bids, only the first 10 minutes of the playlist will have executed bids and filled slots in Broadsign Reach.
  • The majority of the playlist is pre-generated, cached, and periodically refreshed.
  • Subsequent playlist requests from other players within the same venue will be served from this cached playlist to maintain synchronization.

Bidding and Player Check-Ins:

  • The playlist service cannot issue bids to Broadsign Reach for players that are not actively checking in.
  • For multiple players in the same venue, a bid will be sent only once for any given slot, regardless of how many times the players request the playlist.

Bid Management for the First 10 Minutes:

  • For demand sources integrated with Broadsign Reach, the system handles bids transparently during the initial 10 minutes of each playlist item.
  • If suitable ads are found through Broadsign Reach bidding, they are inserted into the playlist.
  • If no ads are available via Broadsign Reach, the playlist follows the predefined rules for prioritizing direct-sold campaigns.
  • In some cases, if no suitable content is available from either Broadsign Reach or priority campaigns, the slot might remain unfilled. This can result in the over-performance of direct-sold campaigns.

Playlist Filling for the Remaining Duration:

  • After the first 10 minutes of a playlist item, all Broadsign Reach slots are bypassed.
  • The remaining slots are filled with lower-priority content using the same waterfall logic as if a bid was issued but received no response from Broadsign Reach.