API Endpoints

Last updated 6 months ago

get
Statistics

http://<host>:8181
/api/stats
This endpoint allows you to get storage statistics of the running Akumuli instance. It's also can be used as a test endpoint to test service availability.
Request
Response
200: OK
Storage statistics successfully retrieved.
{ "volume_0": { "free_space": "0", "file_name": "\/root\/.akumuli\/db_0.vol" }, "volume_1": { "free_space": "0", "file_name": "\/root\/.akumuli\/db_1.vol" }, "volume_2": { "free_space": "0", "file_name": "\/root\/.akumuli\/db_2.vol" }, "volume_3": { "free_space": "2027974656", "file_name": "\/root\/.akumuli\/db_3.vol" }}

post
Read query

http://<host>:8181
/api/query
This endpoint allows you to retrieve time-series data from the database. The client should provide valid query. The response will use chunked transfer encoding to return the results. The results are encoded using the RESP protocol.
Request
Response
Body Parameters
Query Body
required
object
JSON encoded query
200: OK
+RESP encoded data
+just like this
400: Bad Request
-RESP encoded error message
http://<host>:8181
/api/search
This API endpoint can be used to retreive the metadata like series names and tag values.
Request
Response
Path Parameters
Query Body
required
string
JSON encoded query
200: OK
+RESP encoded output
400: Bad Request
-RESP encoded error message

post
Suggest

http://<host>:8181
/api/suggest
This endpoint can be used to retrieve metric names, tag names, and tag values. It powers autocomplete function of the akumuli-datasource for Grafana.
Request
Response
Path Parameters
Query Body
optional
string
JSON encoded query
200: OK
+RESP encoded list or results
400: Bad Request
-RESP encoded error message

get
List functions

http://<host>:8181
/api/function-names
This endpoint can be used to retrieve the list of functions that can be used in queries.
Request
Response
200: OK
List of functions
absaccumulatecmacusumdiffdivideewmaewma-errorfrequent-itemsheavy-hittersmultiplyratescalesmasma-errorsumtop