Gravitee

Gravitee Analytics API

Query analytics, time-series, and dashboards

Documentation GitHub OpenAPI

Documentation

https://documentation.gravitee.io/apim

https://documentation.gravitee.io/apim/getting-started

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/rate-limits/gravitee-rate-limits.yml

https://documentation.gravitee.io/am

Specifications

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/openapi/gravitee-analytics-api-openapi.yml

SDKs

GitHubRepository

https://github.com/gravitee-io/gravitee-api-management

GitHubRepository

https://github.com/gravitee-io/gravitee-access-management

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-api-schema.json

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-plan-schema.json

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-domain-schema.json

Other Resources

https://documentation.gravitee.io/apim/release-information/changelog

https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt

https://github.com/gravitee-io/gravitee-clients-sdk

https://github.com/gravitee-io/terraform-provider-apim

https://github.com/gravitee-io/graviteeio-cli

KubernetesOperator

https://github.com/gravitee-io/gravitee-kubernetes-operator

https://github.com/gravitee-io/helm-charts

https://hub.docker.com/r/graviteeio/apim-gateway

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

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apidefinitions.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiv4definitions.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiresources.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_applications.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_subscriptions.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_managementcontexts.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_sharedpolicygroups.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_groups.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_notifications.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/plans/gravitee-plans-pricing.yml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/finops/gravitee-finops.yml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/api-gateway-operations.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/traffic-observability.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/graphql/gravitee-graphql.md

https://documentation.gravitee.io/am/reference/am-api-reference

https://documentation.gravitee.io/am/releases-and-changelog/release-notes

https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE

https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java

https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am

https://hub.docker.com/r/graviteeio/am-gateway

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/access-management.yaml

OpenAPI Specification

openapi: 3.0.1
info:
  title: Gravitee.io - Access Management alerts Analytics API
  version: 4.12.0-alpha.3
  description: Query analytics, time-series, and dashboards
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: Analytics
  description: Query analytics, time-series, and dashboards
paths:
  /environments/{envId}/analytics/definition/apis:
    get:
      tags:
      - Analytics
      operationId: queryApiSpecs
      summary: Query API Analytics Specifications
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: API analytics specs
  /environments/{envId}/analytics/measures:
    post:
      tags:
      - Analytics
      operationId: queryMeasures
      summary: Query Analytics Measures
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Measures result
  /environments/{envId}/analytics/facets:
    post:
      tags:
      - Analytics
      operationId: queryFacets
      summary: Query Analytics Facets
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Facets result
  /environments/{envId}/analytics/time-series:
    post:
      tags:
      - Analytics
      operationId: queryTimeSeries
      summary: Query Analytics Time Series
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Time series result
  /environments/{envId}/analytics/dashboards:
    get:
      tags:
      - Analytics
      operationId: listDashboards
      summary: List Analytics Dashboards
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Dashboards page
    post:
      tags:
      - Analytics
      operationId: createDashboard
      summary: Create an Analytics Dashboard
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '201':
          description: Dashboard created
  /environments/{envId}/analytics/dashboards/{dashboardId}:
    get:
      tags:
      - Analytics
      operationId: getDashboard
      summary: Get an Analytics Dashboard
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: dashboardId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The dashboard
    put:
      tags:
      - Analytics
      operationId: updateDashboard
      summary: Update an Analytics Dashboard
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: dashboardId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Dashboard updated
    delete:
      tags:
      - Analytics
      operationId: deleteDashboard
      summary: Delete an Analytics Dashboard
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: dashboardId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Dashboard deleted
components:
  parameters:
    EnvId:
      in: path
      name: envId
      required: true
      schema:
        type: string
      description: The environment identifier
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer