Skip to main content
GET
/
legacy_reporting
/
usage_reports
/
number_lookup
/
{id}
JavaScript
import Telnyx from 'telnyx';

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

const numberLookup = await client.legacy.reporting.usageReports.numberLookup.retrieve('id');

console.log(numberLookup.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
)
number_lookup = client.legacy.reporting.usage_reports.number_lookup.retrieve(
"id",
)
print(number_lookup.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"),
)
numberLookup, err := client.Legacy.Reporting.UsageReports.NumberLookup.Get(context.TODO(), "id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", numberLookup.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupRetrieveResponse;

public final class Main {
private Main() {}

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

NumberLookupRetrieveResponse numberLookup = client.legacy().reporting().usageReports().numberLookup().retrieve("id");
}
}
require "telnyx"

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

number_lookup = telnyx.legacy.reporting.usage_reports.number_lookup.retrieve("id")

puts(number_lookup)
<?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 {
$numberLookup = $client
->legacy
->reporting
->usageReports
->numberLookup
->retrieve('id');

var_dump($numberLookup);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx legacy:reporting:usage-reports:number-lookup retrieve \
--api-key 'My API Key' \
--id id
curl --request GET \
--url https://api.telnyx.com/v2/legacy_reporting/usage_reports/number_lookup/{id} \
--header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "9783f4d7-0bfc-427a-9d6b-bc659ad16e5b",
    "start_date": "2025-11-01",
    "end_date": "2025-12-01",
    "aggregation_type": "ALL",
    "status": "COMPLETE",
    "report_url": "https://portal-cdrs-usage.s3.amazonaws.com/telco_data_usage_report_2025-12-02.csv",
    "created_at": "2025-12-02T20:20:57.196925Z",
    "updated_at": "2025-12-02T20:21:08.237091Z",
    "managed_accounts": [],
    "result": [
      {
        "user_id": "d37bdd47-f301-42ec-b2ad-5a0465bfb632",
        "aggregations": [
          {
            "type": "CNAM",
            "total_dips": 3,
            "total_cost": 0.009,
            "currency": "USD"
          }
        ],
        "record_type": "TelcoDataUsageRecord"
      }
    ],
    "record_type": "TelcoDataUsageReport"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique identifier of the resource.

Response

Successfully retrieved telco data usage report

data
object

Telco data usage report response