GET /api/v3/campaigns/{lcuid}/digital-boards/{digitalBoardLcuid}

Summary

GET campaigns/{lcuid}/digital-boards/{digitalBoardLcuid}

Description

Get board-specific campaign data. The board must be attached to the campaign.

Tags: campaigns

Parameters

Header Parameters

Name	Type	Required	Description	Example
Authorization	string	✓ Yes		Bearer {AuthToken}
Content-Type	string	✓ Yes		application/json
Accept	string	✓ Yes		application/json
AppIdV3	string	✓ Yes		LCUID-LAP-********-****-****-****-************

Responses

Response: 200

Description: Sample Response

Content Type: application/json

Schema

Type: object

Properties:

• success (boolean)
• digital_board_data (object) Type: object

Properties:

• digital_board (object) Type: object

  Properties:

  • board_identifier (string)
  • name (string)
  • status (integer)
  • created_at (string)
  • updated_at (string)
  • network (integer)
  • width (integer)
  • height (integer)
  • hardware_provider (string)
  • software_provider (string)
  • description (string)
  • street_view_status (string)
  • street_view_review_status (integer)
  • xr_status (integer)
  • venue_taxonomy_id (integer)
  • board_class (string)
  • hash_id (string)
  • creative_width (integer)
  • creative_height (integer)
  • creative_is_upscaled (boolean)
  • digital_board_format (object) Type: object

  Properties:

  • code (string)
  • name (string)
  • width (integer)
  • height (integer)
  • min_ratio (number)
  • max_ratio (number)

  • meta (array)

  • location (object) Type: object

  Properties:

  • name (string)
  • description (string)
  • phone (string)
  • address (string)
  • city (string)
  • region (string)
  • postal_code (string)
  • country (string)
  • latitude (string)
  • longitude (string)
  • location_default (integer)
  • status (integer)

  • options (object) Type: object

    Properties:

    • _init (array)

  • location_class (string)

  • lcuid (string)
  • street_view_status (string)
  • heading (string)
  • pitch (string)
  • zoom (string)
  • hash_id (string)
  • lid (string)
  • parent_id (integer)
  • parent_type (string)
  • created_at (string)
  • updated_at (string)
  • location_class_description (string)

  • fov (integer)

  • street_view_location (string)

  • board_class_description (string)
  • board_size_description (string)
  • options (object) Type: object

  Properties:

  • primary_image_public_url (string)
  • slot_count (string)
  • slot_length (string)
  • impressions_calc_method (string)
  • avg_daily_impressions (string)
  • facing_degrees (string)
  • facing_cardinal (string)
  • read (string)

  • pending_xr_image_url (string)

  • lcuid (string)

  • slug (string)
  • address (string)
  • city (string)
  • region (string)
  • postal_code (string)
  • country (string)
  • transact_channel_class (array)
  • Array items: string
  • transact_channel_class_description (string)
  • media_type_class (array)
  • Array items: string
  • media_type_class_description (string)
  • aspect_ratio (string)
  • latitude (string)
  • longitude (string)
  • cached_tags (string)

• pusher_data (string): The stored board playlist, or null when no data is stored

• summary_inventory_item_last_play_by_export_by_board (array): Item play summaries

  • Array items: object Type: object

  Properties:

  • id (integer)
  • inventory_export_id (integer)
  • inventory_item_id (integer)
  • digital_board_id (integer)
  • first_play_datetime (string)
  • last_play_datetime (string)
  • total_plays (integer)
  • total_impressions (integer)
  • hash_id (string)
  • lid (string)

• inventory_export_item_by_boards (array): Item running status for this campaign and board

  • Array items: object Type: object

  Properties:

  • id (integer)
  • created_at (string)
  • updated_at (string)
  • inventory_export_id (integer)
  • inventory_item_id (integer)
  • digital_board_id (integer)
  • running (integer)

  • inventory_item (object) Type: object

    Properties:

    • title (string)
    • lcuid (string)
    • has_price_override (boolean)
    • price_upstream (string)
    • account (object) Type: object

    Properties:

    • name (string)
    • lcuid (string)
    • inventory_item_class (array)
    • inventory_item_class_description (string)

    • account_class_description (string)

    • options (object) Type: object

    Properties:

    • best_creative_image_photo_url (string)
    • first_play_at (string)
    • primary_image_background_removed_public_url (string)

    • primary_image_public_url (string)

    • campaign_settings (object) Type: object

    Properties:

    • 13913 (object) Type: object

      Properties:

      • board_ids (array)
      • Array items: integer
      • digital_board_filter (object) Type: object

      Properties:

      • filter_fields (array)

        • Array items: object Type: object

        Properties:

        • value (string)
        • operator (string)
        • field_name (string)

      • filter_functions (array)

  • hash_id (string)

  • lid (string)

