Fetch a Monitor Poll/Field Report (REST)

This use case describes the requirements for fetching a monitor poll or field report using Broadsign Control API via REST.

Note: The ID#s we use in these samples are for illustration purposes. They are invalid. Be sure to use your own ID#s for your integrations. Also, in our examples, we use the api-sandbox endpoint and HTTP token.

Depending on your use case, use one of the following methods:

  • To fetch the poll status of all players and edge servers on your domain, use GET and the /monitor_poll/v2 method.
  • To fetch the poll status of a specific player or edge server on your domain, use GET and the /monitor_poll/v2/by_client_resource_id method.
  • To fetch the field report of a specific player or edge server on your domain, use GET and the /field_report/v4 method.

To fetch the poll status of all resources on your domain, you will only need your domain ID#.

Copy 
curl -X GET 
    'https://api-sandbox.broadsign.com:10889/rest/monitor_poll/v2?not_modified_since=2017-05-05T20%3A00%3A53Z&domain_id=123456789' 
        -H 'authorization: Bearer YourAPIKeyHere' 
        -H 'cache-control: no-cache'
Copy 
{
    "not_modified_since": "2017-10-27T20:05:43Z",
    "monitor_poll": [
    {
        "client_resource_id": 319,
        "domain_id": 123456789,
        "id": 3,
        "monitor_status": 2,
        "poll_last_utc": "2017-10-23T19:55:06",
        "poll_next_expected_utc": "2017-10-23T20:31:11",
        "private_ip": "192.168.1.200",
        "product_version": "12.1.0",
        "public_ip": "192.168.1.200"
        }
    ]
}

To fetch the poll status of specific resources on your domain, you will need their unique ID#s.

Copy 
curl -X GET 
    'https://api-sandbox.broadsign.com:10889/rest/monitor_poll/v2/by_client_resource_id?client_resource_id=13501&domain_id=123456789' 
    -H 'authorization: Bearer YourAPIKeyHere' 
    -H 'cache-control: no-cache'
Copy 
{
    "not_modified_since": "2017-10-27T19:57:02Z",
    "monitor_poll": [
        {
        "client_resource_id": 13501,
        "domain_id": 123456789,
        "id": 5,
        "monitor_status": 2,
        "poll_last_utc": "2017-10-26T14:33:41",
        "poll_next_expected_utc": "2017-10-26T15:15:26",
        "private_ip": "192.168.1.200",
        "product_version": "12.1.0-814",
        "public_ip": "192.168.1.200"
        }
    ]
}

To fetch the field report of a specific resource, you will need its unique ID# (target_resource_id).

Copy 
curl -X GET
    'https://api-sandbox.broadsign.com:10889/rest/field_report/v4?not_modified_since=2017-05-05&domain_id=123456789&target_resource_id=13501' 
    -H 'authorization: Bearer YourAPIKeyHere' 
    -H 'cache-control: no-cache'

Note: We truncated this response for the purposes of this example.

Copy 
{
    "not_modified_since": "2017-10-27T20:00:53Z",
    "domain_id": 123456789,
    "field_report": "...",
    "field_report_submitted_utc": "...",
    "id": 4,
    "player_capability_report": "...",
    "player_capability_report_submitted_utc": "2017-10-16T20:00:53Z",
    "target_resource_id": 13501
}