BlenDB API API documentation

/metrics

A Metric represents a statistic that can be queried to generate reports. This collection allows the user to list all the metrics available in the system and their descriptions.

/dimensions

A Dimension allows the data to be aggregated by one or more columns. This collection allows the user to list all the dimensions available in the system and their descriptions.

/data

This is the main part of the API. You may query it for report data by specifying metrics (at least one). You may also supply additional query parameters such as dimensions, filters, and start/end dates to refine your query.

/data get

get

Request
Response

Query Parameters

filters: (string)
Filters that restrict the data returned for your request.
Example:
```
dim:location(4).id%3D%3D10723
```
metrics: required (string)
A list of comma-separated metrics.
Example:
```
met:daysSinceLastContact,met:estimatedNetworkBandwidth
```
dimensions: required (string)
A list of comma-separated dimensions.
Example:
```
dim:project,dim:point
```
start-date: (string - pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo))
Start date for fetching data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or NdaysAgo where N is a positive integer).
Example:
```
7daysAgo
```
end-date: (string - pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo))
End date for fetching data. Requests can specify a end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or NdaysAgo where N is a positive integer).
Example:
```
yesterday
```
sort: (string)
A list of comma-separated dimensions and metrics indicating the sorting order and sorting direction for the returned data.
Example:
```
dim:project
```

HTTP status code 200

Query successfully executed. Data is returned in a table format.

Body

Type: application/json

HTTP status code 400

The supplied query is invalid. Specified metric or dimension doesn't exist, incorrect formatting for a filter, unacceptable date range, etc.

Body

Type: application/json

Example:

{
    "id": "metric_not_found",
    "message": "The specified metric 'met:electricCharge' could not be found."
}

HTTP status code 403

API rate limit exceeded.

Headers

X-RateLimit-Limit: (integer)
X-RateLimit-Remaining: (integer)
X-RateLimit-Reset: (integer)

Body

Type: application/json

Example:

{
    id: "too_many_requests",
    message: "API Rate limit exceeded."
}

/collect/{sourceName}

This API may be used to send data to the monitoring system. All data sent must be identified with a sourceName, i.e. "gesacNetworkBandwidth".

/collect/{sourceName} post

post

Request
Response

URI Parameters

sourceName: required (string - minLength: 4 - maxLength: 64 - pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$)
An identifying name for the data that is being collected.

Body

Type: application/json

HTTP status code 200

Data has been successfully received and stored by the server.

HTTP status code 400

An error has been found in your request. You may review your request and the data that is being sent and try again later.

Body

Type: application/json

Example:

{
    "id": "type_error",
    "message": "Invalid type for attribute \"memory\"."
}

HTTP status code 403

API rate limit exceeded.

Headers

X-RateLimit-Limit: (integer)
X-RateLimit-Remaining: (integer)
X-RateLimit-Reset: (integer)

Body

Type: application/json

Example:

{
    id: "too_many_requests",
    message: "API Rate limit exceeded."
}

BlenDB API API documentation version v1

/metrics

/metrics get

/dimensions

/dimensions get

/data

/data get

/collect/{sourceName}

/collect/{sourceName} post

BlenDB API API documentation version v1

/metrics

/metrics get

get /metrics

Secured by

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/dimensions

/dimensions get

get /dimensions

Secured by

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/data

/data get

get /data

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Headers

Body

/collect/{sourceName}

/collect/{sourceName} post

post /collect/{sourceName}

URI Parameters

Body

HTTP status code 200

HTTP status code 400

Body

HTTP status code 403

Headers

Body