The following is the specification for the API that can retrieve and reset statistics.
For more information about statistics, see: Statistics and Ceptor Statistics Server
--- openapi: "3.0.0" info: version: "1.0.1" title: "Ceptor Statistics API" paths: /remote/{servername}: get: summary: "Get remote summary" description: "Returns the remote summary for the specified server" tags: - "statistics" parameters: - name: "servername" in: "path" description: "Server name" required: true schema: type: "string" responses: 200: description: "OK" content: application/json: schema: $ref: "#/components/schemas/Statistics" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /servers: get: summary: "Get list of available servers" description: "Returns List of servers statistics are stored for" tags: - "statistics" responses: 200: description: "OK" content: application/json: schema: description: "List of server names" type: "array" items: description: "Server name" type: "string" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /servers/{pattern}: get: summary: "Get list of available servers matching pattern" description: "Returns List of servers statistics are stored for, the servers\ \ must match the specified pattern" tags: - "statistics" parameters: - name: "pattern" in: "path" description: "Pattern server names must match" required: true schema: type: "string" responses: 200: description: "OK" content: application/json: schema: description: "List of server names" type: "array" items: description: "Server name" type: "string" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /functions: get: summary: "Get list of available functions" description: "Returns List of functions statistics are stored for" tags: - "statistics" parameters: - name: "servername" in: "query" description: "Server name" required: true schema: type: "array" items: type: "string" responses: 200: description: "OK" content: application/json: schema: description: "List of server names" type: "array" items: description: "Server name" type: "string" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /functions/{pattern}: get: summary: "Get list of available functions matching pattern" description: "Returns List of servers statistics are stored for, the servers\ \ must match the specified pattern" tags: - "statistics" parameters: - name: "servername" in: "query" description: "Server name" required: true schema: type: "array" items: type: "string" - name: "pattern" in: "path" description: "Pattern server names must match" required: true schema: type: "string" responses: 200: description: "OK" content: application/json: schema: description: "List of server names" type: "array" items: description: "Server name" type: "string" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /summary: get: summary: "Get statistics summary" description: "Returns the summary for the specified servers and functions in\ \ the given interval" tags: - "statistics" parameters: - name: "servername" in: "query" description: "Server name" required: true schema: type: "array" items: type: "string" - name: "function" in: "query" description: "Function name" required: true schema: type: "array" items: type: "string" - name: "start" in: "query" description: "Start time in milliseconds since 1/1 1970" required: true schema: type: "number" format: "long" - name: "end" in: "query" description: "Start time in milliseconds since 1/1 1970" required: true schema: type: "number" format: "long" responses: 200: description: "OK" content: application/json: schema: $ref: "#/components/schemas/Statistics" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /details: get: summary: "Get statistics details" description: "Returns the detailed statistics for the specified servers and\ \ functions in the given interval" tags: - "statistics" parameters: - name: "servername" in: "query" description: "Server name" required: true schema: type: "array" items: type: "string" - name: "function" in: "query" description: "Function name" required: true schema: type: "array" items: type: "string" - name: "start" in: "query" description: "Start time in milliseconds since 1/1 1970" required: true schema: type: "number" format: "long" - name: "end" in: "query" description: "Start time in milliseconds since 1/1 1970" required: true schema: type: "number" format: "long" responses: 200: description: "OK" content: application/json: schema: $ref: "#/components/schemas/Statistics" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" /reset: delete: summary: "Delete statistics" description: "Deletes statistics entries for the specified servers/functions" tags: - "statistics" parameters: - name: "servername" in: "query" description: "Server name" required: true schema: type: "array" items: type: "string" - name: "function" in: "query" description: "Function name" required: true schema: type: "array" items: type: "string" responses: 204: description: "OK" default: description: "unexpected error" content: application/json: schema: $ref: "#/components/schemas/Error" components: schemas: Statistics: type: "object" description: "Statistics data" Error: required: - "code" - "message" properties: code: type: "integer" format: "int32" message: type: "string" securitySchemes: client_id_secret: type: "http" scheme: "basic" description: "Basic authentication using client_id and client_secret from API\ \ Partner Application" security: - client_id_secret: [] servers: - url: "https://127.0.0.1:9443/statistics/v1" description: "Internal APIs are exposed here, such as APIs for Administration" |