Reporting API
Get Usage and Quota for a site
OVERVIEW
Purpose
API method to get usage and quota for mysite
Request URI
GET /reports/sites/{siteid}/usage
Sample request URL : https://domain.com/instance/api/1/reports/sites/1/usage
Assumptions :
- Method only supports MySite information
- <storageusage>/<storagequota> return size in Bytes
- The return values are of string type as NONE and UNLIMITED values can be returned based on system setting
- If user call API for normal site then the method return custom error (Not supported) with status code 501(Not Implemented)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reports>
<sitereports>
<sitereport>
<storageusage>530405145</storageusage>
<storagequota>10737418</storagequota>
</sitereport>
</sitereports>
</reports>
<reports>
<sitereports>
<sitereport>
<storageusage>530405145</storageusage>
<storagequota>10737418</storagequota>
</sitereport>
</sitereports>
</reports>
Response Code
Code | Meaning |
---|---|
200 | Response successfully |
501 | Not Implemented |
401 | Unauthorized |
403 | Validation failed/ Forbidden |
405 | Method not allowed (calling api with wrong method) |
500 | Internal error occured while uploading document |
Last Updated: Nov 08,2024
Comments
0 Comments