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

# Get RUM resource info

> Return the account's RUM resource record and its current session usage.

## Restrictions

| Aspect      | Value                                                         |
| ----------- | ------------------------------------------------------------- |
| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |
| Permissions | None — any valid `app_key` can call this operation            |

## Usage

* Returns `ResourceNotFound` when the account has no RUM resource provisioned yet, or when the resource's status is `deleted`/`destroyed`.
* `no_cache=true` bypasses the short-lived cache of the resource record itself (plan version, quotas, status). The `used_cnt` figures come from a separate hourly cache that this flag does not affect, so they can lag behind live usage either way.
* The used-count fields reflect the current 30-day billing window (`window_start_time` to `window_end_time`), not lifetime totals.
* `expired_at` is only populated on on-premises deployments, from the license expiry date; it is omitted entirely for SaaS accounts.
* For `version=free` accounts, `session_limit_reached` is `true` once usage exceeds the combined free quota across all applications (per-app free quota × application count); it stays `false` while the account has no applications yet.


## OpenAPI

````yaml /api-reference/rum.openapi.en.json post /rum/resource/info
openapi: 3.1.0
info:
  title: Flashduty Open API
  description: >-
    Public HTTP API for the Flashduty incident management platform — incidents,
    notification templates, channels, schedules, monitors, RUM, and platform
    administration. Every operation is authenticated with an `app_key` query
    parameter issued from the Flashduty console under Account → APP Keys.
    Responses follow a uniform envelope: `{ request_id, data }` on success, `{
    request_id, error }` on failure.
  version: 1.0.0
servers:
  - url: https://api.flashcat.cloud
    description: Flashduty Open API
security:
  - AppKeyAuth: []
tags:
  - name: RUM/Applications
    description: Manage Real User Monitoring (RUM) applications.
  - name: RUM/Data query
    description: Run RUM analytics queries over event data.
  - name: RUM/Issues
    description: Query and manage RUM error tracking issues and preset severity rules.
  - name: RUM/Facets
    description: >-
      Query RUM facet fields and their value distributions for building
      analytics filters.
  - name: RUM/Sourcemaps
    description: >-
      Manage and query RUM sourcemap files for browser, Android, and iOS error
      symbolication.
  - name: RUM/Session replay
    description: Retrieve session replay metadata and recorded segments for RUM sessions.
  - name: RUM/Error ingestion rules
    description: >-
      Configure and inspect the rules that decide which RUM errors get ingested
      and stored for an application, including their edit history.
  - name: RUM/Issue preset severity rules
    description: >-
      Manage per-application rules that assign a severity to matching front-end
      errors, plus their evaluation order and change history.
  - name: RUM/Resources
    description: Query the RUM resource record and current usage for the account.
