Audience API

The Audience API allows you to import data from statistics audience modeling (for example, Route, Geopath, etc.). We then compare each playback statistic against your audience data. As a result, you can generate reports that reflect delivered impressions.

Note: The total number of impressions is cumulative when the players are configured with the statistical audience files per time range. This also applies for the gender and age ranges. See Broadsign POP Log.

Note: The Audience API is ideal for users of Broadsign Direct.

The Audience API is an advanced feature of Broadsign Control Administrator. Before configuring it, ensure that you are familiar with the following:

Note: If you are a Quividi user (see Quividi), and you enable the Audience API, the Audience API takes precedence.

Your audience file will need to be in .csv format.

The .csv file can include up to 30 columns:

  • Columns 1-14 are mandatory
  • Columns 15-30 are optional

Mandatory Columns

Note: You can leave columns 3-6 empty to represent fallback data. If you supply data to columns 3-6, they will take precedence.

Column Number Content
1 Display unit ID#: The unique ID# of the display unit (see Display Units).
2 Frame ID#: The unique ID# of the frame (see Frames). Enables you to specify different audiences for each frame.
3 Start date
4 End date
5 Start time
6 End time
7 Monday
8 Tuesday
9 Wednesday
10 Thursday
11 Friday
12 Saturday
13 Sunday
14 Total impressions per hour

Optional Columns

You may omit the following columns or leave them blank.

Note: We do not map the "child" age group.

Column Number Content
15 Total male impressions per hour
16 Total female impressions per hour
17 Total 12-17 Male impressions per hour
18 Total 18-24 Male impressions per hour
19 Total 25-34 Male impressions per hour
20 Total 35-44 Male impressions per hour
21 Total 45-54 Male impressions per hour
22 Total 55-64 Male impressions per hour
23 Total 65+ Male impressions per hour
24 Total 12-17 Female impressions per hour
25 Total 18-24 Female impressions per hour
26 Total 25-34 Female impressions per hour
27 Total 35-44 Female impressions per hour
28 Total 45-54 Female impressions per hour
29 Total 55-64 Female impressions per hour
30 Total 65+ Female impressions per hour

To include audience data in your reports, you will need to enable the Audience API in a configuration profile for your player. Then, you will enable and configure Broadsign's Monitor Sync feature (see Configure Monitor Sync).

To configure the Audience API:

  1. Create a configuration (see Configurations).
  2. Create a player configuration profile (see Configuration Profiles - Players).
  3. Open the Configuration Profile Properties, and go to Integrations > Audience API (see The Integrations Section).

  4. Configure the Audience API settings:

    • Enable Audience API: To enable the API, select this box.
    • Path to CSV file: A mandatory path (absolute or relative) from which Broadsign will read the audience file.
  5. Click OK or Apply.

The Audience API feature simplifies the integration between Broadsign Control Administrator and an audience data provider like Broadsign Direct or a 3rd party platform. To do so, you can use variables that dynamically change in the URL. As a result, your playback data will vary depending on the audience data you provide during configuration.

You can update these variables in either of the following locations:

The following variables are accepted (see Content Variables):

  • display_unit_id
  • display_unit_address
  • display_unit_lat_long
  • display_unit_location_code
  • display_unit_resolution
  • player_id

Note: The delimiters for your variables are “{{” and “}}”.

Note: The variable replacement can happen anywhere in the URL except the protocol. Also, you can have multiple variables in the same URL.

To use content variables with the Audience API:

For this example, we will set the variables using our configuration profile. To achieve the same results, you can also use the URLs tab in ad copy properties (see URLs Tab).

  1. In your configuration profile, go to Monitor Sync > URLs (see The URLs Tab).
  2. Click Add.

  3. Configure the Synchronization URL (see Enable the Synchronization Monitor Using a Configuration Profile).

  4. Click OK.