Skip to main content
GET
/
global_ip_usage
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const globalIPUsage = await client.globalIPUsage.retrieve();

console.log(globalIPUsage.data);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
global_ip_usage = client.global_ip_usage.retrieve()
print(global_ip_usage.data)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
globalIPUsage, err := client.GlobalIPUsage.Get(context.TODO(), telnyx.GlobalIPUsageGetParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", globalIPUsage.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.globalipusage.GlobalIpUsageRetrieveParams;
import com.telnyx.sdk.models.globalipusage.GlobalIpUsageRetrieveResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

GlobalIpUsageRetrieveResponse globalIpUsage = client.globalIpUsage().retrieve();
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

global_ip_usage = telnyx.global_ip_usage.retrieve

puts(global_ip_usage)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$globalIPUsage = $client->globalIPUsage->retrieve(
filter: ['globalIPID' => 'string']
);

var_dump($globalIPUsage);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx global-ip-usage retrieve \
--api-key 'My API Key'
curl --request GET \
--url https://api.telnyx.com/v2/global_ip_usage \
--header 'Authorization: Bearer <token>'
{
  "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": {}
}
]
}
{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter
object

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

Response

Successful response

data
object[]