Create a Telco Data usage report

POST 
/reporting/telco_data_usage_reports

Check the status and retrieve a Telco Data Usage Report with a call to: GET /reporting/telco_data_usage_reports/{id}

• Telco Data Usage Reports are available for 30 days

Request

application/json

Body

required

Parameters required to request a Telco Data usage report

start_date daterequired

Start date in UTC, must be at most 31 days ago

end_date daterequired

End date in UTC

aggregation_type stringrequired

ALL

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

id string

ID of the generated report

start_date string

2024-07-20

end_date string

2024-07-21

aggregation_type string

ALL

status string

PENDING, COMPLETE, FAILED, EXPIRED

report_url string

Link to the generated report

result

object[]

Array [

user_id string

ID of the user who owns the data in this record

aggregations

object[]

Array [

type string

LRN, CNAM, or Switch Data

total_dips integer

Total number of dips for the given Telco Data type and reporting period

total_cost number

Total cost for the given Telco Data type and reporting period

currency string

USD

]

]

created_at string

Date and time (UTC) when the report was generated

updated_at string

Date and time (UTC) when the report was last updated, or null if it has not been updated yet

{
  "data": {
    "id": "string",
    "start_date": "string",
    "end_date": "string",
    "aggregation_type": "string",
    "status": "string",
    "report_url": "string",
    "result": [
      {
        "user_id": "string",
        "aggregations": [
          {
            "type": "string",
            "total_dips": 0,
            "total_cost": 0,
            "currency": "string"
          }
        ]
      }
    ],
    "created_at": "string",
    "updated_at": "string"
  }
}

400: Bad request

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

Error code, expressed as a stringified integer

title string

Short summary of the problem

detail string

Explanation specific to this occurrence of the problem

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

401: Unauthorized

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

Error code, expressed as a stringified integer

title string

Short summary of the problem

detail string

Explanation specific to this occurrence of the problem

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

Error code, expressed as a stringified integer

title string

Short summary of the problem

detail string

Explanation specific to this occurrence of the problem

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

422: Invalid parameters supplied in request

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

Error code, expressed as a stringified integer

title string

Short summary of the problem

detail string

Explanation specific to this occurrence of the problem

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/reporting/telco_data_usage_reports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "start_date": "2024-07-20",
  "end_date": "2024-07-22",
  "aggregation_type": "ALL"
}'

Response samples

• 200
• 400
• 401
• 404
• 422

---

{
  "data": {
    "id": "string",
    "start_date": "string",
    "end_date": "string",
    "aggregation_type": "string",
    "status": "string",
    "report_url": "string",
    "result": [
      {
        "user_id": "string",
        "aggregations": [
          {
            "type": "string",
            "total_dips": 0,
            "total_cost": 0,
            "currency": "string"
          }
        ]
      }
    ],
    "created_at": "string",
    "updated_at": "string"
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}