Standard Metrics O API

The O API from Standard Metrics — 1 operation(s) for o.

OpenAPI Specification

standard-metrics-o-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: OAuth Token budgets O API
  version: 1.0.0
  description: Token endpoint using client credentials flow.
servers:
- url: https://api.standardmetrics.io
tags:
- name: O
paths:
  /o/token/:
    post:
      summary: Get API Access Token
      description: "This endpoint allows you to retrieve an API access token using your `client_id` and `client_secret`.\n\nTo authenticate:\n\n- Click `Try it ▶`\n- Enter your **client_id** as the `Authorization.username`\n- Enter your **client_secret** as the `Authorization.password`\n\nThe request must include the following body parameter:\n\n- `grant_type`: This is always set to `client_credentials`\n\nHit `Send ▶` and the response will contain an `access_token`, which you can use as a Bearer token to authenticate requests to other endpoints.\n\n```json\n{\n  \"access_token\": \"ACCESS_TOKEN\",\n  \"expires_in\": 3600,\n  \"token_type\": \"Bearer\",\n  \"scope\": \"read write\"\n}\n```"
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                grant_type:
                  type: string
                  enum:
                  - client_credentials
                  default: client_credentials
                  description: Always set to 'client_credentials'
              required:
              - grant_type
      parameters: []
      security:
      - basicAuth: []
      responses:
        '200':
          description: Access token retrieved successfully
          content:
            application/json:
              example:
                access_token: ACCESS_TOKEN
                expires_in: 3600
                token_type: Bearer
                scope: all read write
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                  expires_in:
                    type: integer
                  token_type:
                    type: string
                  scope:
                    type: string
                required:
                - access_token
                - expires_in
                - token_type
      tags:
      - O
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic