Set response-time bands
Decide what fast, slow and too slow mean for a project or one request.
In short
Response-time bands decide what fast, slow and too slow mean, as green, yellow and red. A project starts with none: a request that answered is green and one that failed is red, however long either took. Add bands to see slow answers at a glance.
Before you start
- Who: changing a project's bands or a request's own bands needs Edit on the project.
- Plan: every plan.
- Defaults: a project starts with none.
Define response-time bands
- On the project board, open "Project settings", choose "Runs" and press "Add time bands". You start with three you can change: fast up to 1,000 ms (green), slow up to 3,000 ms (yellow) and too slow beyond (red).
- Change each band's label, upper limit in milliseconds and color. Leave the last limit empty to catch everything slower.
- Press "Save bands".
Result: each request takes the first band whose limit covers its time. A failed request is red, whatever the bands say; with no bands, an answered request is green.
Good to know
- A band needs a label and a limit above zero, two bands cannot share a limit, and only the slowest can have none. Order does not matter; bands are sorted.
- Example for instant read endpoints: fast up to 200 ms, ok up to 500 ms, slow up to 2,000 ms and too slow beyond.
- Give a request its own bands for an endpoint that is legitimately different, such as an export that takes eight seconds by design. Its bands replace the project's completely; they are never mixed.
If something goes wrong
- "Too many thresholds.": keep fewer bands.
- Two bands with the same limit are refused: give each a different limit.
- A slow request stays green: the project has no bands. In "Project settings" › "Runs", press "Add time bands".
Related
- /help/api-testing/project-runs-thresholds
- /help/api-testing/compare-runs