Methods
(route) deleteAll(:id)
Route:
| Method | Path |
|---|
| DELETE |
/api/bucket/:id/data/events/delete_all |
Delete events
Authentication
A authentication is needed to access this endpoint
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 representing events emitted for each application name |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully deleted data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) retrieve(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/data/events |
Retrieve events
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| event_name |
String |
|
|
the event name to retrieve |
| start |
Date |
optional |
|
from which date to retrieve events |
| end |
Date |
optional |
|
to which date to retrieve events |
| app_name |
String |
optional |
|
filter events by app source |
| server_name |
String |
optional |
|
filter events by server source |
| limit |
Number |
optional |
100 |
limit the number of events to retrieve |
| offset |
Number |
optional |
0 |
offset research by X |
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 events |
Response Code:
| Type |
Description |
| 500 |
database error |
| 400 |
invalid parameters |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) retrieveHistogram(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/data/events/stats |
Retrieve histogram about a event (distribution)
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| event_name |
String |
|
|
the event name to retrieve |
| app_name |
String |
optional |
|
filter events by app source |
| server_name |
String |
optional |
|
filter events by server source |
| days |
Number |
optional |
2 |
limit the number of days of data |
| interval |
String |
optional |
minute |
interval of time between two point |
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 point (each point is one dimensional array, X are at 0 and Y at 1) |
Response Code:
| Type |
Description |
| 500 |
database error |
| 400 |
invalid parameters |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/data/eventsKeysByApp |
Retrieve metadata about events stored
Authentication
A authentication is needed to access this endpoint
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 representing events emitted for each application name |
Response Code:
| Type |
Description |
| 500 |
database error |
| 400 |
invalid parameters |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |