Telco Data Usage Reports V1

Telco Data Usage Report operations

Create a Telco Data usage report

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

Request Body schema: application/json

Parameters required to request a Telco Data usage report

start_date required	string <date> Start date in UTC, must be at most 31 days ago
end_date required	string <date> End date in UTC
aggregation_type required	string ALL

Responses

200

Successful response

Response Schema: application/json

object (TelcoDataUsageReport)

id	string ID of the generated report
start_date	string 2022-07-27
end_date	string 2022-07-28
aggregation_type	string ALL
status	string PENDING, COMPLETE, FAILED, EXPIRED
report_url	string Link to the generated report
	Array of objects (TelcoDataUsageRecord)
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

400

Bad request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

401

Unauthorized

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

404

Resource not found

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

422

Invalid parameters supplied in request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

post/reporting/telco_data_usage_reports

Request samples

application/json

{"start_date": "2022-07-27",
"end_date": "2022-07-29",
"aggregation_type": "ALL"
}

Response samples

application/json

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

List all Telco Data usage reports

Returns a list of your Telco Data usage reports.

Request

query Parameters

page	integer Default: 1 Index of the page to query
per_page	integer <= 1000 Default: 100 Number of reports per page

Responses

200

Successful response

Response Schema: application/json

Array

Array of objects (TelcoDataUsageReport)

Array

id	string ID of the generated report
start_date	string 2022-07-27
end_date	string 2022-07-28
aggregation_type	string ALL
status	string PENDING, COMPLETE, FAILED, EXPIRED
report_url	string Link to the generated report
	Array of objects (TelcoDataUsageRecord)
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

400

Bad request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

401

Unauthorized

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

404

Resource not found

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

422

Invalid parameters supplied in request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

get/reporting/telco_data_usage_reports

Request samples

Response samples

application/json

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

Retrieve Telco Data usage report status

Retrieve the status of a given Telco Data usage report.

Request

path Parameters

required

string

ID of the Telco Data usage report

Responses

200

Successful response

Response Schema: application/json

object (TelcoDataUsageReport)

id	string ID of the generated report
start_date	string 2022-07-27
end_date	string 2022-07-28
aggregation_type	string ALL
status	string PENDING, COMPLETE, FAILED, EXPIRED
report_url	string Link to the generated report
	Array of objects (TelcoDataUsageRecord)
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

400

Bad request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

401

Unauthorized

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

404

Resource not found

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

422

Invalid parameters supplied in request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

get/reporting/telco_data_usage_reports/{id}

Request samples

Response samples

application/json

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

Delete a Telco Data usage report

Permanently deletes a Telco Data usage report.

Request

path Parameters

required

string

ID of the Telco Data usage report to delete

Responses

200

Successful response

Response Schema: application/json

object (TelcoDataUsageReport)

id	string ID of the generated report
start_date	string 2022-07-27
end_date	string 2022-07-28
aggregation_type	string ALL
status	string PENDING, COMPLETE, FAILED, EXPIRED
report_url	string Link to the generated report
	Array of objects (TelcoDataUsageRecord)
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

400

Bad request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

401

Unauthorized

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

404

Resource not found

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

422

Invalid parameters supplied in request

Response Schema: application/json

Array of objects (TelcoDataUsageErrorMessage)

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

delete/reporting/telco_data_usage_reports/{id}

Request samples

Response samples

application/json

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