Metrics REST API

Auto-generated swagger documentation

Overview

Media Type

The API uses JSON to communicate with clients.

You should add the following accept header to your requests:

Accept: application/json

When you send JSON data with a POST or PUT request, you must add the following content type header:

Content-Type: application/json

JSON format

The server does not include null or empty entity properties in JSON representations.

// Metric with data
{
  "id": "paris01.web001.example.com.cpu.usage",
  "data": [
    {"timestamp": 10101010101, "value": 25.73}
  ]
}

// Metric without data
{
  "id": "paris01.web001.example.com.cpu.usage"
}

Tenant Header

Hawkular Metrics is a multi-tenant time-series data store. Your requests to tenant-dependent resources must include a tenant header:

Hawkular-Tenant: my-tenant

Timestamps

The API understands all timestamps as milliseconds since January 1, 1970, 00:00:00 UTC.

Response codes

Resources in the API follow response codes conventions, listed below.

Table 1. Response codes conventions
Response code Meaning

200 Ok

The operation completed successfully.

201 Created

A POST or PUT operation to create an entity completed successfully. The reponse should contain a Location header.

204 No Content

The operation completed successfully but result entity is null (object) or empty (array). Empty arrays are not sent in the response body.

400 Bad Request

The operation could not be processed. It could be due to:

  • Missing or malformed request entity

  • Missing header/query parameter

  • Malformed path/header/query parameter

  • Invalid parameters (breaking business rules)

404 Not Found

Resource denoted by the URI does not exist.

405 Method Not Allowed

Resource denoted by the URI does not support the operation type.

406 Not Acceptable

Cannot reply in a format accepted by the client (specified in Accept request header).

409 Conflict

A POST or PUT operation could not be performed because it conflicts with an existing entity.

415 Unsupported Media Type

Invalid request entity format. For example, text/plain whereas application/json is expected.

500 Internal Server Error

Resource operation failed unexpectedly.

503 Service Unavailable

The server failed to initialize or the storage backend is not ready yet.

Error responses

Error responses may include an ApiError entity in the body.

Sample error entity
{"errorMsg":"Tenant is not specified. Use 'Hawkular-Tenant' header."}

Time ranges

Many resource operations need a time range restriction to be processed.

Such operations accept two timestamp query parameters:

  • start: the beginning of the time range, inclusive

  • end: the end of the time range, exclusive

Either or both of them can be omitted. start defaults to now minus 8 eight hours. end defaults to now.

end must be strictly bigger than start otherwise the resource operation returns a 400 Bad Request response.

Sample operations with time range query parameters
# Implicit time range
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data

# Implicit time range
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=10101010

# Explicit time range
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=10101010&end=20202020

# Implicit time range
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?end=20202020

Limit and Order

The API offers the ability to limit the number of data points returned as well specify the order of the results. Limit and order only work with raw data; if used in conjunction with bucketed results, it will return an error.

Usage and default value details:

  • ascending order parameter value is asc

  • descending order parameter value is desc

  • parameter value matching is case-insensitive

  • default order is descending

  • no limit imposed if parameter not specified

  • limit of 0 or negative is equivalent to no limit

  • if the user specifies limit, then the order is important because it returns data points up to limit in the specified order

  • start time and end time influence the default order if actual limit is specified

    • if only start time is specified then order is ascending

    • if only end time is specified then order is descending

    • if both are specified then order is descending

    • if none are specified then order is descending

    • order defaults are overridden if order specified

  • default order is descending if limit is not specified regardless of specified time range

please refer to Time Ranges section for defaults when omitting end, start, or both.

Sample operations with time range query parameters

# Implicit time range, not limit, and descending order
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data

# Explicit limit of 10, implicit time range, implicit descending order
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?limit=10

# Explicit limit of 10, implicit time range, explicit ascending order
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?limit=10&order=ASC

# Explicit limit of 10, explicit time range, implicit descending order
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=10101010&end=20202020&limit=10

# Explicit limit of 10, explicit start, implicit end, implicit ascending order
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=20202020&limit=10

# Explicit limit of 10, explicit start, implicit end, explicit descending order
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=20202020&limit=10&order=DESC

Bucket parameters

The API offers the ability to retrieve statistics on gauges, counter and availability metrics. To compute these statistics, Hawkular Metrics slices a given time range into buckets.

The size of buckets is configurable. This allows to send a query to get, for example, monthly statistics over a year of data, or hourly statistics over a week of data.

