GetUsageReports

GET 
/reports/mdr_usage_reports

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown

Request

Query Parameters

page[number] int32

Default value: 1

Page number

page[size] int32

Default value: 20

Size of the page

Responses

200: Successful

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Identifies the resource

start_date date-time

end_date date-time

connections int64[]

aggregation_type string

Possible values: [NO_AGGREGATION, PROFILE, TAGS]

status string

Possible values: [PENDING, COMPLETE, FAILED, EXPIRED]

report_url string

result

object[]

Array [

cost string

direction string

product string

connection string

received string

delivered string

currency string

parts string

sent string

profile_id string

tags string

message_type string

tn_type string

carrier_passthrough_fee string

]

created_at date-time

updated_at date-time

profiles string

record_type string

]

meta

object

total_pages int32

total_results int32

page_number int32

page_size int32

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "start_date": "2020-07-01T00:00:00-06:00",
      "end_date": "2020-07-01T00:00:00-06:00",
      "connections": [
        0
      ],
      "aggregation_type": "NO_AGGREGATION",
      "status": "PENDING",
      "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Request samples

• cURL

---

curl -L 'https://apidev.telnyx.com/v2/reports/mdr_usage_reports' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200

---

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "start_date": "2020-07-01T00:00:00-06:00",
      "end_date": "2020-07-01T00:00:00-06:00",
      "connections": [
        0
      ],
      "aggregation_type": "NO_AGGREGATION",
      "status": "PENDING",
      "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}