/v1/api/statistics/servicePointMetrics (GET) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide

Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x
Returns a list of service point metrics for every service point which has DNS queries over the last 24 hours. Service point metrics include the average QPS (queries per second) and the max hourly QPS for the service point (both over the last 24 hours). An empty list is returned if there are no service points or if there have been no queries in the last 24 hours for any service point.
GET https://api-<BlueCat.edge.url>/v1/api/statistics/servicePointMetrics
Authorization: Bearer authorization token

Successful response

200 OK
Content-type: application/JSON

Cache-Control: no-cache
Last-Modified: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
[
    {
      "servicePointId": "11af7981-97e7-470e-ac70-19a56f01bd29",
      "averageQps": 8254.55,
      "maxHourlyQps": 10057
    },
    {
      "servicePointId": "80d56221-09cd-4e6a-a0a8-cbd7edf30710",
      "averageQps": 0.0002546296296296296,
      "maxHourlyQps": 0.003611111111111111
    }
]
Returns the following information:
  • Cache-Control: The instructions for caching the response. The value of no-cache means the response may be stored by any cache.
  • Last-Modified: The date and time the service point metrics were calculated. If the service point metrics are null, the date and time the response was created.
  • servicePointId: The ID of the service point.
  • averageQps: The average QPS of the service point over the last 24 hours.
  • maxHourlyQps: The maximum hourly QPS of the service point over the last 24 hours.

Response on unsuccessful authorization

401 Unauthorized
Content-Type: application/JSON
{"code": "UNAUTHORIZED", "brief": "You are not authorized to perform this action"}
Possible error codes
  • UNAUTHORIZED
  • INTERNAL_SERVER_ERROR