Device List Response Parameters

These parameters are included in the results when retrieving a list of devices via GET /agency/<dsp_agency_id>/dsp/device/.

Here is a JSON example showing how those parameters appear in a real API response.

This typically comes from a GET request to the /api/v2/agency/<dsp_agency_id>/dsp/device/ endpoint. I have included the extended format data, which shows the localized costs for that specific screen.

Example: Device List Entry

{
  "id": 1042,
  "external_id": 550,
  "name": "Central Station Main Hall - Screen A",
  "description": "High-traffic digital totem located near the main information desk.",
  "resolution": "1080x1920",
  "orientation": 2,
  "is_deployed": true,
  "postal_code": "10117",
  "country": "DE",
  "city": "Berlin",
  "street": "Europaplatz",
  "building": "1",
  "floor": 0,
  "room": "Main Concourse",
  "latitude": 52.525084,
  "longitude": 13.369402,
  "ad_plays_cost": {
    "min": 120.50,
    "max": 120.50
  },
  "cpm_cost": {
    "min": 45.00,
    "max": 45.00
  },
  "cpv_cost": {
    "min": 5.25,
    "max": 5.25
  }
}

Key Parameter Breakdown

• Orientation (2): According to the table, 1 is landscape and 2 is portrait. This tells your creative team to provide vertical assets.

• Location Granularity: Notice how the response provides not just city and street, but also floor and room. This is vital for "Hyper-local" targeting (e.g., targeting only food courts or waiting areas).

• Cost Objects:

  • ad_plays_cost: The price for 1,000 displays of a 1-second clip on this specific screen.

  • cpm_cost: The price for 1,000 potential contacts (audience reach).

  • cpv_cost: The price for a single guaranteed view by your target demographic.

• Status (is_deployed): A true value means the device is currently active and eligible to receive your ads.

Pro-Tip for Integration

If you are building a map-based UI for your customers, you would use the latitude and longitude fields from this response to plot the screen locations, and the resolution field to warn the user if their uploaded media won't fit that specific device.