Methods
(route) delete(:id, :identifier)
Route:
| Method | Path |
|---|
| DELETE |
/api/bucket/:id/data/issues/:identifier |
Retrieve exceptions summary
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 |
| :identifier |
String |
the identifier of issue that you want to delete |
Response:
| Name |
Type |
Description |
| . |
Array |
array of deleted exceptions |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 400 |
missing/invalid parameters |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:identifier |
|
the identifier of issue that you want to delete |
(route) deleteAll(:id)
Route:
| Method | Path |
|---|
| DELETE |
/api/bucket/:id/data/issues |
Retrieve exceptions summary
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Query Parameters:
| Name |
Type |
Attributes |
Description |
| app_name |
String |
optional |
an specific application to delete application |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(async, route) findOccurences(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/data/issues/ocurrences |
Retrieve issues histogram
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| identifier |
Object |
optional |
|
find occurence by using an issue identifier |
| occurrence_id |
Object |
optional |
|
find ocurrence by his id |
| includeFixed |
Boolean |
optional |
false |
choose to ignore or not the fixed occurences |
| limit |
Number |
optional |
|
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 |
array of object containing ocurrences |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(async, route) getReplay(:id, :uuid)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/data/issues/replay/:uuid |
Retrieve issue replay
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 |
| :uuid |
String |
replay id |
Response:
| Name |
Type |
Description |
| replay |
String |
|
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:uuid |
|
replay id |
(async, route) list(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/data/issues/list |
Retrieve issues
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| server_name |
String |
optional |
filter exceptions by server source |
| app_name |
String |
optional |
filter exceptions by app source needed if initiator+source not provided |
| before |
String |
optional |
exclude exceptions older than 'before' minutes |
| initiator |
String |
optional |
filter exceptions by initiator (node/golang/browser/webcheck...) needed with source |
| source |
String |
optional |
filter exceptions by source (browser app id, webcheck id...) |
| tags |
Array |
optional |
array of string to filter tags |
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 exceptions |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(async, route) listOccurencesForIdentifier(:id, :identifier)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/data/issues/occurrences/:identifier |
Retrieve issues
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Query Parameters:
| Name |
Type |
Attributes |
Description |
| from |
Number |
optional |
|
| search_after |
Number |
optional |
|
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :identifier |
String |
issue identifier |
Response:
| Name |
Type |
Description |
| . |
Array |
array of occurrences id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:identifier |
|
issue identifier |
(route) retrieveHistogram(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/data/issues/histogram |
Retrieve issues histogram
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| app_name |
String |
optional |
|
a specific app name |
| start |
String |
optional |
|
ignore issue before this date |
| identifier |
String |
optional |
|
a specific issue identifier |
| interval |
String |
optional |
|
ignore issue before this date |
| end |
String |
optional |
|
ignore issue after this date |
| includeFixed |
Boolean |
optional |
false |
choose to ignore or not the fixed occurences |
| initiator |
String |
optional |
|
filter exceptions by initiator (node/golang/browser/webcheck...) needed with source |
| source |
String |
optional |
|
filter exceptions by source (browser app id, webcheck id...) |
| tags |
Array |
optional |
|
array of string to filter tags |
| includeEmptyDocs |
Boolean |
optional |
false |
add empty docs |
| invertedTags |
Boolean |
optional |
false |
filter issue without tags |
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 |
(route) search(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/data/issues/search |
Search for an issue message
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| message |
String |
|
|
find occurence that match this message |
| includeFixed |
Boolean |
optional |
false |
choose to ignore or not the fixed occurences |
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 |
(async, route) summary(:id, :aggregateBy)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/data/issues/summary/:aggregateBy |
Retrieve aggregated summary count
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 |
| :aggregateBy |
String |
servers, apps, initiators or sources |
Response:
| Name |
Type |
Description |
| . |
Array |
issues count aggregated |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:aggregateBy |
|
servers, apps, initiators or sources |