transactions - Documentation

# transactions

### Methods

#### (route) delete(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/transactions/v2/delete

Delete transaction data

##### 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 | filter transactions by app source
server_name | String | optional | filter transactions by server source

##### Route Parameters:

Name | Type | Description
--- | --- | ---
:id | String | bucket id

##### Response:

Name | Type | Description
--- | --- | ---
server_name | Object |
server_name.app_name | Object | transaction object

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id

#### (route) retrieveHistogram(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/transactions/v2/histogram

Retrieve transaction histograms

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
app_name | String | optional |  | filter transactions by app source
server_name | String | optional |  | filter transactions by server source
interval | String | optional | minute | interval of time between two point
before | String | optional | 60 | filter out transactions that are after X minute

##### 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 times series containing points

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id

#### (route) retrieveSummary(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/transactions/v2/summary

Retrieve transaction data

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
app_name | String | optional | filter transactions by app source
server_name | String | optional | filter transactions by server source

##### 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
--- | --- | ---
server_name | Object |
server_name.app_name | Object | transaction object

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id