Get route statistics

Returns aggregated API request statistics per endpoint category and date for a given customer and instance. Statistics cover key endpoint groups such as Search, Recommendation, Page Editor, and Feeds.

Request

GET /statistics/routes

Headers

HeaderValue
AuthorizationBearer <token>

Query Parameters

ParameterTypeRequiredDescription
customerstringYesCustomer identifier to retrieve statistics for.
instancestringNoInstance identifier to filter results. When omitted, statistics across all instances for the customer are returned.
startDatestringYesStart date for the statistics period. Accepts any date format parseable by PHP (e.g. 2026-01-01).
endDatestringYesEnd date for the statistics period. Accepts any date format parseable by PHP (e.g. 2026-01-31).

Example Request

GET /statistics/routes?customer=my-customer&instance=my-instance&startDate=2026-01-01&endDate=2026-01-31

Response

Returns a JSON object keyed by date, then by endpoint category. Each entry reports the total number of requests and bytes transferred for that category on that date.

Endpoint Categories

CategoryEndpoints included
Search/search, /search/public
Recommendation/recommendation, /recommendation/public
Page Editor/documents/public, /enterprise/menu, /enterprise/page
Feeds/feeds

Response Fields (per date and category)

FieldTypeDescription
requestsintegerTotal number of API requests in this period.
bytesintegerTotal bytes of response body sent.

Example Response

{
  "2026-01-15": {
    "Search": {
      "requests": 4821,
      "bytes": 15234560
    },
    "Recommendation": {
      "requests": 1203,
      "bytes": 3847200
    }
  },
  "2026-01-16": {
    "Search": {
      "requests": 5100,
      "bytes": 16102400
    },
    "Page Editor": {
      "requests": 340,
      "bytes": 890000
    }
  }
}