Skip to main content

Generate and fetch MDR Usage Report

GET 
/reports/mdr_usage_reports/sync

Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.

Request ​

Query Parameters

    start_date date-time
    end_date date-time
    aggregation_type stringrequired

    Possible values: [NO_AGGREGATION, PROFILE, TAGS]

    profiles string[]

Responses ​

200: Successful

Schema

    data

    object

    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

Request samples

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

Response samples

{
  "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"
  }
}