Partner Plan Percentage Report

Last updated on 2022-06-17 11:42:28

URI	/v1/partners/{username}/reports/plan_percentage
URI Parameters	username (string)
Methods	GET

GET /v1/partners/{username}/reports/plan_percentage

Gets a partner's plan percentage report.

Scope	partners_read
Query Selector Parameters	type (string const) – ACCOUNT\|PARTNER – If no type is specified, then all types will be returned status (string const) – ACTIVE\|TEST\|FROZEN\|CANCELED – If no status is specified, then all statuses will be returned
Query Pagination Parameters	page (int) – the page to show (min 1, default 1) page_size (int) – the number of rows per page (min 1, max 50, default 10)
Query Sorting Parameters	order_by (string const) – TYPE \|USERNAME\|NAME order_dir (string const) – ASC\|DESC
Request Body Parameters	n/a
Response Attributes	username (string) name (string) company (string) type (string const) – ACCOUNT\|PARTNER plan_name (string) total_usage (int) – total number of bytes stored additional_usage (int) – number of bytes over the plan’s allowed usage percentage (decimal) – percentage of total usage of the plan’s allowed usage

Example JSON

Request:

GET /v1/partners/barracuda/reports/plan_percentage HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

Response:

HTTP/1.1 200 OK

Content-Type: application/json

{

"page": 1,

"page_size": 100,

"count": 100,

"links": [

{

"rel": "first",

"href": "https://api.intronis.com/v1/partners/barracuda/reports/backup_status?page=1"

}

"list": [

{

"username": "barracuda_a",

"name": "John Smith",

"company": "barracuda",

"type": "ACCOUNT",

"plan_name": "1TB Plan",

"total_usage": 824633720832,

"additional_usage": 0,

"percentage": 75.00

{

"username": "barracuda_p",

"name": "John Smith",

"company": "barracuda",

"type": "PARTNER",

"plan_name": "1TB Plan",

"total_usage": 1649267441664,

"additional_usage": 549755813888,

"percentage": 150.00

}

]

}

Example XML

Request:

GET /v1/partners/barracuda/reports/plan_percentage HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>

<plan_percentage>

<username>barracuda_a</username>

<name>John Smith</name>

<company>barracuda</company>

<type>ACCOUNT</type>

<plan_name>1TB Plan</plan_name>

<total_usage>824633720832</total_usage>

<additional_usage>0</additional_usage>

</plan_percentage>

<plan_percentage>

<username>barracuda_p</username>

<name>John Smith</name>

<company>Barracuda</company>

<type>PARTNER</type>

<plan_name>1TB Plan</plan_name>

<total_usage>1649267441664</total_usage>

<additional_usage>549755813888</additional_usage>

</plan_percentage>

</list>