GET
health/:engine/stats (Beta)
Gets recent queue-time percentile statistics (p50, p95) for the specified engine (AutoCAD, Revit, Inventor, Fusion, 3dsMax).
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/da/us-east/v3/health/:engine/stats |
| Authentication Context | app only |
| Required OAuth Scopes | code:all |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via OAuth |
* Required
Request
URI Parameters
| engine string | Engine name. Possible values: AutoCAD, Revit, Inventor, Fusion, 3dsMax |
Query parameters
prioritystring | (Beta) Optional. Which WorkItems are included in these statistics.- Supported values are
P3 (standard WorkItems), P1 (priorityWorkItems) and
All. The values are case-insensitive.- If you leave it out, it defaults to
P3, the standard queue.- Any other value is rejected with an error.
|
Response
HTTP Status Code Summary
| 200 OK | Successfully get the queue statistics. |
| 400 Bad Request | The priority value is not supported. |
| 401 Unauthorized | Missing or invalid access token. |
| 403 Forbidden | The access is forbidden. |
| 404 Not Found | Engine not found. |
| 500 Internal Server Error | Unknown error. |
Response
Body Structure (200)
| p50QueueTimeMs number | The p50 queue-wait time in milliseconds over the last 5 minutes. Returns -1 if no data is available in the window. |
| p95QueueTimeMs number | The p95 queue-wait time in milliseconds over the last 5 minutes. Returns -1 if no data is available in the window. |
Example
Successfully get the queue statistics.
Request
curl -v 'https://developer.api.autodesk.com/da/us-east/v3/health/AutoCAD/stats' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"p50QueueTimeMs": 60000.0,
"p95QueueTimeMs": 600000.0
}