Get location metric values

Prev Next
Get
/data/locationValues

This method returns at maximum 1000 values at a time sorted by decreasing timestamp; to retrieve more values, multiple requests must be made with the last returned pageToken. If a time aggregation has been defined (e.g. AVG_HOURS_1), a maximum of 100 values are returned; to retrieve more values, multiple requests must be made with different start and end timestamps.

Required permissions: READ_LOCATION.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
locationId
stringRequired

The identifier of the location whose metric data is to be retrieved.

Minimum1.0
Exampleabcd1234
metricName
stringRequired

The name of the metric whose values must be retrieveed.

Maximum1.0
ExamplemetricAbc
pageSize
integer

The number of results to return in each result page (maximum = 1000).

Example1
endDate
integer (int64)

The end-date in milliseconds filtering result values.

startDate
integer (int64)

The start-date in milliseconds filtering result values.

pageToken
string

The page token used to retrieve the next page when there are more items than the page size.

Maximum1.0
aggregation
string

The aggregation function to be used to retrieve data. You can use AVG, DELTA, MIN, or MAX, and optionally concatenate the timeframe (e.g. AVG_DAYS_1), which can be one of the following: AUTO, HOURS_1, DAYS_1, MONTHS_1, YEARS_1.
According to the timeframe, the requested period is divided into a maximum of 100 intervals. If there are more than 100 intervals, the timeframe is automatically increased until the result interval count is less or equals than 100. If AUTO is used, the beast timeframe is selected in order to accomodate at maximum 100 intervals within the period. Without period aggregation, only one value is returned.

Maximum1.0
Responses
200

Successful operation.

Expand All
object
data
Array of object
object
timestamp
integer (int64)

The timestamp the metric value is associated to.

Example1695045244000
values
Array of object
object
name
string

The metric mapping name.

Examplestatus
value
string

The metric value.

ExampleWORKING
nextPageToken
string

The page token used to retrieve the next page when there are more items than the page size. If there are no more results the returned pageToken is null.

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error