Get Capture Opportunities Metrics
Returns the following metrics for the Capture Opportunities (Async) API –
PendingMessages– The approximate number of pending requests in the queue.MaxDelayInSeconds– The maximum delay (in seconds) for processing all requests in the queue.ProcessingRatePerMinute– Number of requests being processed per minute (for the previous 10 mins).
Note: You must pass the x-api-key in the header (see Async API).
API URL
URL
GET
https://{async-host}/opportunity/capture/metrics
Response
200 OK
Content-Type: application/json
{
"PendingMessages":1,
"MaxDelayInSeconds":0,
"ProcessingratePerMinute":24.8
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
