Overview

​

Screens

​

Key Concepts

• Screen: A physical or virtual display device that plays a sequence of ads
• Location: Parent location containing one or more screens
• Loop Duration: The total time (in seconds) for one complete rotation through all queued advertisements
• Venue Type: Classification that must match or be compatible with the parent location’s venue type
• Resolution: Pixel dimensions (width x height) of the display

​

Screen Object

​

Example Screen Object

{
  "screen_id": "d3c8dbb6-c21b-4b26-8f35-d73260c95fa1",
  "title": "Main Lobby Display",
  "venue_type_id": "602",
  "location_id": "Loc_f9FxuWDTfzy",
  "width": 1920,
  "height": 1080,
  "loop_duration": 120,
  "archived": false,
  "available_for_ads": true,
  "amount": 1,
  "imps_weekly": 12503
}

​

Common Use Cases

• Create a Screen: Add a new display device to your location with specific resolution and timing parameters
• Retrieve Screen Details: Look up configuration and metadata for a specific screen
• Update Screen Settings: Modify display name, loop duration, or venue classification
• List Organization Screens: View all screens deployed across your organization
• Manage Ad Content: Use the screen ID to request and manage advertisements for that specific display

​

Requirements

• Parent location must exist before creating screens
• Screen venue_type_id must be compatible with the location’s venue type hierarchy
• Resolution values (width/height) must be positive integers
• Loop duration must be a positive integer representing seconds
• The client generates the screen_id (UUID format). Sending a duplicate returns an error.