• inventory_item_drive_data_cache_by_boards (array): Board-specific item render data

  • Array items: object Type: object

  Properties:

  • id (integer)
  • created_at (string)
  • updated_at (string)
  • inventory_item_id (integer)
  • inventory_export_id (integer)
  • digital_board_id (integer)
  • data_row (string)
  • data_row_hash (string)
  • last_rebuild_at (string)
  • status (integer)
  • synced (integer)
  • hash_id (string)
  • lid (string)

• key_value_stores (array): Account-scoped key/value data for this board

  • Array items: object Type: object

  Properties:

  • parent_type (string)
  • object_type (string)
  • key_name (string)
  • key (string)
  • value (string)
  • created_at (string)
  • updated_at (string)
  • macro (string)

• inventory_item_filter_status (array): Campaign item filter results for this board

  • Array items: object Type: object

  Properties:

  • inventory_item_lcuid (string)
  • inventory_item_title (string)
  • inventory_item_status (integer)
  • inventory_item_creative_state (integer)
  • board_lcuid (string)
  • board_name (string)
  • has_record (boolean)
  • running (boolean)
  • export_has_item (boolean)
  • has_board_filter (boolean)
  • has_board_id_limitation (boolean)
  • board_id_limitation_passes (boolean)
  • board_id_limitation_skip_reason (string)
  • board_filter_passes (boolean)
  • board_filter_skip_reasons (array)

  • board_filter_pass_reason (array)

    • Array items: object Type: object

    Properties:

    • reason (string)
    • data (array)
    • group_level (integer)
    • group_result (boolean)
    • entry_type (string)
    • group_id (integer)

  • export_weight (integer)

  • has_export_filter (boolean)
  • has_item_filter_limitations (boolean)
  • has_date_limitations (boolean)
  • will_never_run_again (boolean)
  • has_hourly_limitations (boolean)
  • has_day_of_week_limitations (boolean)
  • filter_can_run_for_export (boolean)
  • filter_skip_reasons (array)

Example Response

