Skip to main content
API docs by Redocly

Wallboard API - Advertisers (1.0)

API Support: [email protected]

Advertiser management for proof-of-play tracking and advertising features.

Overview

Advertisers are entities used for proof-of-play reporting and advertising campaign tracking. Each advertiser can have validity schedules and proof-of-play access tokens for external reporting.

Key Concepts

Concept Description
Advertiser Entity representing an advertiser or campaign sponsor
Proof of Play Playback verification reports accessible via secure tokens
Validity Schedule Time-based rules controlling when advertiser is active

advertiser

Advertiser management

List advertisers

Retrieve advertisers with optional filtering and pagination.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

sort
string
Example: sort=name,asc

Sort expression. Format: field,direction

  • Directions: asc, desc
  • Multiple sorts: sort=name,asc&sort=lastActivity,desc
  • Nested fields: sort=content.name,asc

Responses

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ]
}

Create advertiser

Create a new advertiser.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

teamIds
string
Example: teamIds=000c08d294df48efb1b0f5aa754d7ef9:true,00a22e86602c4a88914614aa9516a481:false

Team assignments for a newly created resource. Comma-separated teamId:readOnly pairs.

Request Body schema: application/json
required
name
required
string <= 25 characters

Advertiser name

comment
string

Optional comment

enabled
required
boolean

Whether advertiser is active

object (AdvertiserValidity)

Advertiser validity period and schedule

Responses

Request samples

Content type
application/json
{
  • "name": "Acme Corp",
  • "comment": "Main advertiser for retail campaigns",
  • "enabled": true,
  • "validity": {
    }
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4e5f6",
  • "name": "Acme Corp",
  • "comment": "Main advertiser",
  • "enabled": true,
  • "customerId": 123,
  • "validity": {
    }
}

Get advertiser by ID

Retrieve a single advertiser by ID.

Minimum role: VIEWER

Authorizations:
bearer
path Parameters
advertiserId
required
string

Advertiser UUID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "comment": "string",
  • "enabled": true,
  • "customerId": 0,
  • "validity": {
    },
  • "proofOfPlayAccessSecretConfigured": true,
  • "readOnly": true
}

Update advertiser

Update an existing advertiser.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
advertiserId
required
string

Advertiser UUID

Request Body schema: application/json
required
name
required
string <= 25 characters

Advertiser name

comment
string

Optional comment

enabled
required
boolean

Whether advertiser is active

object (AdvertiserValidity)

Advertiser validity period and schedule

Responses

Request samples

Content type
application/json
{
  • "name": "Acme Corp",
  • "comment": "Retail campaigns advertiser",
  • "enabled": true,
  • "validity": {
    }
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4e5f6",
  • "name": "Acme Corp",
  • "comment": "Main advertiser",
  • "enabled": true,
  • "customerId": 123,
  • "validity": {
    }
}

Delete advertiser

Delete an advertiser.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
advertiserId
required
string

Advertiser UUID

Responses

Update team assignments

Update team assignments for an advertiser.

Minimum role: OWNER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

advertiserId
required
string

Advertiser UUID

Request Body schema: application/json
required
Array of objects

Teams to assign the resource to

removeFromTeamIds
Array of strings

Team IDs to remove the resource from

Responses

Request samples

Content type
application/json
{
  • "assignToTeams": [
    ],
  • "removeFromTeamIds": [
    ]
}