EGYM Statistics API

openapi: 3.2.0
info:
  title: Equipment Vendor API (for standalone clients) Statistics API
  description: At EGYM, we believe that fitness is the soul of healthy living.
  termsOfService: https://egym.com/us/terms/
  contact:
    name: EGYM GmbH
    url: https://egym.com/
    email: support@egym.com
  license:
    name: Pending License
    url: https://egym.com/
  version: 1.2.0
servers:
- url: https://partner-api.ext-1.test.co.egym.coffee
  description: Test (ext-1)
- url: https://partner-api.api.egym.com
  description: Production
tags:
- name: Statistics
paths:
  /api/v1/users/activity-levels:
    get:
      tags:
      - Statistics
      summary: User Activity Level
      description: This endpoint will return activity level summary of the user.
      operationId: getUserActivityInformation
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityLevelResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
      security:
      - user: []
  /api/v1/points:
    get:
      tags:
      - Statistics
      summary: User Points
      description: This endpoint returns the EGYM activity points of the user.
      operationId: getWorkoutPoints
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkoutHistoryPointsDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDTO'
      security:
      - user: []
components:
  schemas:
    WorkoutPointsDTO:
      type: object
      properties:
        timestamp:
          type: integer
          format: int64
          description: The exercise timestamp
          example: 1552262400000
        exerciseType:
          type: string
          description: The exercise type
          enum:
          - ENDURANCE
          - STRENGTH
          - MOBILITY
          - SPORT
          - FITNESS_CLASS
          - EGYM_CIRCLE
          - EGYM_MACHINE
          - DAILY_ROUTINE
          - COORDINATION
        points:
          type: integer
          format: int64
          description: The total activity points
          example: 10
    ApiErrorResponseDTO:
      type: object
      description: Standard error response returned by the API for all error status codes.
      properties:
        timestamp:
          type: integer
          format: int64
          description: Unix epoch milliseconds when the error occurred.
          example: 1775122463109
        path:
          type: string
          description: The request path that triggered the error.
          example: /api/v1/measurements/body/history
        status:
          type: integer
          format: int32
          description: HTTP status code.
          example: 400
        error:
          type: string
          description: Short textual description of the HTTP status.
          example: Bad Request
        requestId:
          type: string
          description: Unique identifier for the request, useful for correlating logs and support tickets.
          example: d0c0fd9e-236
        message:
          type: string
          description: Human-readable description of the error.
          example: 'Invalid request parameters: value must be greater than or equal to 1 and less than or equal to 1000'
        fieldErrors:
          type: array
          description: List of field-level validation errors. Only present when the error was caused by request-body binding failures or custom form validation.
          items:
            $ref: '#/components/schemas/FieldErrorDTO'
        errorCode:
          type: string
          description: Machine-readable error code for domain-specific errors. Only present for exceptions that carry a custom error code.
          example: USER_NOT_FOUND
    FieldErrorDTO:
      type: object
      properties:
        name:
          type: string
          description: The field name.
        message:
          type: string
          description: The error message.
          example: Must not be null.
        rejectedValue:
          description: The rejected value.
          example: Must not be null.
    ActivityLevelResponseDTO:
      type: object
      properties:
        level:
          type: string
          description: User activity level (e.g. Bronze, Gold, etc.)
        points:
          type: integer
          format: int32
          description: User number of activity points
          example: 10
        goal:
          type: integer
          format: int32
          description: Number of points to achieve next activity level
          example: 999
        maintainPointsCount:
          type: integer
          format: int32
          description: Number of points to approve current activity level
          example: 400
        daysLeft:
          type: integer
          format: int32
          description: Number of days to earn 'goal' to achieve next activity level
          example: 27
    WorkoutHistoryPointsDTO:
      type: object
      properties:
        todaysPoints:
          type: array
          description: The activity points of the current day
          items:
            $ref: '#/components/schemas/WorkoutPointsDTO'
        pointsByDay:
          type: array
          description: The activity points summed daily and grouped by exercise type
          items:
            $ref: '#/components/schemas/WorkoutPointsDTO'
  securitySchemes:
    user:
      type: http
      scheme: bearer
      bearerFormat: JWT
    partner:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /api/v1/oauth/token
          scopes: {}
x-tagGroups:
- name: Authentication
  tags:
  - OAuth
- name: Partners Information
  tags:
  - Partners
- name: Measurements
  tags:
  - Body Measurement
  - Cardio Measurement
  - Flexibility Measurement
- name: User
  tags:
  - User
  - Image
  - Statistics
- name: Machine
  tags:
  - Machine
- name: Resource
  tags:
  - Resource
- name: Workouts
  tags:
  - Strength Workouts
  - Cardio Workouts
  - Open Exercise Workouts
- name: Cardio Test
  tags:
  - Cardio Test
- name: Logging
  tags:
  - Logging