Reporting
Reporting gives insight on your group usage. It returns used licenses, assigned phone numbers and in general information about your distributors, resellers, tenants and subscriptions. Reporting is made of API calls that return SDR data (Service Data Records). It is useful if you have the need to integrate Fusion data in your OSS environment and build invoices to your end customers.
Phone Usages
This API endpoint returns a report about phone numbers usage for your group. Every single piece of data in the returned JSON array gives the relation of a phone number to a user.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/groups/{uuid}/sdrs/phone_usage
Authorization
Required role
groups.instance.sdrs.phone_usage
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the group for which you want to get the phone number SDRs |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | Group data has been read and phone usage has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
phoneUsages | array | List containing all Phone Usage Objects in the system | no |
Phone Usage Object
| Parameter | Type | Description | Conditional? | Searchable? |
|---|---|---|---|---|
distributor | string | Name of the distributor | no | no |
group | string | Name of the group | no | no |
reseller | string | Name of the reseller | no | no |
subscription | string | Name of the subscription | no | no |
tenant | string | Name of the tenant | no | no |
phoneNumber | string | Phone number associated to the user | no | no |
username | string | Name of the user | no | no |
Example
json
{
"phoneUsages": [
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"phoneNumber": "+27102851536",
"reseller": "Netaxis Reseller",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV",
"username": "Richard Lobster"
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"phoneNumber": "+27102851545",
"reseller": "Netaxis Reseller",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV",
"username": "John Doe"
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"phoneNumber": "+3225400010",
"reseller": "Netaxis Reseller",
"subscription": "CBUR Test SUB",
"tenant": "CBUR Test Tenant",
"username": "Christophe Bury"
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"phoneNumber": "+27102851554",
"reseller": "Netaxis Reseller",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV",
"username": "Marty van de Veerdonk"
}
]
}Product Usages
This API endpoint returns a report about licenses usage for your group. Every single piece of data in the returned JSON array gives the type of a product, its ordered quantity and its current usage if any. Products are made out of two categories:
- Fusion licenses (
Fusion SeatsandFusion SIP Trunks Capacity) - Phone number entitlements
Request
Endpoint
GET /api/v01/draas/{draas_instance}/groups/{uuid}/sdrs/product_usage
Authorization
Required role
groups.instance.sdrs.product_usage
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the group for which you want to get the product usage SDRs |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | Group data has been read and product usage has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
productUsages | array | List containing all Product Usage Objects in the system | no |
Product Usage Object
| Parameter | Type | Description | Conditional? | Searchable? |
|---|---|---|---|---|
distributor | string | Name of the distributor | no | no |
group | string | Name of the group | no | no |
reseller | string | Name of the reseller | no | no |
subscription | string | Name of the subscription | no | no |
tenant | string | Name of the tenant | no | no |
sku | string | Description of the product | no | no |
quantity | integer | The ordered licenses quantity of the product | no | no |
used | integer | The used quantity of the ordered licenses | yes | no |
Example
json
{
"productUsages": [
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"quantity": 147,
"reseller": "Netaxis Reseller",
"sku": "Belgium - geographical numbers",
"subscription": "CBUR Test SUB",
"tenant": "CBUR Test Tenant",
"used": 10
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"quantity": 177,
"reseller": "Netaxis Reseller",
"sku": "Fusion Seats",
"subscription": "CBUR Test SUB",
"tenant": "CBUR Test Tenant",
"used": 1
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"quantity": 6,
"reseller": "Netaxis Reseller",
"sku": "Belgium - geographical numbers",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV",
"used": 3
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"quantity": 117,
"reseller": "Netaxis Reseller",
"sku": "South Africa - geographical numbers",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV",
"used": 115
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"quantity": 14,
"reseller": "Netaxis Reseller",
"sku": "Fusion SIP Trunks Capacity",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV"
},
{
"distributor": "Netaxis Distributor",
"group": "Netaxis",
"quantity": 29,
"reseller": "Netaxis Reseller",
"sku": "Fusion Seats",
"subscription": "Operator Connect DEV",
"tenant": "Netaxis DEV",
"used": 5
}
]
}Download Group Licenses
Download Group Licenses as CSV or JSON format.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/groups/{uuid}/downloads/report
Authorization
Required role
groups.instance.downloads.report
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the group |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
format | string | The file format. Possible values are:
| yes |
Response
Status codes
| Parameter | Description |
|---|---|
200 | The licenses has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
fileBody | string | File content encoded to base64. In case of format=csv, see csv header for details. | no |
fileName | string | File name in format: licenses_group_<group_uuid>_<timestamp>.<format> | no |
CSV Header
name, distributor_name, distributor_uuid, reseller_name, reseller_uuid, tenant_name, tenant_uuid, ms_assigned, ms_used, sip_assigned.
Example format=csv
json
{
"fileBody": "bmFtZSxkaXN0cmlidXRvcl9uYW1lLGRpc3RyaWJ1dG9yX3V1aWQscmVzZWxsZXJfbmFtZSxyZXNlbG...",
"fileName": "licenses_group_aaf9dba1-9469-40fa-be50-22298d68010d_20231122.csv"
}Example format=json
json
{
"fileBody": "ewogICJtc1RlYW1zVXNlcnMiOiB7CiAgICAiYXNzaWduZWQiOiAzMTUsCiAgICAiaW5Vc2UiOiA5Ci...",
"fileName": "licenses_group_aaf9dba1-9469-40fa-be50-22298d68010d_20231122.json"
}Download Distributor Licenses
Download Distributor Licenses as CSV or JSON format.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/distributors/{uuid}/downloads/report
Authorization
Required role
distributors.instance.downloads.report
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the distributor |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
format | string | The file format. Possible values are:
| yes |
Response
Status codes
| Parameter | Description |
|---|---|
200 | The licenses has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
fileBody | string | File content encoded to base64. In case of format=csv, see csv header for details. | no |
fileName | string | File name in format: licenses_distributor_<distributor_uuid>_<timestamp>.<format> | no |
CSV Header
name, reseller_name, reseller_uuid, tenant_name, tenant_uuid, ms_assigned, ms_used, sip_assigned.
Example format=csv
json
{
"fileBody": "bmFtZSxyZXNlbGxlcl9uYW1lLHJlc2VsbGVyX3V1aWQsdGVuYW50X25hbWUsdGVuYW50X3V1...",
"fileName": "licenses_distributor_f3eb54f4-00dc-4278-b323-c66b705d6822_20231122.csv"
}Example format=json
json
{
"fileBody": "ewogICJzaXBUcnVua0NoYW5uZWxzIjogewogICAgImFzc2lnbmVkIjogNzUKICB9LAogICJk...",
"fileName": "licenses_distributor_f3eb54f4-00dc-4278-b323-c66b705d6822_20231122.json"
}Download Reseller Licenses
Download Reseller Licenses as CSV or JSON format.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/resellers/{uuid}/downloads/report
Authorization
Required role
resellers.instance.downloads.report
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the reseller |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
format | string | The file format. Possible values are:
| yes |
Response
Status codes
| Parameter | Description |
|---|---|
200 | The licenses has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
fileBody | string | File content encoded to base64. In case of format=csv, see csv header for details. | no |
fileName | string | File name in format: licenses_reseller_<reseller_uuid>_<timestamp>.<format> | no |
CSV Header
name, tenant_name, tenant_uuid, ms_assigned, ms_used, sip_assigned.
Example format=csv
json
{
"fileBody": "bmFtZSx0ZW5hbnRfbmFtZSx0ZW5hbnRfdXVpZCxtc19hc3NpZ25lZCxtc191c2VkLHNpcF9hc3NpZ...",
"fileName": "licenses_reseller_cae902b4-2307-41ef-b554-43a12c63cc97_20231122.csv"
}Example format=json
json
{
"fileBody": "ewogICJtc1RlYW1zVXNlcnMiOiB7CiAgICAiYXNzaWduZWQiOiAyODEsCiAgICAiaW5Vc2UiOiA5C...",
"fileName": "licenses_reseller_cae902b4-2307-41ef-b554-43a12c63cc97_20231122.json"
}Download Tenant Licenses
Download Tenant Licenses as CSV or JSON format.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/downloads/report
Authorization
Required role
tenants.instance.downloads.report
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the tenant |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
format | string | The file format. Possible values are:
| yes |
Response
Status codes
| Parameter | Description |
|---|---|
200 | The licenses has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
fileBody | string | File content encoded to base64. In case of format=csv, see csv header for details. | no |
fileName | string | File name in format: licenses_tenant_<tenant_uuid>_<timestamp>.<format> | no |
CSV Header
name, ms_assigned, ms_used, sip_assigned.
Example format=csv
json
{
"fileBody": "bmFtZSxtc19hc3NpZ25lZCxtc191c2VkLHNpcF9hc3NpZ25lZApPcGVyYXRvciBDb25uZWN0IER...",
"fileName": "licenses_tenant_53fd92c7-fbef-44fd-af76-d92334432ac9_20231122.csv"
}Example format=json
json
{
"fileBody": "ewogICJtc1RlYW1zVXNlcnMiOiB7CiAgICAiYXNzaWduZWQiOiA1OCwKICAgICJpblVzZSI6IDk...",
"fileName": "licenses_tenant_53fd92c7-fbef-44fd-af76-d92334432ac9_20231122.json"
}Download Subscription Licenses
Download Subscription Licenses as CSV or JSON format.
Request
Endpoint
POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/downloads/report
Authorization
Required role
tenants.instance.subscriptions.instance.downloads.report
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | System generated universal unique ID (UUID) identifying the tenant |
sub_id | integer | Index of a subscription for which you want to retrieve the list of licenses |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
format | string | The file format. Possible values are:
| yes |
Response
Status codes
| Parameter | Description |
|---|---|
200 | The licenses has been correctly returned |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No MS Teams tenant found or the path tenant / subscription doesn't exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
fileBody | string | File content encoded to base64. In case of format=csv, see csv header for details. | no |
fileName | string | File name in format: licenses_tenant_<tenant_uuid>_ subscription_<subscription_id>_<timestamp>.<format> | no |
CSV Header
name, ms_assigned, ms_used, sip_assigned.
Example format=csv
json
{
"fileBody": "bmFtZSxtc19hc3NpZ25lZCxtc191c2VkLHNpcF9hc3NpZ25lZApPcGVyYXRvciBDb25uZWN0IERFViw1OCw5L...",
"fileName": "licenses_tenant_53fd92c7-fbef-44fd-af76-d92334432ac9_subscription_2_20231122.csv"
}Example format=json
json
{
"fileBody": "ewogICJpZCI6IDIsCiAgIm5hbWUiOiAiT3BlcmF0b3IgQ29ubmVjdCBERVYiLAogICJtc1RlYW1zVXNlcnMi...",
"fileName": "licenses_tenant_53fd92c7-fbef-44fd-af76-d92334432ac9_subscription_2_20231122.json"
}