> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fexmetrics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Peak Hours

> Returns UTC peak-hour profiles for `7d`, `30d`, `90d`, or `1y`. Available on all standard plans.



## OpenAPI

````yaml /rapidapi-v1.yaml get /rapid/v1/servers/{identifier}/peak-hours
openapi: 3.0.2
info:
  title: Fexmetrics RapidAPI
  version: 1.0.0
  description: |
    Customer-facing RapidAPI v1 contract.

    Raw history returns recorded time-series observations and is restricted by
    plan depth. Stats, growth, peak-hours, integrity, and compare return derived
    calculations; access to a derived range does not grant raw observations for
    that range.

    `by=id` is the default wherever `by` is available. Use `by=cfxId` when the
    identifier is a CFX network ID.

    RapidAPI handles authentication, request limits, quotas, and billing.
  contact:
    name: Fexmetrics
servers:
  - url: https://fexmetrics-fivem-redm-server-analytics-api3.p.rapidapi.com
    description: RapidAPI gateway
security:
  - RapidApiKey: []
tags:
  - name: Servers
    description: Public server discovery and current state.
  - name: Raw History
    description: Recorded observations with plan-specific download depth.
  - name: Analytics
    description: Derived summaries calculated from bounded observation windows.
  - name: Integrity
    description: Explainable heuristic analysis; never proof or a calibrated probability.
  - name: Comparison
    description: Set-based comparison of two to five public servers.
paths:
  /rapid/v1/servers/{identifier}/peak-hours:
    get:
      tags:
        - Analytics
      summary: Peak Hours
      description: >-
        Returns UTC peak-hour profiles for `7d`, `30d`, `90d`, or `1y`.
        Available on all standard plans.
      operationId: getRapidServerPeakHours
      parameters:
        - $ref: '#/components/parameters/Identifier'
        - $ref: '#/components/parameters/By'
        - $ref: '#/components/parameters/PeakRange'
      responses:
        '200':
          description: UTC peak-hour profiles.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeakHoursResult'
              examples:
                success:
                  value:
                    serverId: public-fivem
                    range: 30d
                    timezone: UTC
                    topHours:
                      - dayOfWeek: 6
                        hour: 21
                        averagePlayers: 78.4
                        medianPlayers: 79
                        sampleCount: 5
                      - dayOfWeek: 0
                        hour: 20
                        averagePlayers: 74.1
                        medianPlayers: 75
                        sampleCount: 4
                    hourlyProfile:
                      - hour: 20
                        averagePlayers: 70.2
                        medianPlayers: 71
                        sampleCount: 30
                      - hour: 21
                        averagePlayers: 73.8
                        medianPlayers: 74
                        sampleCount: 30
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/ServerNotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Identifier:
      name: identifier
      in: path
      required: true
      description: >-
        Canonical Fexmetrics ID by default, or CFX ID when `by=cfxId` is
        supported and supplied.
      schema:
        type: string
        minLength: 1
        maxLength: 128
        pattern: ^[A-Za-z0-9-]+$
    By:
      name: by
      in: query
      description: >-
        Explicit identifier namespace. Defaults to canonical Fexmetrics ID;
        never inferred.
      schema:
        type: string
        enum:
          - id
          - cfxId
        default: id
    PeakRange:
      name: range
      in: query
      description: Derived UTC peak-hours window.
      schema:
        type: string
        enum:
          - 7d
          - 30d
          - 90d
          - 1y
        default: 30d
  schemas:
    PeakHoursResult:
      type: object
      additionalProperties: false
      required:
        - serverId
        - range
        - timezone
        - topHours
        - hourlyProfile
      properties:
        serverId:
          type: string
        range:
          type: string
          enum:
            - 7d
            - 30d
            - 90d
            - 1y
        timezone:
          type: string
          enum:
            - UTC
        topHours:
          type: array
          items:
            $ref: '#/components/schemas/PeakHour'
        hourlyProfile:
          type: array
          items:
            $ref: '#/components/schemas/HourlyProfilePoint'
    PeakHour:
      type: object
      additionalProperties: false
      required:
        - dayOfWeek
        - hour
        - averagePlayers
        - medianPlayers
        - sampleCount
      properties:
        dayOfWeek:
          type: integer
          minimum: 0
          maximum: 6
          description: UTC day of week; 0=Sunday and 6=Saturday.
        hour:
          type: integer
          minimum: 0
          maximum: 23
        averagePlayers:
          type: number
        medianPlayers:
          type: number
        sampleCount:
          type: integer
          minimum: 0
    HourlyProfilePoint:
      type: object
      additionalProperties: false
      required:
        - hour
        - averagePlayers
        - medianPlayers
        - sampleCount
      properties:
        hour:
          type: integer
          minimum: 0
          maximum: 23
        averagePlayers:
          type: number
        medianPlayers:
          type: number
        sampleCount:
          type: integer
          minimum: 0
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - RAPIDAPI_UNAUTHORIZED
                - FEATURE_NOT_AVAILABLE
                - SERVER_NOT_FOUND
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
  responses:
    InvalidRequest:
      description: Query, path, body, range, or duplicate-reference validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidRequest:
              value:
                error:
                  code: INVALID_REQUEST
                  message: Invalid request
    Unauthorized:
      description: RapidAPI authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error:
                  code: RAPIDAPI_UNAUTHORIZED
                  message: Unauthorized
    FeatureNotAvailable:
      description: The authenticated subscription does not include this feature or range.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            featureNotAvailable:
              value:
                error:
                  code: FEATURE_NOT_AVAILABLE
                  message: Feature not available for this subscription
    ServerNotFound:
      description: Server is unknown or is not publishable through RapidAPI.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            serverNotFound:
              value:
                error:
                  code: SERVER_NOT_FOUND
                  message: Server not found
    InternalError:
      description: Unexpected service error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              value:
                error:
                  code: INTERNAL_ERROR
                  message: Internal server error
  securitySchemes:
    RapidApiKey:
      type: apiKey
      in: header
      name: X-RapidAPI-Key
      description: Customer key supplied by RapidAPI.
      x-default: YOUR_API_KEY

````