{
    "success": true,
    "digital_board_data": {
        "digital_board": {
            "board_identifier": "137afu6",
            "name": "Unit Test - CpXyBzlnkYwcUdG",
            "status": 1,
            "created_at": "2026-10-09T13:47:32.000000Z",
            "updated_at": "2026-10-09T13:47:32.000000Z",
            "network": 0,
            "width": 1400,
            "height": 400,
            "hardware_provider": "unit_test_hardware",
            "software_provider": "unit_test_software_provider",
            "description": null,
            "street_view_status": null,
            "street_view_review_status": 0,
            "xr_status": 0,
            "venue_taxonomy_id": 301,
            "board_class": "App\\LuCore\\DigitalBoards\\DigitalBillboardBoardClass",
            "hash_id": "lch-4LzB",
            "creative_width": 1400,
            "creative_height": 400,
            "creative_is_upscaled": false,
            "digital_board_format": {
                "code": "bulletin",
                "name": "Bulletin",
                "width": 1400,
                "height": 400,
                "min_ratio": 3.2666,
                "max_ratio": 3.717,
                "meta": []
            },
            "location": {
                "name": "Unit Test - Kr9QkphbyisqfkX",
                "description": "Unit Test Description - Anrw3ts3z88BP5zz1jQHjvuIFP2sO2okYgKw629KxPdC7QfYtx39p9GqLhTM6tYS8U0XqfOOtoehmVwkhTR58YQRnc9bkeoI0W9XscbutLvMux8gTgXuV4ubYneIZhuaGAIKEDkm1qXqMmq1RN1C2x",
                "phone": "+1.903.544.6525",
                "address": "3025 Wilson Point",
                "city": "Paulineshire",
                "region": "Nevada",
                "postal_code": "00141-9063",
                "country": "US",
                "latitude": "35.44687100000000",
                "longitude": "-99.98638200000000",
                "location_default": 1,
                "status": 1,
                "options": {
                    "_init": []
                },
                "location_class": "App\\LuCore\\Locations\\GenericLocationClass",
                "lcuid": "LCUID-LL-02cecd45-d029-479b-8f7c-4ef146e1028d",
                "street_view_status": null,
                "heading": null,
                "pitch": null,
                "zoom": null,
                "hash_id": "lch-4HrZ",
                "lid": "LL21981",
                "parent_id": 37829,
                "parent_type": "App\\DigitalBoard",
                "created_at": "2026-10-09T13:47:32.000000Z",
                "updated_at": "2026-10-09T13:47:32.000000Z",
                "location_class_description": "Generic Location",
                "fov": 1
            },
            "street_view_location": null,
            "board_class_description": "Digital Billboard",
            "board_size_description": "1400x400",
            "options": {
                "primary_image_public_url": null,
                "slot_count": null,
                "slot_length": null,
                "impressions_calc_method": null,
                "avg_daily_impressions": null,
                "facing_degrees": null,
                "facing_cardinal": null,
                "read": null,
                "pending_xr_image_url": null
            },
            "lcuid": "LCUID-LB-378a981f-32a2-4a3d-9bdd-a91d36be9699",
            "slug": "TestAgencyUnitTestEk2qxBoard137afu6",
            "address": "3025 Wilson Point",
            "city": "Paulineshire",
            "region": "Nevada",
            "postal_code": "00141-9063",
            "country": "US",
            "transact_channel_class": [
                "App\\LuCore\\DigitalBoards\\TransactChannels\\ContractTransactChannelClass"
            ],
            "transact_channel_class_description": "Contract",
            "media_type_class": [
                "App\\LuCore\\DigitalBoards\\MediaTypes\\ImageMediaTypeClass"
            ],
            "media_type_class_description": "Image",
            "aspect_ratio": "3.50000000",
            "latitude": "35.44687100",
            "longitude": "-99.98638200",
            "cached_tags": null
        },
        "pusher_data": "<?xml version=\"1.0\"?>\n<drive><item-set location-id=\"137afu6\"/></drive>\n",
        "summary_inventory_item_last_play_by_export_by_board": [
            {
                "id": 60,
                "inventory_export_id": 13913,
                "inventory_item_id": 40167,
                "digital_board_id": 37829,
                "first_play_datetime": "2026-10-09 11:47:34",
                "last_play_datetime": "2026-10-09 12:47:34",
                "total_plays": 3,
                "total_impressions": 15,
                "hash_id": "lch-4CA0",
                "lid": "SILPE60"
            }
        ],
        "inventory_export_item_by_boards": [
            {
                "id": 40943,
                "created_at": "2026-10-09T13:47:35.000000Z",
                "updated_at": "2026-10-09T13:47:35.000000Z",
                "inventory_export_id": 13913,
                "inventory_item_id": 40167,
                "digital_board_id": 37829,
                "running": 1,
                "inventory_item": {
                    "title": "Unit Test - HNh0kaKGz9J9aO6",
                    "lcuid": "LCUID-LI-d0cc4cc0-c9d2-4884-b9a9-389523f290b8",
                    "has_price_override": false,
                    "price_upstream": null,
                    "account": {
                        "name": "Unit Test Account - BEpiM",
                        "lcuid": "LCUID-LA-d7d35a7f-3476-43dc-8103-2dfcb7960146",
                        "inventory_item_class": [],
                        "inventory_item_class_description": "",
                        "account_class_description": ""
                    },
                    "options": {
                        "best_creative_image_photo_url": null,
                        "first_play_at": null,
                        "primary_image_background_removed_public_url": null,
                        "primary_image_public_url": null
                    },
                    "campaign_settings": {
                        "13913": {
                            "board_ids": [
                                37830
                            ],
                            "digital_board_filter": {
                                "filter_fields": [
                                    {
                                        "value": "bulletin",
                                        "operator": "equals",
                                        "field_name": "digital_board_format"
                                    }
                                ],
                                "filter_functions": []
                            }
                        }
                    }
                },
                "hash_id": "lch-4MnP",
                "lid": "LEIB40943"
            },
            {
                "id": 40946,
                "created_at": "2026-10-09T13:47:35.000000Z",
                "updated_at": "2026-10-09T13:47:35.000000Z",
                "inventory_export_id": 13913,
                "inventory_item_id": 40168,
                "digital_board_id": 37829,
                "running": 0,
                "inventory_item": {
                    "title": "Unit Test - 2odPpSmap60StJf",
                    "lcuid": "LCUID-LI-7864c188-cb64-4580-9b3a-b2070ca10960",
                    "has_price_override": false,
                    "price_upstream": null,
                    "account": {
                        "name": "Unit Test Account - BEpiM",
                        "lcuid": "LCUID-LA-d7d35a7f-3476-43dc-8103-2dfcb7960146",
                        "inventory_item_class": [],
                        "inventory_item_class_description": "",
                        "account_class_description": ""
                    },
                    "options": {
                        "best_creative_image_photo_url": null,
                        "first_play_at": null,
                        "primary_image_background_removed_public_url": null,
                        "primary_image_public_url": null
                    },
                    "campaign_settings": null
                },
                "hash_id": "lch-4MnS",
                "lid": "LEIB40946"
            }
        ],
        "inventory_item_drive_data_cache_by_boards": [
            {
                "id": 32604,
                "created_at": "2026-10-09T13:47:35.000000Z",
                "updated_at": "2026-10-09T13:47:35.000000Z",
                "inventory_item_id": 40167,
                "inventory_export_id": 13913,
                "digital_board_id": 37829,
                "data_row": "a:1:{s:8:\"headline\";s:13:\"Board details\";}",
                "data_row_hash": "9cbffdc4950a50c4326d3c77f81b53f6",
                "last_rebuild_at": null,
                "status": 0,
                "synced": 1,
                "hash_id": "lch-4Kcu",
                "lid": "LIDCB32604"
            }
        ],
        "key_value_stores": [
            {
                "parent_type": "App\\Account",
                "object_type": "App\\DigitalBoard",
                "key_name": "Board value",
                "key": "board_value",
                "value": "matching value",
                "created_at": "2026-10-09T13:47:35.000000Z",
                "updated_at": "2026-10-09T13:47:35.000000Z",
                "macro": "digital_board.store.board_value"
            }
        ],
        "inventory_item_filter_status": [
            {
                "inventory_item_lcuid": "LCUID-LI-d0cc4cc0-c9d2-4884-b9a9-389523f290b8",
                "inventory_item_title": "Unit Test - HNh0kaKGz9J9aO6",
                "inventory_item_status": 1,
                "inventory_item_creative_state": 0,
                "board_lcuid": "LCUID-LB-378a981f-32a2-4a3d-9bdd-a91d36be9699",
                "board_name": "Unit Test - CpXyBzlnkYwcUdG",
                "has_record": true,
                "running": true,
                "export_has_item": true,
                "has_board_filter": true,
                "has_board_id_limitation": true,
                "board_id_limitation_passes": false,
                "board_id_limitation_skip_reason": "Board is not in the item's manually selected board ID list for this campaign",
                "board_filter_passes": true,
                "board_filter_skip_reasons": [],
                "board_filter_pass_reason": [
                    {
                        "reason": "digital_board_format (bulletin) is bulletin",
                        "data": [],
                        "group_level": 0,
                        "group_result": true,
                        "entry_type": "filter",
                        "group_id": 1
                    },
                    {
                        "reason": "Logical group (and) passed",
                        "data": [],
                        "group_level": 0,
                        "group_result": true,
                        "entry_type": "group",
                        "group_operator": "and",
                        "group_id": 1,
                        "parent_group_id": null
                    }
                ],
                "export_weight": 10,
                "has_export_filter": false,
                "has_item_filter_limitations": false,
                "has_date_limitations": false,
                "will_never_run_again": false,
                "has_hourly_limitations": false,
                "has_day_of_week_limitations": false,
                "filter_can_run_for_export": true,
                "filter_skip_reasons": []
            }
        ]
    }
}

