Reporting API

Wireless reporting operations

Get all Wireless Detail Records (WDRs) Reports

Returns the WDR Reports that match the given parameters.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

Successful response

Response Schema: application/json
Array of objects (WdrReport)
Array
created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

end_time
string

ISO 8601 formatted date-time indicating the end time.

id
string <uuid>

Identifies the resource.

record_type
string
report_url
string

The URL where the report content, when generated, will be published to.

start_time
string

ISO 8601 formatted date-time indicating the start time.

status
string

Indicates the status of the report, which is updated asynchronously.

Enum: "pending" "complete" "failed" "deleted"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/wireless/detail_records_reports
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.Wireless.list_detail_records_report.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "end_time": "2018-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "detail_records_report",
      • "report_url": "http://example.com",
      • "start_time": "2018-02-02T22:25:27.521Z",
      • "status": "pending",
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ]
}

Create a Wireless Detail Records (WDRs) Report

Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.

SecuritybearerAuth
Request
Request Body schema: application/json
required
end_time
string

ISO 8601 formatted date-time indicating the end time.

start_time
string

ISO 8601 formatted date-time indicating the start time.

Responses
201

Successful response

Response Schema: application/json
object (WdrReport)
created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

end_time
string

ISO 8601 formatted date-time indicating the end time.

id
string <uuid>

Identifies the resource.

record_type
string
report_url
string

The URL where the report content, when generated, will be published to.

start_time
string

ISO 8601 formatted date-time indicating the start time.

status
string

Indicates the status of the report, which is updated asynchronously.

Enum: "pending" "complete" "failed" "deleted"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

422

Unprocessable entity. Check the 'detail' field in response for details.

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/wireless/detail_records_reports
Request samples
application/json
{
  • "end_time": "2018-02-02T22:25:27.521Z",
  • "start_time": "2018-02-02T22:25:27.521Z"
}
Response samples
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "end_time": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "detail_records_report",
    • "report_url": "http://example.com",
    • "start_time": "2018-02-02T22:25:27.521Z",
    • "status": "pending",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Delete a Wireless Detail Record (WDR) Report

Deletes one specific WDR report

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (WdrReport)
created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

end_time
string

ISO 8601 formatted date-time indicating the end time.

id
string <uuid>

Identifies the resource.

record_type
string
report_url
string

The URL where the report content, when generated, will be published to.

start_time
string

ISO 8601 formatted date-time indicating the start time.

status
string

Indicates the status of the report, which is updated asynchronously.

Enum: "pending" "complete" "failed" "deleted"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

404

Resource not found

Response Schema: application/json
code
required
string <int>
detail
string
meta
object
object
title
required
string
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
delete/wireless/detail_records_reports/{id}
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

await telnyx.wirelessDetailRecordReports.del('123');
Response samples
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "end_time": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "detail_records_report",
    • "report_url": "http://example.com",
    • "start_time": "2018-02-02T22:25:27.521Z",
    • "status": "pending",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Get a Wireless Detail Record (WDR) Report

Returns one specific WDR report

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (WdrReport)
created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

end_time
string

ISO 8601 formatted date-time indicating the end time.

id
string <uuid>

Identifies the resource.

record_type
string
report_url
string

The URL where the report content, when generated, will be published to.

start_time
string

ISO 8601 formatted date-time indicating the start time.

status
string

Indicates the status of the report, which is updated asynchronously.

Enum: "pending" "complete" "failed" "deleted"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

404

Resource not found

Response Schema: application/json
code
required
string <int>
detail
string
meta
object
object
title
required
string
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/wireless/detail_records_reports/{id}
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

const {data: report} = await telnyx.wirelessDetailRecordReports.retrieve('123');
Response samples
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "end_time": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "detail_records_report",
    • "report_url": "http://example.com",
    • "start_time": "2018-02-02T22:25:27.521Z",
    • "status": "pending",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}