@@ -1586,6 +1586,23 @@ components:
15861586 required: true
15871587 schema:
15881588 $ref: "#/components/schemas/RumPermanentRetentionFilterID"
1589+ RumRateLimitScopeIDParameter:
1590+ description: |-
1591+ The identifier of the scope the rate limit configuration applies to.
1592+ For the `application` scope, this is the RUM application ID.
1593+ in: path
1594+ name: scope_id
1595+ required: true
1596+ schema:
1597+ example: cd73a516-a481-4af5-8352-9b577465c77b
1598+ type: string
1599+ RumRateLimitScopeTypeParameter:
1600+ description: The type of scope the rate limit configuration applies to.
1601+ in: path
1602+ name: scope_type
1603+ required: true
1604+ schema:
1605+ $ref: "#/components/schemas/RumRateLimitScopeType"
15891606 RumRetentionFilterIDParameter:
15901607 description: Retention filter ID.
15911608 in: path
@@ -74528,6 +74545,179 @@ components:
7452874545 $ref: "#/components/schemas/RumPermanentRetentionFilterData"
7452974546 type: array
7453074547 type: object
74548+ RumRateLimitAdaptiveConfig:
74549+ description: The configuration used when `mode` is `adaptive`.
74550+ properties:
74551+ max_retention_rate:
74552+ description: The maximum fraction of sessions to retain, in the range `(0, 1]`.
74553+ example: 0.5
74554+ exclusiveMinimum: true
74555+ format: double
74556+ maximum: 1
74557+ minimum: 0
74558+ type: number
74559+ required:
74560+ - max_retention_rate
74561+ type: object
74562+ RumRateLimitConfigAttributes:
74563+ description: The RUM rate limit configuration properties.
74564+ properties:
74565+ adaptive:
74566+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
74567+ custom:
74568+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
74569+ mode:
74570+ $ref: "#/components/schemas/RumRateLimitMode"
74571+ org_id:
74572+ description: The ID of the organization the rate limit configuration belongs to.
74573+ example: 2
74574+ format: int64
74575+ type: integer
74576+ updated_at:
74577+ description: The date the rate limit configuration was last updated.
74578+ example: "2026-03-04T15:37:54.951447Z"
74579+ type: string
74580+ updated_by:
74581+ description: The handle of the user who last updated the rate limit configuration.
74582+ example: test@example.com
74583+ type: string
74584+ required:
74585+ - mode
74586+ - org_id
74587+ type: object
74588+ RumRateLimitConfigData:
74589+ description: The RUM rate limit configuration object.
74590+ properties:
74591+ attributes:
74592+ $ref: "#/components/schemas/RumRateLimitConfigAttributes"
74593+ id:
74594+ description: The identifier of the scope the rate limit configuration applies to.
74595+ example: cd73a516-a481-4af5-8352-9b577465c77b
74596+ type: string
74597+ type:
74598+ $ref: "#/components/schemas/RumRateLimitConfigType"
74599+ required:
74600+ - id
74601+ - type
74602+ - attributes
74603+ type: object
74604+ RumRateLimitConfigResponse:
74605+ description: The RUM rate limit configuration response.
74606+ properties:
74607+ data:
74608+ $ref: "#/components/schemas/RumRateLimitConfigData"
74609+ required:
74610+ - data
74611+ type: object
74612+ RumRateLimitConfigType:
74613+ default: rum_rate_limit_config
74614+ description: The type of the resource, always `rum_rate_limit_config`.
74615+ enum:
74616+ - rum_rate_limit_config
74617+ example: rum_rate_limit_config
74618+ type: string
74619+ x-enum-varnames: ["RUM_RATE_LIMIT_CONFIG"]
74620+ RumRateLimitConfigUpdateAttributes:
74621+ description: The RUM rate limit configuration properties to create or update.
74622+ properties:
74623+ adaptive:
74624+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
74625+ custom:
74626+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
74627+ mode:
74628+ $ref: "#/components/schemas/RumRateLimitMode"
74629+ required:
74630+ - mode
74631+ type: object
74632+ RumRateLimitConfigUpdateData:
74633+ description: The RUM rate limit configuration to create or update.
74634+ properties:
74635+ attributes:
74636+ $ref: "#/components/schemas/RumRateLimitConfigUpdateAttributes"
74637+ id:
74638+ description: |-
74639+ The identifier of the scope the rate limit configuration applies to.
74640+ Must match `scope_id` in the path.
74641+ example: cd73a516-a481-4af5-8352-9b577465c77b
74642+ type: string
74643+ type:
74644+ $ref: "#/components/schemas/RumRateLimitConfigType"
74645+ required:
74646+ - id
74647+ - type
74648+ - attributes
74649+ type: object
74650+ RumRateLimitConfigUpdateRequest:
74651+ description: The body of a request to create or update a RUM rate limit configuration.
74652+ properties:
74653+ data:
74654+ $ref: "#/components/schemas/RumRateLimitConfigUpdateData"
74655+ required:
74656+ - data
74657+ type: object
74658+ RumRateLimitCustomConfig:
74659+ description: The configuration used when `mode` is `custom`.
74660+ properties:
74661+ daily_reset_time:
74662+ description: The time of day when the daily quota resets, in `HH:MM` 24-hour format.
74663+ example: "08:00"
74664+ pattern: "^([01]\\d|2[0-3]):[0-5]\\d$"
74665+ type: string
74666+ daily_reset_timezone:
74667+ description: The timezone offset used for the daily reset time, in `±HH:MM` format.
74668+ example: "+09:00"
74669+ pattern: "^[+-](0\\d|1[0-4]):[0-5]\\d$"
74670+ type: string
74671+ quota_reached_action:
74672+ $ref: "#/components/schemas/RumRateLimitQuotaReachedAction"
74673+ session_limit:
74674+ description: The maximum number of sessions allowed within the window.
74675+ example: 1000000
74676+ format: int64
74677+ minimum: 1
74678+ type: integer
74679+ window_type:
74680+ $ref: "#/components/schemas/RumRateLimitWindowType"
74681+ required:
74682+ - window_type
74683+ - session_limit
74684+ - daily_reset_time
74685+ - daily_reset_timezone
74686+ - quota_reached_action
74687+ type: object
74688+ RumRateLimitMode:
74689+ description: |-
74690+ The rate limit mode. `custom` enforces a fixed session limit, while
74691+ `adaptive` dynamically adjusts retention.
74692+ enum:
74693+ - custom
74694+ - adaptive
74695+ example: custom
74696+ type: string
74697+ x-enum-varnames: ["CUSTOM", "ADAPTIVE"]
74698+ RumRateLimitQuotaReachedAction:
74699+ description: The action to take when the session quota is reached.
74700+ enum:
74701+ - stop
74702+ - slowdown
74703+ example: stop
74704+ type: string
74705+ x-enum-varnames: ["STOP", "SLOWDOWN"]
74706+ RumRateLimitScopeType:
74707+ default: application
74708+ description: The type of scope the rate limit configuration applies to.
74709+ enum:
74710+ - application
74711+ example: application
74712+ type: string
74713+ x-enum-varnames: ["APPLICATION"]
74714+ RumRateLimitWindowType:
74715+ description: The window type over which the session limit is enforced.
74716+ enum:
74717+ - daily
74718+ example: daily
74719+ type: string
74720+ x-enum-varnames: ["DAILY"]
7453174721 RumRetentionFilterAttributes:
7453274722 description: The object describing attributes of a RUM retention filter.
7453374723 properties:
@@ -153409,6 +153599,142 @@ paths:
153409153599 tags:
153410153600 - Rum Metrics
153411153601 x-codegen-request-body-name: body
153602+ /api/v2/rum/config/rate-limit/{scope_type}/{scope_id}:
153603+ delete:
153604+ description: Delete the RUM rate limit configuration for a given scope.
153605+ operationId: DeleteRumRateLimitConfig
153606+ parameters:
153607+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
153608+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
153609+ responses:
153610+ "204":
153611+ description: No Content
153612+ "400":
153613+ $ref: "#/components/responses/BadRequestResponse"
153614+ "403":
153615+ $ref: "#/components/responses/NotAuthorizedResponse"
153616+ "404":
153617+ $ref: "#/components/responses/NotFoundResponse"
153618+ "429":
153619+ $ref: "#/components/responses/TooManyRequestsResponse"
153620+ summary: Delete a RUM rate limit configuration
153621+ tags:
153622+ - Rum Rate Limit
153623+ x-unstable: |-
153624+ **Note**: This endpoint is in preview and is subject to change.
153625+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
153626+ get:
153627+ description: Get the RUM rate limit configuration for a given scope.
153628+ operationId: GetRumRateLimitConfig
153629+ parameters:
153630+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
153631+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
153632+ responses:
153633+ "200":
153634+ content:
153635+ application/json:
153636+ examples:
153637+ default:
153638+ value:
153639+ data:
153640+ attributes:
153641+ custom:
153642+ daily_reset_time: "08:00"
153643+ daily_reset_timezone: "+09:00"
153644+ quota_reached_action: stop
153645+ session_limit: 1000000
153646+ window_type: daily
153647+ mode: custom
153648+ org_id: 2
153649+ updated_at: "2026-03-04T15:37:54.951447Z"
153650+ updated_by: test@example.com
153651+ id: cd73a516-a481-4af5-8352-9b577465c77b
153652+ type: rum_rate_limit_config
153653+ schema:
153654+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
153655+ description: OK
153656+ "400":
153657+ $ref: "#/components/responses/BadRequestResponse"
153658+ "403":
153659+ $ref: "#/components/responses/NotAuthorizedResponse"
153660+ "404":
153661+ $ref: "#/components/responses/NotFoundResponse"
153662+ "429":
153663+ $ref: "#/components/responses/TooManyRequestsResponse"
153664+ summary: Get a RUM rate limit configuration
153665+ tags:
153666+ - Rum Rate Limit
153667+ x-unstable: |-
153668+ **Note**: This endpoint is in preview and is subject to change.
153669+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
153670+ put:
153671+ description: |-
153672+ Create or update the RUM rate limit configuration for a given scope.
153673+ Returns the rate limit configuration object when the request is successful.
153674+ operationId: UpdateRumRateLimitConfig
153675+ parameters:
153676+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
153677+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
153678+ requestBody:
153679+ content:
153680+ application/json:
153681+ examples:
153682+ default:
153683+ value:
153684+ data:
153685+ attributes:
153686+ custom:
153687+ daily_reset_time: "08:00"
153688+ daily_reset_timezone: "+09:00"
153689+ quota_reached_action: stop
153690+ session_limit: 1000000
153691+ window_type: daily
153692+ mode: custom
153693+ id: cd73a516-a481-4af5-8352-9b577465c77b
153694+ type: rum_rate_limit_config
153695+ schema:
153696+ $ref: "#/components/schemas/RumRateLimitConfigUpdateRequest"
153697+ description: The definition of the RUM rate limit configuration to create or update.
153698+ required: true
153699+ responses:
153700+ "200":
153701+ content:
153702+ application/json:
153703+ examples:
153704+ default:
153705+ value:
153706+ data:
153707+ attributes:
153708+ custom:
153709+ daily_reset_time: "08:00"
153710+ daily_reset_timezone: "+09:00"
153711+ quota_reached_action: stop
153712+ session_limit: 1000000
153713+ window_type: daily
153714+ mode: custom
153715+ org_id: 2
153716+ updated_at: "2026-03-04T21:52:53.526022Z"
153717+ updated_by: test@example.com
153718+ id: cd73a516-a481-4af5-8352-9b577465c77b
153719+ type: rum_rate_limit_config
153720+ schema:
153721+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
153722+ description: OK
153723+ "400":
153724+ $ref: "#/components/responses/BadRequestResponse"
153725+ "403":
153726+ $ref: "#/components/responses/NotAuthorizedResponse"
153727+ "404":
153728+ $ref: "#/components/responses/NotFoundResponse"
153729+ "429":
153730+ $ref: "#/components/responses/TooManyRequestsResponse"
153731+ summary: Create or update a RUM rate limit configuration
153732+ tags:
153733+ - Rum Rate Limit
153734+ x-codegen-request-body-name: body
153735+ x-unstable: |-
153736+ **Note**: This endpoint is in preview and is subject to change.
153737+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
153412153738 /api/v2/rum/events:
153413153739 get:
153414153740 description: |-
@@ -179358,6 +179684,9 @@ tags:
179358179684 description: Find out more at
179359179685 url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
179360179686 name: Rum Metrics
179687+ - description: |-
179688+ Manage RUM rate limit configurations for your organization's RUM applications.
179689+ name: Rum Rate Limit
179361179690 - description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.
179362179691 name: Rum Replay Heatmaps
179363179692 - description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration.
0 commit comments