Bucket size is configured with either the buckets or the bucketDuration query parameter, exclusively:

  • buckets indicates the desired number of buckets over the specified timerange

  • bucketDuration forces bucket size to the specified amount of time

bucketDuration is a duration-formatted string.

If both parameters are specified, the resource operation returns a 400 Bad Request response.

Sample operations with bucket query parameters
# Desired number of buckets
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=10101010&end=20202020&buckets=10

# Desired bucket size
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?start=10101010&end=20202020&bucketDuration=1mn

Custom string formats

Some path or query parameters in the Metrics REST API use custom string formats.

Tags list

The parameter represents a list of tags, comma separated. A tag has the form name:value. Names and values cannot contain commas or colons.

Throughout this document, this string format is identified as tag-list.

Tags List format example
/hawkular/metrics/metrics?tags=host:web001.example.com,dc:paris01,type:system

Duration

The parameter represents an amount of time. Duration is formed of a length and a unit.

Length is a long integer (int64).

Allowed units are the following:

  • ms for milliseconds

  • s for seconds

  • mn for minutes

  • h for hours

  • d for days

Throughout this document, this string format is identified as duration.

Duration format example
/hawkular/metrics/gauges/paris01.web001.example.com.cpu.usage/data?bucketDuration=1h

Base Path

/hawkular/metrics/

REST APIs

Availability

  1. Find tenant’s metric definitions.

  2. Create availability metric.

  3. Deprecated. Please use /raw endpoint.

  4. Add metric data for multiple availability metrics in a single call.

  5. Retrieve gauge type’s tag values

  6. Retrieve single metric definition.

  7. Deprecated. Please use /raw or /stats endpoints.

  8. Deprecated. Please use /raw endpoint.

  9. Retrieve availability data.

  10. Add data for a single availability metric.

  11. Retrieve availability data.

  12. Retrieve tags associated with the metric definition.

  13. Update tags associated with the metric definition.

  14. Delete tags associated with the metric definition.

Endpoint GET /availability

Find tenant’s metric definitions.
Does not include any metric values.

Query parameters

Parameter Required Description Type Format Allowable Values

tags

No

List of tags filters

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Successfully retrieved at least one metric definition.

array of Metric

204

No metrics found.

-

400

Invalid type parameter type.

ApiError

500

Failed to retrieve metrics due to unexpected error.

ApiError

Endpoint POST /availability

Create availability metric.
Same notes as creating gauge metric apply.

Query parameters

Parameter Required Description Type Format Allowable Values

overwrite

No

Overwrite previously created metric configuration if it exists. Only data retention and tags are overwriten; existing data points are unnafected. Defaults to false.

boolean

-

-

Body

Required Description Data Type

Yes

-

MetricAvailabilityType

Response

Status codes

Status Code Reason Response Model

201

Metric created successfully

-

400

Missing or invalid payload

ApiError

409

Availability metric with given id already exists

ApiError

500

Metric creation failed due to an unexpected error

ApiError

Endpoint POST /availability/data

Deprecated. Please use /raw endpoint.

Body

Required Description Data Type

Yes

List of availability metrics

array of MetricAvailabilityType

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint POST /availability/raw

Add metric data for multiple availability metrics in a single call.

Body

Required Description Data Type

Yes

List of availability metrics

array of MetricAvailabilityType

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /availability/tags/{tags}

Retrieve gauge type’s tag values

Path parameters

Parameter Required Description Type Format Allowable Values

tags

Yes

Tag query

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Tags successfully retrieved.

object

204

No matching tags were found

-

500

Unexpected error occurred while fetching tags.

ApiError

Endpoint GET /availability/{id}

Retrieve single metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s definition was successfully retrieved.

Metric

204

Query was successful, but no metrics definition is set.

-

500

Unexpected error occurred while fetching metric’s definition.

ApiError

Endpoint GET /availability/{id}/data

Deprecated. Please use /raw or /stats endpoints.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

distinct

No

Set to true to return only distinct, contiguous values

boolean

-

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

successful operation

array of DataPoint

Endpoint POST /availability/{id}/data

Deprecated. Please use /raw endpoint.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of availability datapoints

array of DataPointAvailabilityType

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /availability/{id}/raw

Retrieve availability data.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

distinct

No

Set to true to return only distinct, contiguous values

boolean

-

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched availability data.

array of DataPoint

204

No availability data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching availability data.

ApiError

Endpoint POST /availability/{id}/raw

Add data for a single availability metric.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of availability datapoints

array of DataPointAvailabilityType

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /availability/{id}/stats

