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/okareo:okareo-usage-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

openapi: 3.2.0
info:
  title: Okareo Usage API
  version: 0.1.0
  description: Retrieve account usage metrics.
servers:
- url: https://api.okareo.com
tags:
- name: Usage
  description: Retrieve account usage metrics.
paths:
  /v0/usage/metrics:
    get:
      tags:
      - Usage
      summary: Get usage metrics
      description: 'Get usage metrics for the authenticated organization.


        **Authentication:** Requires valid API key in ''api-key'' header.

        The organization is automatically deduced from the API key via VerifyTokenMiddleware.


        **Date Range Defaults:**

        - If `start_date` is not provided, defaults to 30 days ago

        - If `end_date` is not provided, defaults to current time (with buffer applied)


        **Data Completeness:** Metrics include only completed sessions, test runs,

        and datapoints. A configurable time buffer may be applied to ensure data completeness.


        **Metrics Included:**

        - **voice_minutes**: Sum of audio/voice minutes from completed sessions

        - **simulations**: Count of completed test runs (all types: voice and non-voice)

        - **datapoints**: Count of non-error datapoints

        - **checks**: Total check executions from test runs and monitors


        **Example Usage:**

        ```

        # Last 30 days (default)

        GET /v0/usage/metrics


        # Specific date range

        GET /v0/usage/metrics?start_date=2026-01-01T00:00:00Z&end_date=2026-01-31T23:59:59Z


        # Custom start, default end

        GET /v0/usage/metrics?start_date=2026-01-01T00:00:00Z

        ```'
      operationId: get_usage_metrics_v0_usage_metrics_get
      parameters:
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Start date for metrics period (ISO 8601 or YYYY-MM-DD). Defaults to 30 days ago if not provided.
          title: Start Date
        description: Start date for metrics period (ISO 8601 or YYYY-MM-DD). Defaults to 30 days ago if not provided.
        example: '2024-01-01'
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: End date for metrics period (will be capped based on buffer). Defaults to current time with buffer applied.
          title: End Date
        description: End date for metrics period (will be capped based on buffer). Defaults to current time with buffer applied.
        example: '2024-01-31'
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Optional project filter - only include metrics for this project
          title: Project Id
        description: Optional project filter - only include metrics for this project
      - name: precision
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/UsagePrecision'
          description: 'Time period precision: MINUTE (max 180 min), HOUR (max 168 hrs), DAY (max 90 days), MONTH (max 3 months)'
          default: day
        description: 'Time period precision: MINUTE (max 180 min), HOUR (max 168 hrs), DAY (max 90 days), MONTH (max 3 months)'
      - name: timezone
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: IANA timezone name for period grouping (e.g. America/Los_Angeles). Defaults to America/Los_Angeles.
          title: Timezone
        description: IANA timezone name for period grouping (e.g. America/Los_Angeles). Defaults to America/Los_Angeles.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageMetricsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MetricDetail:
      properties:
        period_start:
          type: string
          format: date-time
          title: Period Start
          description: Start of this time period
        period_end:
          type: string
          format: date-time
          title: Period End
          description: End of this time period
        voice_minutes:
          type: number
          title: Voice Minutes
          description: Voice minutes for this period
        simulations:
          type: integer
          title: Simulations
          description: Simulations for this period
        datapoints:
          type: integer
          title: Datapoints
          description: Datapoints for this period
        checks:
          type: integer
          title: Checks
          description: Checks for this period
      type: object
      required:
      - period_start
      - period_end
      - voice_minutes
      - simulations
      - datapoints
      - checks
      title: MetricDetail
      description: Metrics for a specific time period.
    UsageMetricsPeriod:
      properties:
        start_date:
          type: string
          format: date-time
          title: Start Date
        end_date:
          type: string
          format: date-time
          title: End Date
      type: object
      required:
      - start_date
      - end_date
      title: UsageMetricsPeriod
      description: Period information for metrics response.
    UsageMetricsResponse:
      properties:
        organization_id:
          type: string
          format: uuid
          title: Organization Id
        period:
          $ref: '#/components/schemas/UsageMetricsPeriod'
        totals:
          $ref: '#/components/schemas/Metrics'
        details:
          items:
            $ref: '#/components/schemas/MetricDetail'
          type: array
          title: Details
          description: Breakdown of metrics by time period based on precision
      type: object
      required:
      - organization_id
      - period
      - totals
      - details
      title: UsageMetricsResponse
      description: Complete response for usage metrics request.
      example:
        details:
        - checks: 180
          datapoints: 420
          period_end: '2026-01-01T23:59:59Z'
          period_start: '2026-01-01T00:00:00Z'
          simulations: 15
          voice_minutes: 42.5
        - checks: 165
          datapoints: 380
          period_end: '2026-01-02T23:59:59Z'
          period_start: '2026-01-02T00:00:00Z'
          simulations: 12
          voice_minutes: 38.2
        organization_id: 123e4567-e89b-12d3-a456-426614174000
        period:
          end_date: '2026-01-31T11:59:59Z'
          start_date: '2026-01-01T00:00:00Z'
        totals:
          checks: 5600
          datapoints: 12500
          simulations: 450
          voice_minutes: 1234.56
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UsagePrecision:
      type: string
      enum:
      - minute
      - hour
      - day
      - month
      title: UsagePrecision
      description: Time period precision for usage metrics.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Metrics:
      properties:
        voice_minutes:
          type: number
          title: Voice Minutes
          description: Total voice/audio minutes captured (completed sessions only)
        simulations:
          type: integer
          title: Simulations
          description: 'Count of completed test runs (all types: voice and non-voice)'
        datapoints:
          type: integer
          title: Datapoints
          description: Count of non-error datapoints (completed only)
        checks:
          type: integer
          title: Checks
          description: Total check executions (from completed test runs and monitors)
      type: object
      required:
      - voice_minutes
      - simulations
      - datapoints
      - checks
      title: Metrics
      description: Individual usage metrics.