Skip to main content
GET
/
messaging
/
profiles
/
{id}
/
metrics
JavaScript
import Telnyx from 'telnyx';

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

const response = await client.messagingProfiles.retrieveMetrics(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
{
  "data": {}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The identifier of the messaging profile.

Query Parameters

time_frame
enum<string>
default:24h

The time frame for metrics. The time frame for metrics aggregation.

Available options:
1h,
3h,
24h,
3d,
7d,
30d

Response

Successful response with detailed profile metrics.

data
object

Detailed metrics for a messaging profile.