XML POP

Broadsign Core can send daily batches of data, from our server, containing proof of play (POP) statistics and content information. We pull the previous day’s data from all players on your network.

Before using XML POP, Broadsign needs to enable it. Please send an activation request to:

Broadsign Services

 

It is possible to configure a scoped XML POP access based on a player’s folder structure. You need to provide Broadsign with the folder IDs, which grant login credentials. These credentials, in turn, allow retrieval of proof of play generated by the players.

Please remember the following:

    • Upon activation, we will send you a username and password to access these files.
    • Updates take place daily, between 12 am and 1 am Eastern Time.
    • After 30 days, we will gzip the XML POP files.
    • Broadsign stores the gzip files for up to 60 days.
 

Resources List files contains a daily export of all the player, ad copy, frame, campaign and display unit resources in the domain.

Following a daily naming convention, the URL to this file looks like:

https://popstats.broadsign.com/[ACCOUNT]/resources-YYYY-MM-DD.txt

The properties listed are the following:

    • ID: The ID# of the resource found within Broadsign Administrator. See Resources – Overview.
    • Name: The name of the resource. See Resources – Overview.
    • Active: Indicates whether the resource is active or inactive. See Resources – Overview.
    • Type: Provides the type of resource in the domain:
        • host: player
        • content: ad copy
        • skin: frame
        • reservation: campaign
        • display_unit: display unit
 

Playlog files contain data about each ad copy repetition, on each player, in your network. Known as “raw” Proof of Play, you should only use playlogs for internal auditing purposes.

Here is a sample URL for accessing playlogs:

https://popstats.broadsign.com/[ACCOUNT]/playlog-YYYY_MM_DD.txt

The playlog consists of a series of tab-separated lines. For example:

An XML POP playlog .txt file

You could import the playlog into Excel.

An XML POP playlog imported into Excel

Here are the column headings from left to right:

    • A – Player ID: The ID of the player on which the content played.
    • B – End time: Timestamp of when the content ended (local player time).
    • C – Duration: How long it played (in seconds).
    • D – Ad Copy ID: The ID of the ad copy that was played (if a Broadsign Creator emergency message, will display ‘0’).
    • E – Number of Screens: The number of active screens at the time of playback.
    • F – Campaign ID: The ID of the campaign in which it played (if any) (if a Broadsign Creator emergency message, will display ‘0’).
    • G – Frame ID: The ID of the frame in which it played (if a Broadsign Creator emergency message, will display ‘0’).
    • H – Display Unit ID: The ID of the the player’s display unit (if a Broadsign Creator emergency message, will display ‘0’).
    • I – Impressions: The number of impressions during playback.
    • J – Interactions: The number of interactions during playback.
    • K – Creator URL: The URL of the particular Broadsign Creator message (if not a Broadsign Creator message, will display ‘0’).
    • L – Creator Name:  The name of the message content, e.g., movie_poster.gif (if not a Broadsign Creator message, will display ‘0’).