Overview
Error Handling

Methods

API Documentation (API Version bleed)

CloudSites/Usage/

DESCRIPTION

API's for reading usage data collected about cloud sites account.

byEndUserId

URL:

https://api.liquidweb.com/bleed/CloudSites/Usage/byEndUserId

Description:

Given an end user id, a time period beginning, and a time period end, return all usage data for all sites in that end user, for that time period.

periodBegin and periodEnd are given in ISO8601 format, for example:

    2016-08-03T15:03:24Z

All dates and times given in UTC.

Parameters:

ParameterTypeNotes
enduserIdA positive integer value (i.e. 1 and up).* Required
periodBeginAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
periodEndAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required

Returns:

FieldType
averagesAn array of associative arrays containing
 
metricA string.
quotaAn integer value.
valueA floating-point value.
childrenAn array of associative arrays containing
 
MSSQLA non-negative integer value (i.e. 0 and up).* Optional
MySQLA non-negative integer value (i.e. 0 and up).* Optional
NetappA non-negative integer value (i.e. 0 and up).* Optional
bandwidthoutA non-negative integer value (i.e. 0 and up).* Optional
computecyclesA non-negative integer value (i.e. 0 and up).* Optional
siteA string.
dailyTotalsAn array of associative arrays containing
 
dateAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
usageTotalAn associative array containing the fields:
 
MSSQLAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
MySQLAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
NetappAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
bandwidthoutAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
computecyclesAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

byResellerId

URL:

https://api.liquidweb.com/bleed/CloudSites/Usage/byResellerId

Description:

Given an reseller id, a time period beginning, and a time period end, return all usage data for all sites in that account, for that time period.

periodBegin and periodEnd are given in ISO8601 format, for example:

    2016-08-03T15:03:24Z

All dates and times given in UTC.

Parameters:

ParameterTypeNotes
periodBeginAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
periodEndAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
resellerIdAn integer value.* Required

Returns:

FieldType
averagesAn array of associative arrays containing
 
metricA string.
quotaAn integer value.
valueA floating-point value.
childrenAn array of associative arrays containing
 
MSSQLA non-negative integer value (i.e. 0 and up).* Optional
MySQLA non-negative integer value (i.e. 0 and up).* Optional
NetappA non-negative integer value (i.e. 0 and up).* Optional
bandwidthoutA non-negative integer value (i.e. 0 and up).* Optional
computecyclesA non-negative integer value (i.e. 0 and up).* Optional
enduserIdA positive integer value (i.e. 1 and up).
dailyTotalsAn array of associative arrays containing
 
dateAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
usageTotalAn associative array containing the fields:
 
MSSQLAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
MySQLAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
NetappAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
bandwidthoutAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
computecyclesAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

bySite

URL:

https://api.liquidweb.com/bleed/CloudSites/Usage/bySite

Description:

Given a site domain, a time period beginning, and a time period end, return all usage data for that site, for that time period.

periodBegin and periodEnd are given in ISO8601 format, for example:

    2016-08-03T15:03:24Z

All dates and times given in UTC.

Parameters:

ParameterTypeNotes
periodBeginAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
periodEndAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
siteA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldType
averagesAn array of associative arrays containing
 
metricA string.
quotaAn integer value.
valueA floating-point value.
dailyTotalsAn array of associative arrays containing
 
dateAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
usageTotalAn associative array containing the fields:
 
MSSQLAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
MySQLAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
NetappAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
bandwidthoutAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).
computecyclesAn associative array containing the fields:* Optional
 
unitOfMeasureA string.
valueA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

byUniqId

URL:

https://api.liquidweb.com/bleed/CloudSites/Usage/byUniqId

Description:

Given an subaccnt uniq id, a time period beginning, and a time period end, return all usage data for all sites in that account, for that time period.

periodBegin and periodEnd are given in ISO8601 format, for example:

    2016-08-03T15:03:24Z

All dates and times given in UTC.

Parameters:

ParameterTypeNotes
periodBeginAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
periodEndAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
itemsAn array of associative arrays containing
 
dataCenterA string permitting tabs, carriage returns and newlines
endTimeAn ISO8601 extended format date and time: 2013-09-29T10:40Z.* Optional
eventTimeAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
idA valid UUID (Universally Unique IDentifier).
metricA string permitting tabs, carriage returns and newlines
previousIdA valid UUID (Universally Unique IDentifier).
siteA string permitting tabs, carriage returns and newlines
valueA floating-point value.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types