CDR Usage Reports

CDR Usage Report operations

Create a usage report

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

  • Usage Reports are available for 30 days
Request
Request Body schema: application/json

Usage Report to add

start_time
required
string

UTC (2022-07-29T00:00:00+00:00)

end_time
string

UTC (2022-07-29T06:21:27+00:00). Must be less than 24 hours from now

aggregation_type
integer
Default: 0

Aggregate: All = 0, By Connection = 1

connections
Array of strings

Array of connection IDs

Responses
200

UsageReport response

Response Schema: application/json
id
required
string
start_time
required
string

UTC (2022-07-29T00:00:00+00:00)

end_time
required
string

UTC (2022-07-29T06:21:27+00:00)

connections
required
Array of strings

Array of connection IDs

aggregation_type
required
integer
Default: 0

Aggregate by: All = 0, By Connections = 1

status
required
integer
Default: 1

Pending = 1, Complete = 2, Failed = 3, Expired = 4

report_url
required
string

Link to report

result
required
object

Report results

created_at
required
string
updated_at
required
string
400

Bad request

401

Unauthorized

post/reporting/usage_reports
Request samples
application/json
{
  • "start_time": "string",
  • "end_time": "string",
  • "aggregation_type": 0,
  • "connections": [
    • "string"
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "connections": [
    • "string"
    ],
  • "aggregation_type": 0,
  • "status": 1,
  • "report_url": "string",
  • "result": { },
  • "created_at": "string",
  • "updated_at": "string"
}

List all usage reports

Returns a list of your usage reports.

Request
query Parameters
page
integer
Default: 1

Page number of results to load

per_page
integer <= 1000
Default: 100

Number of results per page

Responses
200

Usage Report response

Response Schema: application/json
Array
id
required
string
start_time
required
string

UTC (2022-07-29T00:00:00+00:00)

end_time
required
string

UTC (2022-07-29T06:21:27+00:00)

connections
required
Array of strings

Array of connection IDs

aggregation_type
required
integer
Default: 0

Aggregate by: All = 0, By Connections = 1

status
required
integer
Default: 1

Pending = 1, Complete = 2, Failed = 3, Expired = 4

report_url
required
string

Link to report

result
required
object

Report results

created_at
required
string
updated_at
required
string
401

Unauthorized

get/reporting/usage_reports
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "start_time": "string",
    • "end_time": "string",
    • "connections": [
      • "string"
      ],
    • "aggregation_type": 0,
    • "status": 1,
    • "report_url": "string",
    • "result": { },
    • "created_at": "string",
    • "updated_at": "string"
    }
]
Retrieve usage report status
Retrieve the status of a usage report. Response includes a link to the report once it is generated.


Request 
path Parameters
id
required
string
ID of Usage Report to retrieve


 
Responses 
200
usage_report


Response Schema: application/json
id
required
string
 
start_time
required
string
UTC (2022-07-29T00:00:00+00:00)


 
end_time
required
string
UTC (2022-07-29T06:21:27+00:00)


 
connections
required
Array of strings
Array of connection IDs


 
aggregation_type
required
integer
 Default:  0
Aggregate by: All = 0, By Connections = 1


 
status
required
integer
 Default:  1
Pending = 1, Complete = 2, Failed = 3, Expired = 4


 
report_url
required
string
Link to report


 
result
required
object
Report results


 
created_at
required
string
 
updated_at
required
string
 
401
Unauthorized


404
Resource not found


get/reporting/usage_reports/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "connections": [
    • "string"
    ],
  • "aggregation_type": 0,
  • "status": 1,
  • "report_url": "string",
  • "result": { },
  • "created_at": "string",
  • "updated_at": "string"
}
Delete a usage report
Permanently deletes a usage report.


Request 
path Parameters
id
required
string
ID of Usage Report to delete


 
Responses 
200
Usage Report delete response


Response Schema: application/json
success
required
boolean
 
message
required
string
 
401
Unauthorized


404
Resource not found


delete/reporting/usage_reports/{id}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "message": "string"
}