Retrieve availability data.
Based on buckets or bucketDuration query parameter, the time range between start and end will be divided in buckets of equal duration, and availability statistics will be computed for each bucket.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched availability data.

array of DataPoint

204

No availability data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching availability data.

ApiError

Endpoint GET /availability/{id}/tags

Retrieve tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully retrieved.

object

204

Query was successful, but no metrics were found.

-

500

Unexpected error occurred while fetching metric’s tags.

ApiError

Endpoint PUT /availability/{id}/tags

Update tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

object

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully updated.

-

500

Unexpected error occurred while updating metric’s tags.

ApiError

Endpoint DELETE /availability/{id}/tags/{tags}

Delete tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

tags

Yes

Tag names

string

-

Comma-separated list of tag names

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully deleted.

-

400

Invalid tags

ApiError

500

Unexpected error occurred while trying to delete metric’s tags.

ApiError

Counter

  1. Find tenant’s counter metric definitions.

  2. Create counter metric.

  3. Deprecated. Please use /stats endpoint.

  4. Deprecated. Please use /raw endpoint.

  5. Deprecated. Please use /rate/stats endpoint.

  6. Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied to the data points in each bucket to produce statistics or aggregated metrics.

  7. Add data points for multiple counters.

  8. Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied tothe data points in each bucket to produce statistics or aggregated metrics.

  9. Retrieve counter type’s tag values

  10. Retrieve a counter definition.

  11. Deprecated. Please use /raw or /stats endpoints

  12. Deprecated. Please use /raw endpoint.

  13. Retrieve counter rate data points.

  14. Retrieve stats for counter rate data points.

  15. Retrieve counter data points.

  16. Add data for a single counter.

  17. Retrieve counter data points.

  18. Fetches data points and groups them into buckets based on one or more tag filters. The data points in each bucket are then transformed into aggregated (i.e., bucket) data points.

  19. Retrieve tags associated with the metric definition.

  20. Update tags associated with the metric definition.

  21. Delete tags associated with the metric definition.

Endpoint GET /counters

Find tenant’s counter metric definitions.
Does not include any metric values.

Query parameters

Parameter Required Description Type Format Allowable Values

tags

No

List of tags filters

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Successfully retrieved at least one metric definition.

array of Metric

204

No metrics found.

-

400

Invalid type parameter type.

ApiError

500

Failed to retrieve metrics due to unexpected error.

ApiError

Endpoint POST /counters

Create counter metric.
This operation also causes the rate to be calculated and persisted periodically after raw count data is persisted. Clients are not required to explicitly create a metric before storing data. Doing so however allows clients to prevent naming collisions and to specify tags and data retention.

Query parameters

Parameter Required Description Type Format Allowable Values

overwrite

No

Overwrite previously created metric configuration if it exists. Only data retention and tags are overwriten; existing data points are unnafected. Defaults to false.

boolean

-

-

Body

Required Description Data Type

Yes

-

MetricLong

Response

Status codes

Status Code Reason Response Model

201

Metric created successfully

-

400

Missing or invalid payload

ApiError

409

Counter metric with given id already exists

ApiError

500

Metric creation failed due to an unexpected error

ApiError

Endpoint GET /counters/data

Deprecated. Please use /stats endpoint.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

successful operation

array of NumericBucketPoint

Endpoint POST /counters/data

Deprecated. Please use /raw endpoint.

Body

Required Description Data Type

Yes

List of metrics

array of MetricLong

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /counters/rate

Deprecated. Please use /rate/stats endpoint.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

successful operation

array of NumericBucketPoint

Endpoint GET /counters/rate/stats

Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied to the data points in each bucket to produce statistics or aggregated metrics.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of NumericBucketPoint

204

No metric data was found.

-

400

The tags parameter is required. Either the buckets or the bucketDuration parameter is required but not both.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint POST /counters/raw

Add data points for multiple counters.

Body

Required Description Data Type

Yes

List of metrics

array of MetricLong

Response

Status codes

Status Code Reason Response Model

200

Adding data points succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data points

ApiError

Endpoint GET /counters/stats

Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied tothe data points in each bucket to produce statistics or aggregated metrics.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of NumericBucketPoint

204

No metric data was found.

-

400

The tags parameter is required. Either the buckets or the bucketDuration parameter is required but not both.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /counters/tags/{tags}

Retrieve counter type’s tag values

Path parameters

Parameter Required Description Type Format Allowable Values

tags

Yes

Tag query

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Tags successfully retrieved.

object

204

No matching tags were found

-

500

Unexpected error occurred while fetching tags.

