Global IP Usage Metrics

GET 
/global_ip_usage

Global IP Usage Metrics

Query Parameters

filter object

Consolidated filter parameter (deepObject style). Originally: filter[timestamp][gt], filter[timestamp][lt]

filter object

Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]

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.

transmitted

object

amount number

The amount of data transmitted.

unit string

The unit of the amount of data transmitted.

received

object

amount number

The amount of data received.

unit string

The unit of the amount of data received.

]

{
  "data": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": "64.1.2.130"
      },
      "transmitted": {
        "amount": 100000,
        "unit": "B"
      },
      "received": {
        "amount": 100000,
        "unit": "B"
      }
    }
  ]
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code stringrequired

title stringrequired

detail string

source

object

pointer string

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

property name* any

]

{
  "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_usage' \
-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": "64.1.2.130"
      },
      "transmitted": {
        "amount": 100000,
        "unit": "B"
      },
      "received": {
        "amount": 100000,
        "unit": "B"
      }
    }
  ]
}

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