Treno API (1.0.0)

Download OpenAPI specification:Download

Welcome

Treno gives software engineering teams visibility into their operations, processes, and performance. Learn more about how Treno can help your engineering organization at www.treno.io. The Treno API provides enterprise customers with the ability to retrieve and manage the engineering intelligence data in their Workspace.

Authentication

All requests to the Treno API must be authenticated. A request is authenticated using HTTP Basic Authentication to provide an API key and secret. Contact your Treno representative for assistance obtaining API keys.

Workspaces

A Workspace is the top-level container for a Treno account. Workspaces contain all of an account’s integrations, configuration, and data. Within a Workspace, data may be organized into a hierarchy of Projects to report on specific subsets of the organization. Refer to the Projects section for details.

Projects

A Project is a container within a Treno Workspace that reports on a subset of the account’s data. Projects may be organized into a hierarchy so that data from sub-projects is rolled up into the project that contains them.

Monitors (Indexes)

A Monitor describes a derivative time series which is composed of a number of different Metrics, each of which has:

A set of Target values, based on organization-wide Ratings, and
Weights, which determine the relative impact a Metric has on the resulting index output.

The Metrics in a Monitor are evaluated over time according to their relationship to their respective targets and the result is weighted and normalized into a percentage-based score that describes how well the collective set of input Metrics have attained their targets.

Workspaces

List Workspaces For Self

Returns a list of all workspaces the calling user is a member of

Authorizations:

basic

Responses

Response samples

200

Content type

application/json

