Wger User Statistics API

openapi: 3.2.0
info:
  title: wger User Statistics API
  version: 2.7.0a2
  description: Self hosted FLOSS workout and fitness tracker.
  license:
    name: AGPL-3.0-or-later
    url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: /
  description: This server
- url: https://wger.de
  description: The "official" upstream wger instance
tags:
- name: user-statistics
paths:
  /api/v2/user-statistics/:
    get:
      operationId: user_statistics_list
      description: 'API endpoint for user''s trophy statistics.


        Returns the current user''s trophy-related statistics.


        list:

        Return the current user''s statistics


        retrieve:

        Return statistics by ID'
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      tags:
      - user-statistics
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUserStatisticsList'
          description: ''
      summary: User statistics list
      x-summary-source: derived
  /api/v2/user-statistics/{id}/:
    get:
      operationId: user_statistics_retrieve
      description: 'API endpoint for user''s trophy statistics.


        Returns the current user''s trophy-related statistics.


        list:

        Return the current user''s statistics


        retrieve:

        Return statistics by ID'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this User statistics.
        required: true
      tags:
      - user-statistics
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserStatistics'
          description: ''
      summary: User statistics retrieve
      x-summary-source: derived
components:
  schemas:
    UserStatistics:
      type: object
      description: 'Serializer for UserStatistics model.


        Shows user''s trophy-related statistics.'
      properties:
        id:
          type: integer
          readOnly: true
        total_weight_lifted:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          readOnly: true
          description: Cumulative weight lifted in kg
        total_workouts:
          type: integer
          readOnly: true
          description: Total number of workout sessions completed
        current_streak:
          type: integer
          readOnly: true
          description: Current consecutive days with workouts
        longest_streak:
          type: integer
          readOnly: true
          description: Longest consecutive days with workouts
        last_workout_date:
          type:
          - string
          - 'null'
          format: date
          readOnly: true
          description: Date of the most recent workout
        earliest_workout_time:
          type:
          - string
          - 'null'
          format: time
          readOnly: true
          description: Earliest time a workout was started
        latest_workout_time:
          type:
          - string
          - 'null'
          format: time
          readOnly: true
          description: Latest time a workout was started
        weekend_workout_streak:
          type: integer
          readOnly: true
          description: Consecutive weekends with workouts on both Saturday and Sunday
        last_complete_weekend_date:
          type:
          - string
          - 'null'
          format: date
          readOnly: true
          description: Date of the last Saturday where both Sat and Sun had workouts
        worked_out_jan_1:
          type: boolean
          readOnly: true
          title: Worked out on January 1st
          description: Whether user has ever worked out on January 1st
        last_updated:
          type: string
          format: date-time
          readOnly: true
      required:
      - current_streak
      - earliest_workout_time
      - id
      - last_complete_weekend_date
      - last_updated
      - last_workout_date
      - latest_workout_time
      - longest_streak
      - total_weight_lifted
      - total_workouts
      - weekend_workout_streak
      - worked_out_jan_1
    PaginatedUserStatisticsList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/UserStatistics'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    headlessJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by the allauth headless endpoints
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oidcAuth:
      type: oauth2
      description: Access token issued by the OAuth2/OIDC provider
      flows:
        authorizationCode:
          authorizationUrl: https://wger.de/identity/o/authorize
          tokenUrl: https://wger.de/identity/o/api/token
          scopes:
            api:read: View your training, nutrition and body data
            api:write: Add and change your training, nutrition and body data
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
externalDocs:
  url: https://wger.readthedocs.io
  description: wger documentation