API
Authorization
Obtaining a token
- Log into the Scout APM website
- Go to your organization’s settings page
- Enter a name (for your use), and obtain a token
Sending Authorization
The key must be provided with every request, via one of several methods:
- An HTTP Header named
X-SCOUT-API - A URL query string argument named
key*
*Note this isn’t documented in OpenAPI spec below for simplicity, but is possible.
OpenAPI Spec
Time Steps
When using different durations, we will return different time steps.
In the example above, when looking at a 1 week duration (from=2021-03-20T22:00:00Z, to=2021-03-27T21:00:00Z), we return data in an hourly timestep
Here’s a list of our various durations and timesteps. Once a duration has exceeded a specific time duration, say 90 minutes, we will use the next largest available time duration (3 hours):
| Time | Step | Example |
|---|---|---|
| 30 min | 1 minute | from=2021-06-14T01:00:00Z&to=2021-06-14T01:30:00Z |
| 60 min | 1 minute | from=2021-06-14T02:00:00Z&to=2021-06-14T03:00:00Z |
| 3 hrs | 2 minutes | from=2021-06-14T03:00:00Z&to=2021-06-14T06:00:00Z |
| 6 hrs | 5 minutes | from=2021-06-14T07:00:00Z&to=2021-06-14T13:00:00Z |
| 12 hrs | 5 minutes | from=2021-06-14T14:00:00Z&to=2021-06-15T02:00:00Z |
| 1 day | 10 minutes | from=2021-06-15T03:00:00Z&to=2021-06-16T03:00:00Z |
| 3 days | 30 minutes | from=2021-06-16T04:00:00Z&to=2021-06-19T04:00:00Z |
| 7 days | 1 hour | from=2021-06-19T05:00:00Z&to=2021-06-26T05:00:00Z |
| 14 days | 2 hours | from=2021-06-26T06:00:00Z&to=2021-07-10T06:00:00Z |