Global IP Latency Metrics

GET 
/global_ip_latency

Global IP Latency Metrics

Query Parameters

filter[global_ip_id][in] string

Filter by Global IP ID(s) separated by commas

filter[timestamp][gt] date-time

Filter by timestamp greater than

filter[timestamp][lt] date-time

Filter by timestamp less than

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

timestamp date-time

The timestamp of the metric.

global_ip

object

id uuid

Global IP ID.

ip_address string

The Global IP address.

prober_location

object

id uuid

Location ID.

name string

Location name.

lat number

Latitude.

lon number

Longitude.

mean_latency

object

amount number

The average latency.

unit string

The unit of the average latency.

percentile_latency

object

0

object

amount number

The minimum latency.

unit string

The unit of the minimum latency.

25

object

amount number

The 25th percentile latency.

unit string

The unit of the 25th percentile latency.

50

object

amount number

The 50th percentile latency.

unit string

The unit of the 50th percentile latency.

75

object

amount number

The 75th percentile latency.

unit string

The unit of the 75th percentile latency.

90

object

amount number

The 90th percentile latency.

unit string

The unit of the 90th percentile latency.

99

object

amount number

The 99th percentile latency.

unit string

The unit of the 99th percentile latency.

100

object

amount number

The maximum latency.

unit string

The unit of the maximum latency.

]

{
  "data": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": null
      },
      "prober_location": {
        "id": 1,
        "name": "Amsterdam",
        "lat": 52.370216,
        "lon": 4.895168
      },
      "mean_latency": {
        "amount": 100,
        "unit": "ms"
      },
      "percentile_latency": {
        "0": {
          "amount": 100,
          "unit": "ms"
        },
        "25": {
          "amount": 100,
          "unit": "ms"
        },
        "50": {
          "amount": 100,
          "unit": "ms"
        },
        "75": {
          "amount": 100,
          "unit": "ms"
        },
        "90": {
          "amount": 100,
          "unit": "ms"
        },
        "99": {
          "amount": 100,
          "unit": "ms"
        },
        "100": {
          "amount": 100,
          "unit": "ms"
        }
      }
    }
  ]
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/global_ip_latency' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": null
      },
      "prober_location": {
        "id": 1,
        "name": "Amsterdam",
        "lat": 52.370216,
        "lon": 4.895168
      },
      "mean_latency": {
        "amount": 100,
        "unit": "ms"
      },
      "percentile_latency": {
        "0": {
          "amount": 100,
          "unit": "ms"
        },
        "25": {
          "amount": 100,
          "unit": "ms"
        },
        "50": {
          "amount": 100,
          "unit": "ms"
        },
        "75": {
          "amount": 100,
          "unit": "ms"
        },
        "90": {
          "amount": 100,
          "unit": "ms"
        },
        "99": {
          "amount": 100,
          "unit": "ms"
        },
        "100": {
          "amount": 100,
          "unit": "ms"
        }
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}