Phasio Metrics Controller API

Endpoints for tracking system metrics and events

OpenAPI Specification

phasio-metrics-controller-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Phasio Activity Internal Metrics Controller API
  description: This is the API documentation for the Phasio application.
  version: '1.0'
servers:
- url: https://m-api.eu.phas.io
  description: Generated server url
security:
- Phasio API Bearer Token: []
tags:
- name: Metrics Controller
  description: Endpoints for tracking system metrics and events
paths:
  /api/internal/v1/metrics:
    put:
      tags:
      - Metrics Controller
      summary: Register metric event
      description: Records the occurrence of a specific metric event for analytics purposes
      operationId: registerEvent
      parameters:
      - name: event
        in: query
        description: Type of metric event to register
        required: true
        schema:
          type: string
          enum:
          - CUSTOMER_LOGIN
          - CUSTOMER_SIGNUP
          - WEBSITE_VISIT
          - QUOTE_GENERATION
          - ORDER_CREATION
          - CART_CREATION
      responses:
        '204':
          description: Event successfully registered
        '400':
          description: Invalid operator context or event type
        '401':
          description: Unauthorized - missing or invalid authentication
components:
  securitySchemes:
    Phasio API Bearer Token:
      type: http
      name: Authorization
      in: header
      scheme: bearer
      bearerFormat: JWT