Retrieve Black Box Test Results

GET 
/seti/black_box_test_results

Returns the results of the various black box tests

Query Parameters

filter[product] string

Filter results for a specific product.

200: A list of black box test results.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

product string

The product associated with the black box test group.

black_box_tests

object[]

Array [

record_type string

id string

The name of the black box test.

result number

The average result of the black box test over the last hour.

]

]

{
  "data": [
    {
      "record_type": "black_box_test_result",
      "product": "cloud_storage",
      "black_box_tests": [
        {
          "record_type": "black_box_test",
          "id": "msg_overview_outbound_sms",
          "result": 0.999
        }
      ]
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/seti/black_box_test_results' \
-H 'Accept: application/json'

Response samples

• 200

---

{
  "data": [
    {
      "record_type": "black_box_test_result",
      "product": "cloud_storage",
      "black_box_tests": [
        {
          "record_type": "black_box_test",
          "id": "msg_overview_outbound_sms",
          "result": 0.999
        }
      ]
    }
  ]
}