Overview
Error Handling

Methods

API Documentation (API Version bleed)

Asset/Measurements/

DESCRIPTION

This section of the API allows for interacting with a subaccount's measurements.

available

URL:

https://api.liquidweb.com/bleed/Asset/Measurements/available

Description:

Returns available measurements and their fields of which to pull measurement data.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
availableAn associative array of arbitrary keys and values.

Possible Errors:

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

current

URL:

https://api.liquidweb.com/bleed/Asset/Measurements/current

Description:

Returns current measurements for all available measurements.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
currentAn associative array of arbitrary keys and values.

Possible Errors:

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

lookup

URL:

https://api.liquidweb.com/bleed/Asset/Measurements/lookup

Description:

Lookup measurements for given fields and duration of a subaccnt. Return all measurement points as per lookup arguments.

Parameters:

ParameterTypeNotes
differenceA boolean value (0 or 1).
durationOne of: '12hour', '2week', '3day', '3month', '6hour', 'day', 'month'* Required
fieldsAn array of a single word, consisting of only letters, digits, and underscores.* Required
functionOne of: 'FIRST', 'LAST', 'MAX', 'MEAN', 'MIN', 'MODE', 'SUM'* Optional
  • Defaults to: MEAN
nameA single word, consisting of only letters, digits, and underscores.* Required
tagAn associative array containing the fields:
 
nameA single word, consisting of only letters, digits, and underscores.* Required
valueA single word, consisting of only letters, digits, and underscores.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dataAn array of arbitrary values.

Possible Errors:

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