Methods
(route) retrieve(:id)
Route:
Method | Path |
POST |
/api/bucket/:id/data/logs |
Retrieve logs saved for an application
Authentication
A authentication is needed to access this endpoint
Body Parameters:
Name |
Type |
Attributes |
Description |
app_name |
String |
optional |
the application name |
server_name |
String |
optional |
filter by server name |
before |
String |
optional |
only search log oldest than |
after |
String |
optional |
only search log newer than |
size |
Integer |
optional |
line limit, default to 100 |
from |
Integer |
optional |
offset limit |
Header Parameters:
Name |
Type |
Description |
Authorization |
String |
bearer access token issued for the user |
Route Parameters:
Name |
Type |
Description |
:id |
String |
bucket id |
Response:
Name |
Type |
Description |
. |
Array |
recorded dependencies |
Response Code:
Type |
Description |
500 |
database error |
200 |
succesfully retrieved data |
400 |
missing parameters |
Example
km.data.logs.retrieve(bucket._id, {
app_name: 'my_api'
})
Parameters:
Name |
Type |
Description |
:id |
|
bucket id |
(route) retrieveHistogram(:id)
Route:
Method | Path |
POST |
/api/bucket/:id/data/logs/histogram |
Retrieve logs histogram
Authentication
A authentication is needed to access this endpoint
Body Parameters:
Name |
Type |
Attributes |
Description |
app_name |
Object |
optional |
a specific app name |
start |
Object |
optional |
ignore log before this date |
interval |
Object |
optional |
ignore log before this date |
end |
Object |
optional |
ignore log after this date |
Header Parameters:
Name |
Type |
Description |
Authorization |
String |
bearer access token issued for the user |
Route Parameters:
Name |
Type |
Description |
:id |
String |
bucket id |
Response:
Name |
Type |
Description |
. |
Array |
array of object containing exceptions for each application for each server |
Response Code:
Type |
Description |
500 |
database error |
200 |
succesfully retrieved data |
Parameters:
Name |
Type |
Description |
:id |
|
bucket id |