ApiError

Endpoint GET /counters/{id}

Retrieve a counter definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s definition was successfully retrieved.

Metric

204

Query was successful, but no metrics definition is set.

-

500

Unexpected error occurred while fetching metric’s definition.

ApiError

Endpoint GET /counters/{id}/data

Deprecated. Please use /raw or /stats endpoints

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

fromEarliest

No

Use data from earliest received, subject to retention period

boolean

-

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

successful operation

array of DataPoint

Endpoint POST /counters/{id}/data

Deprecated. Please use /raw endpoint.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of data points containing timestamp and value

array of DataPointLong

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /counters/{id}/rate

Retrieve counter rate data points.
Bucket related parameters as well as percentiles are deprecated, please use rate/stats for bucketed results. When buckets or bucketDuration query parameter is used, the time range between start and end will be divided in buckets of equal duration, and metric statistics will be computed for each bucket. Reset events are detected and data points that immediately follow such events are filtered out prior to calculating the rates. This avoid misleading or inaccurate rates when resets occur.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /counters/{id}/rate/stats

Retrieve stats for counter rate data points.
The time range between start and end will be divided in buckets of equal duration, and metric statistics will be computed for each bucket. Reset events are detected and data points that immediately follow such events are filtered out prior to calculating the rates. This avoid misleading or inaccurate rates when resets occur.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /counters/{id}/raw

Retrieve counter data points.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint POST /counters/{id}/raw

Add data for a single counter.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of data points containing timestamp and value

array of DataPointLong

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /counters/{id}/stats

Retrieve counter data points.
When buckets or bucketDuration query parameter is used, the time range between start and end will be divided in buckets of equal duration, and metric statistics will be computed for each bucket.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

fromEarliest

No

Use data from earliest received, subject to retention period

boolean

-

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /counters/{id}/stats/tags/{tags}

Fetches data points and groups them into buckets based on one or more tag filters. The data points in each bucket are then transformed into aggregated (i.e., bucket) data points.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

tags

Yes

Tags

string

tag-list

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

object

204

No metric data was found.

-

400

Tags are invalid

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /counters/{id}/tags

Retrieve tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully retrieved.

object

204

Query was successful, but no metrics were found.

-

500

Unexpected error occurred while fetching metric’s tags.

ApiError

Endpoint PUT /counters/{id}/tags

Update tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

object

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully updated.

-

500

Unexpected error occurred while updating metric’s tags.

ApiError

Endpoint DELETE /counters/{id}/tags/{tags}

Delete tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

tags

Yes

Tag names

string

-

Comma-separated list of tag names

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully deleted.

-

400

Invalid tags

ApiError

500

Unexpected error occurred while trying to delete metric’s tags.

ApiError

Gauge

  1. Find tenant’s metric definitions.

  2. Create gauge metric.

  3. Deprecated. Please use /stast endpoint.

  4. Deprecated. Please use /raw endpoint.

  5. Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied to the data points in each bucket to produce statistics or aggregated metrics.

  6. Add data for multiple gauge metrics in a single call.

  7. Find stats for multiple metrics.

  8. Retrieve gauge type’s tag values

  9. Retrieve single metric definition.

  10. Deprecated. Please use /raw or /stats endpoints.

  11. Deprecated. Please use /raw endpoint.

  12. Find condition periods.

  13. Retrieve gauge rate data points.

  14. Retrieve stats for gauge rate data points.

  15. Retrieve raw gauge data.

  16. Add data for a single gauge metric.

  17. Retrieve gauge data.

  18. Fetches data points and groups them into buckets based on one or more tag filters. The data points in each bucket are then transformed into aggregated (i.e., bucket) data points.

  19. Retrieve tags associated with the metric definition.

  20. Update tags associated with the metric definition.

  21. Delete tags associated with the metric definition.

Endpoint GET /gauges

Find tenant’s metric definitions.
Does not include any metric values.

Query parameters

Parameter Required Description Type Format Allowable Values

tags

No

List of tags filters

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Successfully retrieved at least one metric definition.

array of Metric

204

No metrics found.

-

400

Invalid type parameter type.

ApiError

500

Failed to retrieve metrics due to unexpected error.

ApiError

Endpoint POST /gauges

Create gauge metric.
Clients are not required to explicitly create a metric before storing data. Doing so however allows clients to prevent naming collisions and to specify tags and data retention.

Query parameters

Parameter Required Description Type Format Allowable Values

overwrite

No

Overwrite previously created metric configuration if it exists. Only data retention and tags are overwriten; existing data points are unnafected. Defaults to false.

