Skip to main content

Retrieve Storage Stats

GET 

/api/v1/stats/storage

RESPONSE JSON

The API call will return with a JSON response as below.

When user_id is not sent in parameters, the API returns consolidated stats for the user group. user_id will be set to * in this case.

{
"usergroup_id": 42,
"period": 24,
"data": {
"*": {
"/api/v1/assets/{ASSET_ID}/conversions": 8828,
"/api/v1/schema/{ID}": 426
}
}
}

When user_id is sent in parameters, the API returns stats for the user. user_id will be set to appropriate id in this case as below.

{
"usergroup_id": 42,
"period": 24,
"data": {
"42": {
"/api/v1/assets/{ASSET_ID}/conversions": 8828,
"/api/v1/schema/{ID}": 426
}
}
}
keyValueDescription
usergroup_idintegerUser group id
periodintegerthe period for which stats is returned. Defaults to 24 (hours)
dataJSONJSON with user_id as key. The list key "42" is the User IDs.
data.{user_id}stringKey-Value pairs with API as the key and count as the value. Note that IDs in API are replaced with placeholder {ASSET_ID} and {ID}

Request

Responses

Successful operation