Digital Boards API Endpoints¶
About Digital Boards¶
Digital Board - A digital board represents a single Screen that can display content. Digital Boards are assigned to Agencies.
| Property | Value |
|---|---|
| Can Create | Yes |
| Can Delete | Yes |
Key Features¶
- Represents a single screen/display
- Assigned to agencies
- Has a location (lat/long and geographic information)
- Can have attached images (approach shots, drone views, street view overlays)
- Maps to vendor IDs via
board_identifierfield
Related Objects¶
- Digital Board to Image - Images showing how the board looks in real world (approach shots, drone shots, street view overlays)
- Location - Geographic location with lat/long and other information
- Street View Location - Best viewing point with heading, pitch, and zoom
Vendor ID Mapping¶
Use the board_identifier field to map to your internal ID system. Most often these are the IDs that media owners use to refer to digital boards.
Endpoints¶
| Method | Endpoint | Description |
|---|---|---|
GET |
/api/v3/digital-boards | GET digital-boards |
POST |
/api/v3/digital-boards | POST digital-boards |
GET |
/api/v3/digital-boards/constants/digital-board-formats | GET /digital-boards/constants/digital-board-formats |
GET |
/api/v3/digital-boards/constants/digital-board-statuses | GET /digital-boards/constants/digital-board-statuses |
GET |
/api/v3/digital-boards/constants/facing-cardinals | GET /digital-boards/constants/facing-cardinals |
GET |
/api/v3/digital-boards/constants/field-map | GET /digital-boards/constants/field-map |
GET |
/api/v3/digital-boards/constants/hardware-providers | GET /digital-boards/constants/hardware-providers |
GET |
/api/v3/digital-boards/constants/impressions-calc-methods | GET /digital-boards/constants/impressions-calc-methods |
GET |
/api/v3/digital-boards/constants/media-type-classes | GET /digital-boards/constants/media-type-classes |
GET |
/api/v3/digital-boards/constants/reads | GET /digital-boards/constants/reads |
GET |
/api/v3/digital-boards/constants/software-providers | GET /digital-boards/constants/software-providers |
GET |
/api/v3/digital-boards/constants/street-view-review-statuses | GET /digital-boards/constants/street-view-review-statuses |
GET |
/api/v3/digital-boards/constants/street-view-statuses | GET /digital-boards/constants/street-view-statuses |
GET |
/api/v3/digital-boards/constants/transact-channel-classes | GET /digital-boards/constants/transact-channel-classes |
GET |
/api/v3/digital-boards/constants/venue-taxonomy-ids | GET /digital-boards/constants/venue-taxonomy-ids |
GET |
/api/v3/digital-boards/constants/xr-statuses | GET /digital-boards/constants/xr-statuses |
GET |
/api/v3/digital-boards/{lcuid} | GET digital-boards/{id} |
PUT |
/api/v3/digital-boards/{lcuid} | PUT digital-boards/{id} |
POST |
/api/v3/digital-boards/{lcuid}/analytics/process-play-report | POST digital-board/{id}/analytics/process-play-report |
POST |
/api/v3/digital-boards/{lcuid}/analytics/record-play | POST digital-board/{id}/analytics/record-play |
POST |
/api/v3/digital-boards/{lcuid}/analytics/record-plays | POST digital-board/{id}/analytics/record-plays |
GET |
/api/v3/digital-boards/{lcuid}/playlist | GET digital-boards/{lcuid}/playlist |