boolean

-

-

Body

Required Description Data Type

Yes

-

MetricDouble

Response

Status codes

Status Code Reason Response Model

201

Metric created successfully

-

400

Missing or invalid payload

ApiError

409

Gauge metric with given id already exists

ApiError

500

Metric creation failed due to an unexpected error

ApiError

Endpoint GET /gauges/data

Deprecated. Please use /stast endpoint.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

successful operation

array of NumericBucketPoint

Endpoint POST /gauges/data

Deprecated. Please use /raw endpoint.

Body

Required Description Data Type

Yes

List of metrics

array of MetricDouble

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /gauges/rate/stats

Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied to the data points in each bucket to produce statistics or aggregated metrics.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of NumericBucketPoint

204

No metric data was found.

-

400

The tags parameter is required. Either the buckets or the bucketDuration parameter is required but not both.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint POST /gauges/raw

Add data for multiple gauge metrics in a single call.

Body

Required Description Data Type

Yes

List of metrics

array of MetricDouble

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /gauges/stats

Find stats for multiple metrics.
Fetches data points from one or more metrics that are determined using either a tags filter or a list of metric names. The time range between start and end is divided into buckets of equal size (i.e., duration) using either the buckets or bucketDuration parameter. Functions are applied to the data points in each bucket to produce statistics or aggregated metrics.

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

tags

No

List of tags filters

string

tag-list

-

metrics

No

List of metric names

array

-

-

stacked

No

Downsample method (if true then sum of stacked individual stats; defaults to false)

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of NumericBucketPoint

204

No metric data was found.

-

400

The tags parameter is required. Either the buckets or the bucketDuration parameter is required but not both.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /gauges/tags/{tags}

Retrieve gauge type’s tag values

Path parameters

Parameter Required Description Type Format Allowable Values

tags

Yes

Tag query

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Tags successfully retrieved.

object

204

No matching tags were found

-

500

Unexpected error occurred while fetching tags.

ApiError

Endpoint GET /gauges/{id}

Retrieve single metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s definition was successfully retrieved.

Metric

204

Query was successful, but no metrics definition is set.

-

500

Unexpected error occurred while fetching metric’s definition.

ApiError

Endpoint GET /gauges/{id}/data

Deprecated. Please use /raw or /stats endpoints.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

fromEarliest

No

Use data from earliest received, subject to retention period

boolean

-

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint POST /gauges/{id}/data

Deprecated. Please use /raw endpoint.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of datapoints containing timestamp and value

array of DataPointDouble

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /gauges/{id}/periods

Find condition periods.
Retrieve periods for which the condition holds true for each consecutive data point.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

threshold

Yes

A threshold against which values are compared

number

double

-

op

Yes

A comparison operation to perform between values and the threshold.

string

-

ge, gte, lt, lte, eq, neq

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched periods.

array of object

204

No data was found.

-

400

Missing or invalid query parameters

ApiError

Endpoint GET /gauges/{id}/rate

Retrieve gauge rate data points.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

Time range is invalid.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /gauges/{id}/rate/stats

Retrieve stats for gauge rate data points.
The time range between start and end will be divided in buckets of equal duration, and metric statistics will be computed for each bucket.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /gauges/{id}/raw

Retrieve raw gauge data.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

fromEarliest

No

Use data from earliest received, subject to retention period

boolean

-

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint POST /gauges/{id}/raw

Add data for a single gauge metric.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of datapoints containing timestamp and value

array of DataPointDouble

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /gauges/{id}/stats

Retrieve gauge data.
The time range between start and end will be divided in buckets of equal duration, and metric statistics will be computed for each bucket.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

fromEarliest

No

Use data from earliest received, subject to retention period

boolean

-

-

buckets

No

Total number of buckets

integer

int32

-

bucketDuration

No

Bucket duration

string

duration

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

array of DataPoint

204

No metric data was found.

-

400

buckets or bucketDuration parameter is invalid, or both are used.

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /gauges/{id}/stats/tags/{tags}

Fetches data points and groups them into buckets based on one or more tag filters. The data points in each bucket are then transformed into aggregated (i.e., bucket) data points.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

tags

Yes

Tags

string

tag-list

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

percentiles

No

Percentiles to calculate

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched metric data.

object

204

No metric data was found.

-

400

Tags are invalid

ApiError

500

Unexpected error occurred while fetching metric data.

ApiError

Endpoint GET /gauges/{id}/tags

Retrieve tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully retrieved.

object

