traces - Documentation

# traces

### Methods

#### (async, route) getDurationAvg(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/traces/aggregation/duration

Retrieve aggregation stats on duration

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
start | String | optional | date
end | String | optional | date
serviceName | String | optional |
spanName | String | optional |
tags | Array | optional |

##### 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
--- | --- | ---
aggregation | Array |

##### Response Code:

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

##### Parameters:

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

#### (async, route) getHistogramByTag(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/traces/histogram/tag

Retrieve histogram for a specific tag

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
tag | String |  |
start | String | optional | date
end | String | optional | date
serviceName | String | optional |
spanName | String | optional |

##### 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
--- | --- | ---
aggregation | Array |

##### Response Code:

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

##### Parameters:

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

#### (async, route) getServices(:id)

##### Route:

Method | Path
--- | ---
GET | /api/bucket/:id/data/traces/services

Retrieve services from traces (local and remote endpoint)

##### 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
--- | --- | ---
services, | Object | spans names

##### Response Code:

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

##### Parameters:

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

#### (async, route) getTags(:id)

##### Route:

Method | Path
--- | ---
GET | /api/bucket/:id/data/traces/tags

Retrieve tags from traces

##### 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
--- | --- | ---
tags | Array |

##### Response Code:

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

##### Parameters:

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

#### (async, route) getTagsValue(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/traces/aggregation/tag

Retrieve aggregation values for a specific tag

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
tag | String |  |
start | String | optional | date
end | String | optional | date
serviceName | String | optional |
spanName | String | optional |

##### 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
--- | --- | ---
aggregation | Array |

##### Response Code:

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

##### Parameters:

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

#### (async, route) list(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/traces

Retrieve traces about a bucket

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
includeSpans | Boolean | optional | true |
serviceName | String | optional |  |
limit | String | optional |  | default: 10, max: 100
kind | String | optional |  |
minDuration | Number | optional |  |
start | String | optional |  | date
end | String | optional |  | date
tags | Array | optional |  | Query string array like [error=500, error, ...]
orderBy | String | optional |  | Default: newest, enum: oldest, newest, shortest, longest
spanName | String | optional |  |

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### 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) retrieve(:id, :trace)

##### Route:

Method | Path
--- | ---
GET | /api/bucket/:id/data/traces/:trace

Retrieve specific trace about a bucket

##### 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
:trace | String | trace id

##### Response Code:

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

##### Parameters:

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