Broadcom Query API

Query metrics data

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

broadcom-query-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Broadcom Operations for Applications REST Alerts Query API
  description: The VMware Aria Operations for Applications REST API (formerly Tanzu Observability by Wavefront) enables programmatic interaction with the observability service. It supports querying metrics, managing dashboards, alerts, events, sources, user accounts, API tokens, and ingesting data directly. The API uses JSON payloads over HTTPS and supports both API token and session-based authentication.
  version: 2.0.0
  contact:
    name: Broadcom Developer Support
    url: https://developer.broadcom.com
  license:
    name: Proprietary
    url: https://www.broadcom.com/company/legal/licensing
servers:
- url: https://{instance}.wavefront.com/api/v2
  description: Operations for Applications instance
  variables:
    instance:
      default: example
      description: Your Operations for Applications instance name
security:
- bearerAuth: []
tags:
- name: Query
  description: Query metrics data
paths:
  /query:
    get:
      summary: Broadcom Execute a query
      description: Performs a query against the metrics data store and returns the results.
      operationId: queryMetrics
      tags:
      - Query
      parameters:
      - name: q
        in: query
        required: true
        description: The query expression
        schema:
          type: string
      - name: s
        in: query
        required: true
        description: Start time in epoch seconds or ms
        schema:
          type: string
      - name: e
        in: query
        description: End time in epoch seconds or ms
        schema:
          type: string
      - name: g
        in: query
        description: Granularity (s, m, h, d)
        schema:
          type: string
          enum:
          - s
          - m
          - h
          - d
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '401':
          description: Unauthorized
components:
  schemas:
    QueryResult:
      type: object
      properties:
        timeseries:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              data:
                type: array
                items:
                  type: array
                  items:
                    type: number
        query:
          type: string
        granularity:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication
externalDocs:
  description: Operations for Applications REST API Documentation
  url: https://developer.broadcom.com/xapis/operations-for-applications-rest-api/latest/