204

Query was successful, but no metrics were found.

-

500

Unexpected error occurred while fetching metric’s tags.

ApiError

Endpoint PUT /gauges/{id}/tags

Update tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

object

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully updated.

-

500

Unexpected error occurred while updating metric’s tags.

ApiError

Endpoint DELETE /gauges/{id}/tags/{tags}

Delete tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

tags

Yes

Tag names

string

-

Comma-separated list of tag names

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully deleted.

-

400

Invalid tags

ApiError

500

Unexpected error occurred while trying to delete metric’s tags.

ApiError

Metric

  1. Find tenant’s metric definitions.

  2. Create metric.

  3. Deprecated. Please use /raw endpoint.

  4. Add data points for multiple metrics in a single call.

  5. Retrieve metrics' tag values

Endpoint GET /metrics

Find tenant’s metric definitions.
Does not include any metric values.

Query parameters

Parameter Required Description Type Format Allowable Values

type

No

Queried metric type

string

-

gauge, availability, counter

tags

No

List of tags filters

string

tag-list

-

id

No

Regexp to match metricId, requires tags filtering

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Successfully retrieved at least one metric definition.

array of Metric

204

No metrics found.

-

400

Invalid type parameter type.

ApiError

500

Failed to retrieve metrics due to unexpected error.

ApiError

Endpoint POST /metrics

Create metric.
Clients are not required to explicitly create a metric before storing data. Doing so however allows clients to prevent naming collisions and to specify tags and data retention.

Query parameters

Parameter Required Description Type Format Allowable Values

overwrite

No

Overwrite previously created metric if it exists. Defaults to false.

boolean

-

-

Body

Required Description Data Type

Yes

-

MetricObject

Response

Status codes

Status Code Reason Response Model

201

Metric created successfully

-

400

Missing or invalid payload

ApiError

409

Metric with given id already exists

ApiError

500

Metric creation failed due to an unexpected error

ApiError

Endpoint POST /metrics/data

Deprecated. Please use /raw endpoint.

Body

Required Description Data Type

Yes

List of metrics

MixedMetricsRequest

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint POST /metrics/raw

Add data points for multiple metrics in a single call.

Body

Required Description Data Type

Yes

List of metrics

MixedMetricsRequest

Response

Status codes

Status Code Reason Response Model

200

Adding data points succeeded.

-

400

Missing or invalid payload.

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /metrics/tags/{tags}

Retrieve metrics' tag values

Path parameters

Parameter Required Description Type Format Allowable Values

tags

Yes

Tag query

string

tag-list

-

Query parameters

Parameter Required Description Type Format Allowable Values

type

No

Queried metric type

string

-

gauge, availability, counter

Response

Status codes

Status Code Reason Response Model

200

Tags successfully retrieved.

object

204

No matching tags were found

-

500

Unexpected error occurred while fetching tags.

ApiError

String

  1. Find tenant’s metric definitions.

  2. Create string metric.

  3. Add metric data for multiple string metrics in a single call.

  4. Retrieve string type’s tag values

  5. Retrieve single metric definition.

  6. Retrieve string data.

  7. Add data for a single string metric.

  8. Retrieve tags associated with the metric definition.

  9. Update tags associated with the metric definition.

  10. Delete tags associated with the metric definition.

Endpoint GET /strings

Find tenant’s metric definitions.
Does not include any metric values.

Query parameters

Parameter Required Description Type Format Allowable Values

tags

No

List of tags filters

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Successfully retrieved at least one metric definition.

array of Metric

204

No metrics found.

-

400

Invalid type parameter type.

ApiError

500

Failed to retrieve metrics due to unexpected error.

ApiError

Endpoint POST /strings

Create string metric.
Clients are not required to explicitly create a metric before storing data. Doing so however allows clients to prevent naming collisions and to specify tags and data retention.

Query parameters

Parameter Required Description Type Format Allowable Values

overwrite

No

Overwrite previously created metric configuration if it exists. Only data retention and tags are overwriten; existing data points are unnafected. Defaults to false.

boolean

-

-

Body

Required Description Data Type

Yes

-

MetricString

Response

Status codes

Status Code Reason Response Model

201

Metric created successfully

-

400

Missing or invalid payload

ApiError

409

String metric with given id already exists

ApiError

500

Metric creation failed due to an unexpected error

ApiError

Endpoint POST /strings/raw

Add metric data for multiple string metrics in a single call.

Body

Required Description Data Type

Yes

List of string metrics

array of MetricString

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /strings/tags/{tags}

