Skip to main content
POST
/
reports
/
mdr_usage_reports
JavaScript
import Telnyx from 'telnyx';

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

const mdrUsageReport = await client.reports.mdrUsageReports.create({
  aggregation_type: 'NO_AGGREGATION',
  end_date: '2020-07-01T00:00:00-06:00',
  start_date: '2020-07-01T00:00:00-06:00',
});

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

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
mdr_usage_report = client.reports.mdr_usage_reports.create(
aggregation_type="NO_AGGREGATION",
end_date=datetime.fromisoformat("2020-07-01T00:00:00-06:00"),
start_date=datetime.fromisoformat("2020-07-01T00:00:00-06:00"),
)
print(mdr_usage_report.data)
package main

import (
"context"
"fmt"
"time"

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

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
mdrUsageReport, err := client.Reports.MdrUsageReports.New(context.TODO(), telnyx.ReportMdrUsageReportNewParams{
AggregationType: telnyx.ReportMdrUsageReportNewParamsAggregationTypeNoAggregation,
EndDate: time.Now(),
StartDate: time.Now(),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", mdrUsageReport.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportCreateParams;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportCreateResponse;
import java.time.OffsetDateTime;

public final class Main {
private Main() {}

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

MdrUsageReportCreateParams params = MdrUsageReportCreateParams.builder()
.aggregationType(MdrUsageReportCreateParams.AggregationType.NO_AGGREGATION)
.endDate(OffsetDateTime.parse("2020-07-01T00:00:00-06:00"))
.startDate(OffsetDateTime.parse("2020-07-01T00:00:00-06:00"))
.build();
MdrUsageReportCreateResponse mdrUsageReport = client.reports().mdrUsageReports().create(params);
}
}
require "telnyx"

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

mdr_usage_report = telnyx.reports.mdr_usage_reports.create(
aggregation_type: :NO_AGGREGATION,
end_date: "2020-07-01T00:00:00-06:00",
start_date: "2020-07-01T00:00:00-06:00"
)

puts(mdr_usage_report)
<?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 {
$mdrUsageReport = $client->reports->mdrUsageReports->create(
aggregationType: 'NO_AGGREGATION',
endDate: new \DateTimeImmutable('2020-07-01T00:00:00-06:00'),
startDate: new \DateTimeImmutable('2020-07-01T00:00:00-06:00'),
profiles: 'My profile',
);

var_dump($mdrUsageReport);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx reports:mdr-usage-reports create \
--api-key 'My API Key' \
--aggregation-type NO_AGGREGATION \
--end-date "'2020-07-01T00:00:00-06:00'" \
--start-date "'2020-07-01T00:00:00-06:00'"
curl --request POST \
--url https://api.telnyx.com/v2/reports/mdr_usage_reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: */*' \
--data '
{
"start_date": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_date": "2020-07-01T00:00:00-06:00",
    "end_date": "2020-07-01T00:00:00-06:00",
    "connections": [
      123
    ],
    "report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
    "result": [
      {
        "cost": "0",
        "direction": "outbound",
        "product": "outbound",
        "connection": "all",
        "received": "0",
        "delivered": "0",
        "currency": "USD",
        "parts": "0",
        "sent": "0",
        "profile_id": "All",
        "tags": "All",
        "message_type": "SMS",
        "tn_type": "TF",
        "carrier_passthrough_fee": "0"
      }
    ],
    "created_at": "2020-07-01T00:00:00-06:00",
    "updated_at": "2020-07-01T00:00:00-06:00",
    "profiles": "My profile",
    "record_type": "mdr_usage_report"
  }
}
{
"errors": [
{
"code": "10011",
"title": "Bad Request",
"detail": "Invalid parameter value"
}
]
}

Authorizations

Authorization
string
header
required

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

Body

*/*

Mdr usage report data

start_date
string<date-time>
required
Example:

"2020-07-01T00:00:00-06:00"

end_date
string<date-time>
required
Example:

"2020-07-01T00:00:00-06:00"

aggregation_type
enum<string>
required
Available options:
NO_AGGREGATION,
PROFILE,
TAGS
profiles
string
Example:

"My profile"

Response

Successful

data
object