[{"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"features": [0
],
"flags": ["string"
],
"id": "string",
"locale": "string",
"name": "string",
"time_zone": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Projects

List Projects For Workspace

Returns a list of all projects the caller has access to for the specified workspace

Authorizations:

basic

path Parameters

workspace_id

required

string

Workspace ID

query Parameters

expand

string

Fields to expand, specify 'projects' to expand sub-projects

Responses

Response samples

200

Content type

application/json

[{"data": [{"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"locale": "string",
"name": "string",
"parent_id": "string",
"subordinate": [ ],
"time_zone": "string",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]

Indexes

List Indexes for Workspace

Returns a list of all Index Monitors the caller has access to for the specified workspace

Authorizations:

basic

path Parameters

workspace_id

required

string

Workspace ID

Responses

Response samples

200

Content type

application/json

[{"data": [{"active": true,
"categories": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"creator_id": "string",
"description": 0,
"id": "string",
"indicators": [{"created_at": "2019-08-24T14:15:22Z",
"ratings": [{"bounds": {"lower": {"Abs": { },
"BigFloat": "string",
"BigInt": "string",
"Coder": { },
"Encode": 0,
"Float": { },
"Float64": 0,
"Int": { },
"Int64": 0,
"IsInf": true,
"Log": { },
"Log10": { },
"Neg": { },
"Sign": { },
"Sqrt": { },
"String": null
},
"upper": {"Abs": { },
"BigFloat": "string",
"BigInt": "string",
"Coder": { },
"Encode": 0,
"Float": { },
"Float64": 0,
"Int": { },
"Int64": 0,
"IsInf": true,
"Log": { },
"Log10": { },
"Neg": { },
"Sign": { },
"Sqrt": { },
"String": null
}
},
"level": "string"
}
],
"target": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"description": 0,
"id": "string",
"managed": true,
"metric": {"Funcs": ["string"
],
"Title": "string"
},
"metric_id": true,
"name": "string",
"scale": "string",
"selector": "string",
"thresholds": [{"active": true,
"bounds": {"lower": null,
"upper": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": 0,
"function": "string",
"id": "string",
"key": "string",
"name": "string",
"period": 0,
"target_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"transforms": ["string"
],
"updated_at": "2019-08-24T14:15:22Z"
},
"target_id": true,
"updated_at": "2019-08-24T14:15:22Z",
"weight": 0
}
],
"name": "string",
"scale": "string",
"tags": ["string"
],
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"transforms": ["string"
],
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]

Fetch trend for Index Monitor in Workspace

Returns the trend for the Index Monitor for the requested period of time.

Authorizations:

basic

path Parameters

workspace_id required	string Workspace ID
monitor_id required	string Monitor ID

query Parameters

since	date-time Return series data since this date
until	date-time Return series data until this date
length	integer Return up to this many values, max 1000

Responses

Response samples

200

Content type

application/json

[{"data": {"count": 0,
"name": "string",
"time": "2019-08-24T14:15:22Z",
"trend": 0
},
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]

Fetch metric series data for Index Monitor in Workspace

Returns the metric series data, that is values for each timescale during the requested time frame. Metric data is available for timescales of day (1d), week (7d), and month (30d). When requesting metric series data for a period time there will be one value per timescale in the period. For example requesting a timescale of 1d for a period of 30 days will return 30 values, however requesting a timescale of 7d for the same period of 30 days will return just 4 values.

The Index Score is available as the sum value in each data value.

Authorizations:

basic

path Parameters

workspace_id required	string Workspace ID
monitor_id required	string Monitor ID
scale required	string The metric timescale rollup, either 1d, 7d, or 30d representing rollup by day, week, or month.

query Parameters

since	date-time Return series data since this date
until	date-time Return series data until this date
length	integer Return up to this many values, max 1000

Responses

Response samples

200

Content type

application/json

[{"data": [{"avg": 0,
"count": 0,
"max": 0,
"min": 0,
"name": "string",
"sum": 0,
"time": "2019-08-24T14:15:22Z"
}
],
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]

List Indexes for Project

Returns a list of all Index Monitors the caller has access to for the specified project

Authorizations:

basic

path Parameters

workspace_id required	string Workspace ID
project_id required	string Project ID

Responses

Response samples

200

Content type

application/json

[{"data": [{"active": true,
"categories": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"creator_id": "string",
"description": 0,
"id": "string",
"indicators": [{"created_at": "2019-08-24T14:15:22Z",
"ratings": [{"bounds": {"lower": {"Abs": { },
"BigFloat": "string",
"BigInt": "string",
"Coder": { },
"Encode": 0,
"Float": { },
"Float64": 0,
"Int": { },
"Int64": 0,
"IsInf": true,
"Log": { },
"Log10": { },
"Neg": { },
"Sign": { },
"Sqrt": { },
"String": null
},
"upper": {"Abs": { },
"BigFloat": "string",
"BigInt": "string",
"Coder": { },
"Encode": 0,
"Float": { },
"Float64": 0,
"Int": { },
"Int64": 0,
"IsInf": true,
"Log": { },
"Log10": { },
"Neg": { },
"Sign": { },
"Sqrt": { },
"String": null
}
},
"level": "string"
}
],
"target": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"description": 0,
"id": "string",
"managed": true,
"metric": {"Funcs": ["string"
],
"Title": "string"
},
"metric_id": true,
"name": "string",
"scale": "string",
"selector": "string",
"thresholds": [{"active": true,
"bounds": {"lower": null,
"upper": null
},
"created_at": "2019-08-24T14:15:22Z",
"description": 0,
"function": "string",
"id": "string",
"key": "string",
"name": "string",
"period": 0,
"target_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"transforms": ["string"
],
"updated_at": "2019-08-24T14:15:22Z"
},
"target_id": true,
"updated_at": "2019-08-24T14:15:22Z",
"weight": 0
}
],
"name": "string",
"scale": "string",
"tags": ["string"
],
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"transforms": ["string"
],
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]

Fetch trend for Index Monitor in Project

Returns the trend for the Index Monitor for the requested period of time.

Authorizations:

basic

path Parameters

workspace_id required	string Workspace ID
project_id required	string Project ID
monitor_id required	string Monitor ID
rating required	string The rating (elite, high, medium, low) for which to target as reaching a score of 100%. The Treno UI always uses "elite"

query Parameters

since	date-time Return series data since this date
until	date-time Return series data until this date
length	integer Return up to this many values, max 1000

Responses

Response samples

200

Content type

application/json

[{"data": {"count": 0,
"name": "string",
"time": "2019-08-24T14:15:22Z",
"trend": 0
},
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]

Fetch metric series data for Index Monitor in Project

Returns the metric series data, that is values for each timescale during the requested time frame. Metric data is available for timescales of day (1d), week (7d), and month (30d). When requesting metric series data for a period time there will be one value per timescale in the period. For example requesting a timescale of 1d for a period of 30 days will return 30 values, however requesting a timescale of 7d for the same period of 30 days will return just 4 values.

The Index Score is available as the sum value in each data value.

Authorizations:

basic

path Parameters

workspace_id required	string Workspace ID
project_id required	string Project ID
monitor_id required	string Monitor ID
rating required	string The rating (elite, high, medium, low) for which to target as reaching a score of 100%. The Treno UI always uses "elite"
scale required	string The metric timescale rollup, either 1d, 7d, or 30d representing rollup by day, week, or month.

query Parameters

since	date-time Return series data since this date
until	date-time Return series data until this date
length	integer Return up to this many values, max 1000

Responses

Response samples

200

Content type

application/json

[{"data": [{"avg": 0,
"count": 0,
"max": 0,
"min": 0,
"name": "string",
"sum": 0,
"time": "2019-08-24T14:15:22Z"
}
],
"meta": {"page": {"cursor": "string",
"length": 0,
"next": "string",
"offset": 0,
"prev": "string"
},
"timeframe": {"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"total": 0
}
}
]