Retrieve string type’s tag values

Path parameters

Parameter Required Description Type Format Allowable Values

tags

Yes

Tag query

string

tag-list

-

Response

Status codes

Status Code Reason Response Model

200

Tags successfully retrieved.

object

204

No matching tags were found

-

500

Unexpected error occurred while fetching tags.

ApiError

Endpoint GET /strings/{id}

Retrieve single metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s definition was successfully retrieved.

Metric

204

Query was successful, but no metrics definition is set.

-

500

Unexpected error occurred while fetching metric’s definition.

ApiError

Endpoint GET /strings/{id}/raw

Retrieve string data.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

start

No

Defaults to now - 8 hours

integer

int64

-

end

No

Defaults to now

integer

int64

-

distinct

No

Set to true to return only distinct, contiguous values

boolean

-

-

limit

No

Limit the number of data points returned

integer

int32

-

order

No

Data point sort order, based on timestamp

string

-

ASC, DESC

Response

Status codes

Status Code Reason Response Model

200

Successfully fetched string data.

array of DataPoint

204

No string data was found.

-

500

Unexpected error occurred while fetching string data.

ApiError

Endpoint POST /strings/{id}/raw

Add data for a single string metric.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

List of string datapoints

array of DataPointString

Response

Status codes

Status Code Reason Response Model

200

Adding data succeeded.

-

400

Missing or invalid payload

ApiError

500

Unexpected error happened while storing the data

ApiError

Endpoint GET /strings/{id}/tags

Retrieve tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully retrieved.

object

204

Query was successful, but no metrics were found.

-

500

Unexpected error occurred while fetching metric’s tags.

ApiError

Endpoint PUT /strings/{id}/tags

Update tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

object

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully updated.

-

500

Unexpected error occurred while updating metric’s tags.

ApiError

Endpoint DELETE /strings/{id}/tags/{tags}

Delete tags associated with the metric definition.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

tags

Yes

Tag names

string

-

Comma-separated list of tag names

Response

Status codes

Status Code Reason Response Model

200

Metric’s tags were successfully deleted.

-

400

Invalid tags

ApiError

500

Unexpected error occurred while trying to delete metric’s tags.

ApiError

Tenant

  1. Returns a list of tenants.

  2. Create a new tenant.

Endpoint GET /tenants

Returns a list of tenants.

Response

Status codes

Status Code Reason Response Model

200

Returned a list of tenants successfully.

array of Tenant

204

No tenants were found.

-

500

Unexpected error occurred while fetching tenants.

ApiError

Endpoint POST /tenants

Create a new tenant.
Clients are not required to create explicitly create a tenant before starting to store metric data. It is recommended to do so however to ensure that there are no tenant id naming collisions and to provide default data retention settings.

Query parameters

Parameter Required Description Type Format Allowable Values

overwrite

No

Overwrite previously created tenant configuration if it exists. Only data retention settings are overwriten; existing metrics and data points are unnafected. Defaults to false.

boolean

-

-

Body

Required Description Data Type

Yes

-

Tenant

Response

Status codes

Status Code Reason Response Model

201

Tenant has been succesfully created.

-

400

Missing or invalid retention properties.

ApiError

409

Given tenant id has already been created.

ApiError

500

An unexpected error occured while trying to create a tenant.

ApiError

Data Types

ApiError

Name Required Description Type Format Allowable Values

errorMsg

Yes

Detailed error message of what happened

string

-

-

DataPoint

Name Required Description Type Format Allowable Values

tags

No

-

object

-

-

timestamp

Yes

-

integer

int64

-

value

Yes

-

object

-

-

DataPointAvailabilityType

Name Required Description Type Format Allowable Values

tags

No

-

object

-

-

timestamp

Yes

-

integer

int64

-

value

Yes

-

string

-

UP, DOWN, UNKNOWN

DataPointDouble

Name Required Description Type Format Allowable Values

tags

No

-

object

-

-

timestamp

Yes

-

integer

int64

-

value

Yes

-

number

double

-

DataPointLong

Name Required Description Type Format Allowable Values

tags

No

-

object

-

-

timestamp

Yes

-

integer

int64

-

value

Yes

-

integer

int64

-

DataPointObject

Name Required Description Type Format Allowable Values

tags

No

-

object

-

-

timestamp

Yes

-

integer

int64

-

value

Yes

-

object

-

-

DataPointString

Name Required Description Type Format Allowable Values

tags

No

-

object

-

-

timestamp

Yes

-

integer

int64

-

value

Yes

-

string

-

