APIIDA

APIIDA Monitoring API

Metrics and monitoring operations

GitHub OpenAPI

Operations 1

GET /gateways/{gatewayId}/metrics APIIDA Get Gateway Metrics #

Documentation

📖
Documentation
https://apiida.com/product/apiida-api-control-plane/
📖
Documentation
https://apiida.com/product/apiida-api-gateway-manager/
📖
Documentation
https://apiida.atlassian.net/wiki/spaces/AAGM

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/openapi/apiida-monitoring-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-api.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-deployment.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-gateway.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-ld/apiida-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apiida-monitoring-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apiida-monitoring-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIIDA API Control Plane Alarms Monitoring API
  description: REST API for the APIIDA API Control Plane, enabling programmatic management of APIs across multiple API gateways. Supports validation of proxy specifications, API version management, and deployment to gateways.
  version: '1.0'
  contact:
    name: APIIDA Support
    url: https://www.apiida.com
servers:
- url: https://{tenant}.backend.apiida.io
  description: APIIDA Backend
  variables:
    tenant:
      description: Your APIIDA tenant identifier
      default: example
security:
- bearerAuth: []
tags:
- name: Monitoring
  description: Metrics and monitoring operations
paths:
  /gateways/{gatewayId}/metrics:
    get:
      operationId: getGatewayMetrics
      summary: APIIDA Get Gateway Metrics
      description: Retrieve performance and usage metrics for a specific gateway. Requires the APIIDA solution kit installed on the gateway.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      - name: from
        in: query
        schema:
          type: string
          format: date-time
        description: Start of the time range
      - name: to
        in: query
        schema:
          type: string
          format: date-time
        description: End of the time range
      responses:
        '200':
          description: Gateway metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metrics'
        '401':
          description: Unauthorized
        '404':
          description: Gateway not found
components:
  schemas:
    Metrics:
      type: object
      properties:
        gatewayId:
          type: string
        period:
          type: object
          properties:
            from:
              type: string
              format: date-time
            to:
              type: string
              format: date-time
        requestCount:
          type: integer
          description: Total API requests in the period
        errorCount:
          type: integer
          description: Total error responses in the period
        averageLatency:
          type: number
          format: double
          description: Average response latency in milliseconds
        throughput:
          type: number
          format: double
          description: Requests per second
  parameters:
    gatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        type: string
      description: The gateway identifier
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
externalDocs:
  description: APIIDA Documentation
  url: https://apiida.atlassian.net