paths:
  /rum/resource/info:
    post:
      tags:
        - RUM/Resources
      summary: Get RUM resource info
      description: Return the account's RUM resource record and its current session usage.
      operationId: rum-resource-read-info
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RumResourceInfoRequest'
            example:
              no_cache: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/RumResourceItem'
              example:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                data:
                  account_id: 2451002751131
                  product: rum
                  resource_id: rum_2451002751131
                  resource_name: rum_2451002751131
                  order_id: fd_order_20250615_8f3a1c2b
                  version: professional
                  offering_id: 11
                  session_measure.used_cnt: 128400
                  session_investigate.used_cnt: 5230
                  session_replay.used_cnt: 812
                  session_measure.free_cnt: 0
                  session_investigate.free_cnt: 0
                  session_replay.free_cnt: 0
                  session.days: 30
                  view.days: 30
                  error.days: 30
                  action.days: 30
                  resource.days: 15
                  long_task.days: 15
                  status: enabled
                  created_at: 1750000000
                  updated_at: 1752000000
                  window_start_time: 1750000000
                  window_end_time: 1752592000
                  session_limit_reached: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    RumResourceInfoRequest:
      type: object
      description: Query parameters for reading the account's RUM resource record.
      properties:
        no_cache:
          type: boolean
          description: >-
            Bypass the short-lived cache of the resource record (plan version,
            quotas, status) and read it from source. Does not refresh the usage
            counts. Default `false`.
          default: false
    SuccessEnvelope:
      type: object
      description: >-
        Success response envelope. On every 2xx response, `request_id`
        identifies the call (also mirrored in the `Flashcat-Request-Id` header)
        and `data` holds the endpoint-specific payload. Failure responses use a
        different shape — see `ErrorResponse`.
      properties:
        request_id:
          type: string
          description: >-
            Unique ID for this request. Mirrored in the Flashcat-Request-Id
            response header. Include it when reporting issues.
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        data:
          description: Endpoint-specific payload. See each operation's 200 response schema.
      required:
        - request_id
        - data
    RumResourceItem:
      type: object
      description: >-
        The account's RUM resource record, including its plan window and current
        session usage.
      required:
        - account_id
        - product
        - resource_id
        - resource_name
        - order_id
        - version
        - offering_id
        - session_measure.used_cnt
        - session_investigate.used_cnt
        - session_replay.used_cnt
        - session_measure.free_cnt
        - session_investigate.free_cnt
        - session_replay.free_cnt
        - session.days
        - view.days
        - error.days
        - action.days
        - resource.days
        - long_task.days
        - status
        - created_at
        - updated_at
        - window_start_time
        - window_end_time
        - session_limit_reached
      properties:
        account_id:
          type: integer
          format: int64
          description: Account ID that owns this resource.
        product:
          type: string
          enum:
            - rum
          description: Product code for this resource. Always `rum` for this endpoint.
        resource_id:
          type: string
          description: Unique resource identifier for the account's RUM resource.
        resource_name:
          type: string
          description: Display name of the resource.
        order_id:
          type: string
          description: >-
            ID of the order that provisioned this resource. Empty for resources
            provisioned outside the order flow (e.g. on-premises).
        version:
          type: string
          enum:
            - free
            - professional
          description: >-
            Plan version of this resource. One of `free` (free plan) or
            `professional` (professional plan).
        offering_id:
          type: integer
          format: int64
          description: ID of the offering (SKU) this resource was provisioned from.
        session_measure.used_cnt:
          type: integer
          format: int64
          description: >-
            Number of measure (performance) sessions used in the current billing
            window.
        session_investigate.used_cnt:
          type: integer
          format: int64
          description: >-
            Number of investigate (error tracking) sessions used in the current
            billing window.
        session_replay.used_cnt:
          type: integer
          format: int64
          description: >-
            Number of session-replay sessions used in the current billing
            window.
        session_measure.free_cnt:
          type: integer
          format: int64
          description: Free quota for measure sessions per application, per billing window.
        session_investigate.free_cnt:
          type: integer
          format: int64
          description: >-
            Free quota for investigate sessions per application, per billing
            window.
        session_replay.free_cnt:
          type: integer
          format: int64
          description: >-
            Free quota for session-replay sessions per application, per billing
            window.
        session.days:
          type: integer
          format: int64
          description: Retention period in days for session data.
        view.days:
          type: integer
          format: int64
          description: Retention period in days for view (page/screen) data.
        error.days:
          type: integer
          format: int64
          description: Retention period in days for error data.
        action.days:
          type: integer
          format: int64
          description: Retention period in days for action (user interaction) data.
        resource.days:
          type: integer
          format: int64
          description: Retention period in days for resource (network request) data.
        long_task.days:
          type: integer
          format: int64
          description: Retention period in days for long-task data.
        status:
          type: string
          enum:
            - enabled
            - disabled
          description: >-
            Status of the resource. A resource with status `deleted` or
            `destroyed` never reaches this field — the operation returns
            `ResourceNotFound` for those instead.
        created_at:
          type: integer
          format: int64
          description: >-
            Unix timestamp in seconds when the resource was created. Also
            anchors the start of the first billing window.
        updated_at:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the resource was last updated.
        window_start_time:
          type: integer
          format: int64
          description: >-
            Unix timestamp in seconds for the start of the current 30-day
            billing window.
        window_end_time:
          type: integer
          format: int64
          description: >-
            Unix timestamp in seconds for the end of the current 30-day billing
            window.
        session_limit_reached:
          type: boolean
          description: >-
            `true` when a `version=free` account has exceeded its combined free
            session quota across all applications. Always `false` for non-free
            plans.
        expired_at:
          type: integer
          format: int64
          description: >-
            Unix timestamp in seconds when the on-premises license expires. Only
            present on on-premises deployments; omitted entirely for SaaS
            accounts.
    ErrorResponse:
      type: object
      description: Response envelope for errors. `error` is required; `data` is absent.
      properties:
        request_id:
          type: string
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          description: >-
            Unique trace ID of this request; include it when reporting issues so
            logs can be located.
        error:
          $ref: '#/components/schemas/DutyError'
      required:
        - request_id
        - error
    DutyError:
      type: object
      description: >-
        Error payload inside the response envelope. Present only on non-2xx
        responses.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message, localized by the caller's
            Accept-Language. May contain field names, IDs, or other context from
            the failing request.
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
    ErrorCode:
      type: string
      description: >-
        Flashduty error code enum. Every failed API response sets `error.code`
        to one of these stable wire strings. HTTP status is informational — the
        authoritative signal is the enum value.


        | Code | HTTP | Meaning |

        |---|---|---|

        | `OK` | 200 | Reserved — not returned on real errors. |

        | `InvalidParameter` | 400 | A required parameter is missing or failed
        validation. |

        | `BadRequest` | 400 | Generic 400 used when no more specific code fits.
        |

        | `InvalidContentType` | 400 | The `Content-Type` header is not
        `application/json`. |

        | `ResourceNotFound` | 400 | The referenced resource does not exist.
        Note: returned as HTTP 400, not 404 (historical choice). |

        | `NoLicense` | 400 | The feature is license-gated and no active license
        was found. |

        | `ReferenceExist` | 400 | Deletion blocked — other entities still
        reference this resource. |

        | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. |

        | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient
        account balance. |

        | `AccessDenied` | 403 | Authenticated but lacking the permission
        required for this operation. |

        | `RouteNotFound` | 404 | The request URL path is not a known route. |

        | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this
        otherwise-known path. |

        | `UndonedOrderExist` | 409 | An outstanding billing order blocks this
        new one. Wait and retry. |

        | `RequestLocked` | 423 | Operation temporarily locked due to repeated
        failures. |

        | `EntityTooLarge` | 413 | Request body exceeds the configured max size.
        |

        | `RequestTooFrequently` | 429 | Rate limit hit — API-global,
        per-account, or per-integration. |

        | `RequestVerifyRequired` | 428 | Second-factor verification required
        but not supplied. |

        | `DangerousOperation` | 428 | High-risk operation requires MFA
        verification. |

        | `InternalError` | 500 | Unhandled server-side error. Include
        `request_id` in the bug report. |

        | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try
        again later. |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - RequestLocked
        - EntityTooLarge
        - RequestTooFrequently
        - RequestVerifyRequired
        - DangerousOperation
        - InternalError
        - ServiceUnavailable
      x-enumDescriptions:
        OK: Reserved — not returned on real errors.
        InvalidParameter: A required parameter is missing or failed validation.
        BadRequest: Generic 400 used when no more specific code fits.
        InvalidContentType: The `Content-Type` header is not `application/json`.
        ResourceNotFound: >-
          The referenced resource does not exist. Note: returned as HTTP 400,
          not 404 (historical choice).
        NoLicense: The feature is license-gated and no active license was found.
        ReferenceExist: Deletion blocked — other entities still reference this resource.
        Unauthorized: '`app_key` is missing, invalid, or expired.'
        BalanceNotEnough: Billing-gated operation with insufficient account balance.
        AccessDenied: Authenticated but lacking the permission required for this operation.
        RouteNotFound: The request URL path is not a known route.
        MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path.
        UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry.
        RequestLocked: Operation temporarily locked due to repeated failures.
        EntityTooLarge: Request body exceeds the configured max size.
        RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration.
        RequestVerifyRequired: Second-factor verification required but not supplied.
        DangerousOperation: High-risk operation requires MFA verification.
        InternalError: Unhandled server-side error. Include `request_id` in the bug report.
        ServiceUnavailable: A backend dependency is unavailable. Try again later.
      example: InvalidParameter
  responses:
    BadRequest:
      description: Invalid request — usually a missing or malformed parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingParameter:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
    Unauthorized:
      description: Missing or invalid app_key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingAppKey:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: Unauthorized
                  message: You are unauthorized.
    TooManyRequests:
      description: >-
        Rate limit hit. Either the global API limit, a per-account limit, or a
        per-integration limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
    ServerError:
      description: Unexpected server-side error. Include the request_id when reporting.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: app_key
      description: >-
        App key issued from the Flashduty console under Account → APP Keys.
        Required on every public API call. Keep it secret — it grants the same
        access as the owning account.

````