-

Metric

Name Required Description Type Format Allowable Values

dataPoints

No

Metric data points

array of DataPointObject

-

-

dataRetention

No

How long, in days, a data point of this metric stays in the system after it is stored

integer

int32

-

id

No

-

string

-

-

maxTimestamp

No

Timestamp of the metric’s most recent data point

integer

int64

-

minTimestamp

No

Timestamp of the metric’s oldest data point

integer

int64

-

tags

No

Metric tags

object

-

-

tenantId

No

-

string

-

-

type

No

Metric type

string

-

gauge, availability, counter

MetricAvailabilityType

Name Required Description Type Format Allowable Values

dataPoints

No

Metric data points

array of DataPointAvailabilityType

-

-

dataRetention

No

How long, in days, a data point of this metric stays in the system after it is stored

integer

int32

-

id

No

-

string

-

-

maxTimestamp

No

Timestamp of the metric’s most recent data point

integer

int64

-

minTimestamp

No

Timestamp of the metric’s oldest data point

integer

int64

-

tags

No

Metric tags

object

-

-

tenantId

No

-

string

-

-

type

No

Metric type

string

-

gauge, availability, counter

MetricDouble

Name Required Description Type Format Allowable Values

dataPoints

No

Metric data points

array of DataPointDouble

-

-

dataRetention

No

How long, in days, a data point of this metric stays in the system after it is stored

integer

int32

-

id

No

-

string

-

-

maxTimestamp

No

Timestamp of the metric’s most recent data point

integer

int64

-

minTimestamp

No

Timestamp of the metric’s oldest data point

integer

int64

-

tags

No

Metric tags

object

-

-

tenantId

No

-

string

-

-

type

No

Metric type

string

-

gauge, availability, counter

MetricLong

Name Required Description Type Format Allowable Values

dataPoints

No

Metric data points

array of DataPointLong

-

-

dataRetention

No

How long, in days, a data point of this metric stays in the system after it is stored

integer

int32

-

id

No

-

string

-

-

maxTimestamp

No

Timestamp of the metric’s most recent data point

integer

int64

-

minTimestamp

No

Timestamp of the metric’s oldest data point

integer

int64

-

tags

No

Metric tags

object

-

-

tenantId

No

-

string

-

-

type

No

Metric type

string

-

gauge, availability, counter

MetricObject

Name Required Description Type Format Allowable Values

dataPoints

No

Metric data points

array of DataPointObject

-

-

dataRetention

No

How long, in days, a data point of this metric stays in the system after it is stored

integer

int32

-

id

No

-

string

-

-

maxTimestamp

No

Timestamp of the metric’s most recent data point

integer

int64

-

minTimestamp

No

Timestamp of the metric’s oldest data point

integer

int64

-

tags

No

Metric tags

object

-

-

tenantId

No

-

string

-

-

type

No

Metric type

string

-

gauge, availability, counter

MetricString

Name Required Description Type Format Allowable Values

dataPoints

No

Metric data points

array of DataPointString

-

-

dataRetention

No

How long, in days, a data point of this metric stays in the system after it is stored

integer

int32

-

id

No

-

string

-

-

maxTimestamp

No

Timestamp of the metric’s most recent data point

integer

int64

-

minTimestamp

No

Timestamp of the metric’s oldest data point

integer

int64

-

tags

No

Metric tags

object

-

-

tenantId

No

-

string

-

-

type

No

Metric type

string

-

gauge, availability, counter

MixedMetricsRequest

Name Required Description Type Format Allowable Values

availabilities

No

-

array of MetricAvailabilityType

-

-

counters

No

-

array of MetricLong

-

-

gauges

No

-

array of MetricDouble

-

-

strings

No

-

array of MetricString

-

-

NumericBucketPoint

Name Required Description Type Format Allowable Values

avg

No

-

number

double

-

empty

No

-

boolean

-

-

end

No

-

integer

int64

-

max

No

-

number

double

-

median

No

-

number

double

-

min

No

-

number

double

-

percentiles

No

-

array of Percentile

-

-

samples

No

-

integer

int32

-

start

No

-

integer

int64

-

sum

No

-

number

double

-

Percentile

Name Required Description Type Format Allowable Values

quantile

No

-

number

double

-

value

No

-

number

double

-

Tenant

Name Required Description Type Format Allowable Values

id

Yes

Identifier of the tenant

string

-

-

retentions

No

Retention settings for metrics, expressed in days

object

-

-

redhatlogo-white

© 2016 | Hawkular is released under Apache License v2.0