Example Implementations

Bash (cURL)

curl --request GET \
  --url "https://api.lucit.app/api/v3/campaigns/{lcuid}/digital-boards/{digitalBoardLcuid}" \
  --header "Authorization: Bearer {AuthToken}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "AppIdV3: LCUID-LAP-********-****-****-****-************"

JavaScript (Fetch API)

const url = "https://api.lucit.app/api/v3/campaigns/{lcuid}/digital-boards/{digitalBoardLcuid}";

const headers = {
  "Authorization": "Bearer {AuthToken}",
  "Content-Type": "application/json",
  "Accept": "application/json",
  "AppIdV3": "LCUID-LAP-********-****-****-****-************"
};

fetch(url, {
  method: "GET",
  headers: headers
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

PHP (Guzzle)

<?php

require_once 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.lucit.app/api/v3/campaigns/{lcuid}/digital-boards/{digitalBoardLcuid}', [
  'headers' => [
    'Authorization' => 'Bearer {AuthToken}',
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
  ]
]);

$body = $response->getBody();
$data = json_decode($body, true);
print_r($data);

Python (Requests)

import requests
import json

url = "https://api.lucit.app/api/v3/campaigns/{lcuid}/digital-boards/{digitalBoardLcuid}"

headers = {
  "Authorization": "Bearer {AuthToken}",
  "Content-Type": "application/json",
  "Accept": "application/json",
  "AppIdV3": "LCUID-LAP-********-****-****-****-************"
}

response = requests.get(url, headers=headers)
print(response.json())

---

← Back to campaigns index | Back to main index