@@ -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
@@ -73643,6 +73660,179 @@ components:
7364373660 $ref: "#/components/schemas/RumPermanentRetentionFilterData"
7364473661 type: array
7364573662 type: object
73663+ RumRateLimitAdaptiveConfig:
73664+ description: The configuration used when `mode` is `adaptive`.
73665+ properties:
73666+ max_retention_rate:
73667+ description: The maximum fraction of sessions to retain, in the range `(0, 1]`.
73668+ example: 0.5
73669+ exclusiveMinimum: true
73670+ format: double
73671+ maximum: 1
73672+ minimum: 0
73673+ type: number
73674+ required:
73675+ - max_retention_rate
73676+ type: object
73677+ RumRateLimitConfigAttributes:
73678+ description: The RUM rate limit configuration properties.
73679+ properties:
73680+ adaptive:
73681+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
73682+ custom:
73683+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
73684+ mode:
73685+ $ref: "#/components/schemas/RumRateLimitMode"
73686+ org_id:
73687+ description: The ID of the organization the rate limit configuration belongs to.
73688+ example: 2
73689+ format: int64
73690+ type: integer
73691+ updated_at:
73692+ description: The date the rate limit configuration was last updated.
73693+ example: "2026-03-04T15:37:54.951447Z"
73694+ type: string
73695+ updated_by:
73696+ description: The handle of the user who last updated the rate limit configuration.
73697+ example: test@example.com
73698+ type: string
73699+ required:
73700+ - mode
73701+ - org_id
73702+ type: object
73703+ RumRateLimitConfigData:
73704+ description: The RUM rate limit configuration object.
73705+ properties:
73706+ attributes:
73707+ $ref: "#/components/schemas/RumRateLimitConfigAttributes"
73708+ id:
73709+ description: The identifier of the scope the rate limit configuration applies to.
73710+ example: cd73a516-a481-4af5-8352-9b577465c77b
73711+ type: string
73712+ type:
73713+ $ref: "#/components/schemas/RumRateLimitConfigType"
73714+ required:
73715+ - id
73716+ - type
73717+ - attributes
73718+ type: object
73719+ RumRateLimitConfigResponse:
73720+ description: The RUM rate limit configuration response.
73721+ properties:
73722+ data:
73723+ $ref: "#/components/schemas/RumRateLimitConfigData"
73724+ required:
73725+ - data
73726+ type: object
73727+ RumRateLimitConfigType:
73728+ default: rum_rate_limit_config
73729+ description: The type of the resource, always `rum_rate_limit_config`.
73730+ enum:
73731+ - rum_rate_limit_config
73732+ example: rum_rate_limit_config
73733+ type: string
73734+ x-enum-varnames: ["RUM_RATE_LIMIT_CONFIG"]
73735+ RumRateLimitConfigUpdateAttributes:
73736+ description: The RUM rate limit configuration properties to create or update.
73737+ properties:
73738+ adaptive:
73739+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
73740+ custom:
73741+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
73742+ mode:
73743+ $ref: "#/components/schemas/RumRateLimitMode"
73744+ required:
73745+ - mode
73746+ type: object
73747+ RumRateLimitConfigUpdateData:
73748+ description: The RUM rate limit configuration to create or update.
73749+ properties:
73750+ attributes:
73751+ $ref: "#/components/schemas/RumRateLimitConfigUpdateAttributes"
73752+ id:
73753+ description: |-
73754+ The identifier of the scope the rate limit configuration applies to.
73755+ Must match `scope_id` in the path.
73756+ example: cd73a516-a481-4af5-8352-9b577465c77b
73757+ type: string
73758+ type:
73759+ $ref: "#/components/schemas/RumRateLimitConfigType"
73760+ required:
73761+ - id
73762+ - type
73763+ - attributes
73764+ type: object
73765+ RumRateLimitConfigUpdateRequest:
73766+ description: The body of a request to create or update a RUM rate limit configuration.
73767+ properties:
73768+ data:
73769+ $ref: "#/components/schemas/RumRateLimitConfigUpdateData"
73770+ required:
73771+ - data
73772+ type: object
73773+ RumRateLimitCustomConfig:
73774+ description: The configuration used when `mode` is `custom`.
73775+ properties:
73776+ daily_reset_time:
73777+ description: The time of day when the daily quota resets, in `HH:MM` 24-hour format.
73778+ example: "08:00"
73779+ pattern: "^([01]\\d|2[0-3]):[0-5]\\d$"
73780+ type: string
73781+ daily_reset_timezone:
73782+ description: The timezone offset used for the daily reset time, in `±HH:MM` format.
73783+ example: "+09:00"
73784+ pattern: "^[+-](0\\d|1[0-4]):[0-5]\\d$"
73785+ type: string
73786+ quota_reached_action:
73787+ $ref: "#/components/schemas/RumRateLimitQuotaReachedAction"
73788+ session_limit:
73789+ description: The maximum number of sessions allowed within the window.
73790+ example: 1000000
73791+ format: int64
73792+ minimum: 1
73793+ type: integer
73794+ window_type:
73795+ $ref: "#/components/schemas/RumRateLimitWindowType"
73796+ required:
73797+ - window_type
73798+ - session_limit
73799+ - daily_reset_time
73800+ - daily_reset_timezone
73801+ - quota_reached_action
73802+ type: object
73803+ RumRateLimitMode:
73804+ description: |-
73805+ The rate limit mode. `custom` enforces a fixed session limit, while
73806+ `adaptive` dynamically adjusts retention.
73807+ enum:
73808+ - custom
73809+ - adaptive
73810+ example: custom
73811+ type: string
73812+ x-enum-varnames: ["CUSTOM", "ADAPTIVE"]
73813+ RumRateLimitQuotaReachedAction:
73814+ description: The action to take when the session quota is reached.
73815+ enum:
73816+ - stop
73817+ - slowdown
73818+ example: stop
73819+ type: string
73820+ x-enum-varnames: ["STOP", "SLOWDOWN"]
73821+ RumRateLimitScopeType:
73822+ default: application
73823+ description: The type of scope the rate limit configuration applies to.
73824+ enum:
73825+ - application
73826+ example: application
73827+ type: string
73828+ x-enum-varnames: ["APPLICATION"]
73829+ RumRateLimitWindowType:
73830+ description: The window type over which the session limit is enforced.
73831+ enum:
73832+ - daily
73833+ example: daily
73834+ type: string
73835+ x-enum-varnames: ["DAILY"]
7364673836 RumRetentionFilterAttributes:
7364773837 description: The object describing attributes of a RUM retention filter.
7364873838 properties:
@@ -151716,6 +151906,142 @@ paths:
151716151906 tags:
151717151907 - Rum Metrics
151718151908 x-codegen-request-body-name: body
151909+ /api/v2/rum/config/rate-limit/{scope_type}/{scope_id}:
151910+ delete:
151911+ description: Delete the RUM rate limit configuration for a given scope.
151912+ operationId: DeleteRumRateLimitConfig
151913+ parameters:
151914+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
151915+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
151916+ responses:
151917+ "204":
151918+ description: No Content
151919+ "400":
151920+ $ref: "#/components/responses/BadRequestResponse"
151921+ "403":
151922+ $ref: "#/components/responses/NotAuthorizedResponse"
151923+ "404":
151924+ $ref: "#/components/responses/NotFoundResponse"
151925+ "429":
151926+ $ref: "#/components/responses/TooManyRequestsResponse"
151927+ summary: Delete a RUM rate limit configuration
151928+ tags:
151929+ - Rum Rate Limit
151930+ x-unstable: |-
151931+ **Note**: This endpoint is in preview and is subject to change.
151932+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
151933+ get:
151934+ description: Get the RUM rate limit configuration for a given scope.
151935+ operationId: GetRumRateLimitConfig
151936+ parameters:
151937+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
151938+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
151939+ responses:
151940+ "200":
151941+ content:
151942+ application/json:
151943+ examples:
151944+ default:
151945+ value:
151946+ data:
151947+ attributes:
151948+ custom:
151949+ daily_reset_time: "08:00"
151950+ daily_reset_timezone: "+09:00"
151951+ quota_reached_action: stop
151952+ session_limit: 1000000
151953+ window_type: daily
151954+ mode: custom
151955+ org_id: 2
151956+ updated_at: "2026-03-04T15:37:54.951447Z"
151957+ updated_by: test@example.com
151958+ id: cd73a516-a481-4af5-8352-9b577465c77b
151959+ type: rum_rate_limit_config
151960+ schema:
151961+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
151962+ description: OK
151963+ "400":
151964+ $ref: "#/components/responses/BadRequestResponse"
151965+ "403":
151966+ $ref: "#/components/responses/NotAuthorizedResponse"
151967+ "404":
151968+ $ref: "#/components/responses/NotFoundResponse"
151969+ "429":
151970+ $ref: "#/components/responses/TooManyRequestsResponse"
151971+ summary: Get a RUM rate limit configuration
151972+ tags:
151973+ - Rum Rate Limit
151974+ x-unstable: |-
151975+ **Note**: This endpoint is in preview and is subject to change.
151976+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
151977+ put:
151978+ description: |-
151979+ Create or update the RUM rate limit configuration for a given scope.
151980+ Returns the rate limit configuration object when the request is successful.
151981+ operationId: UpdateRumRateLimitConfig
151982+ parameters:
151983+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
151984+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
151985+ requestBody:
151986+ content:
151987+ application/json:
151988+ examples:
151989+ default:
151990+ value:
151991+ data:
151992+ attributes:
151993+ custom:
151994+ daily_reset_time: "08:00"
151995+ daily_reset_timezone: "+09:00"
151996+ quota_reached_action: stop
151997+ session_limit: 1000000
151998+ window_type: daily
151999+ mode: custom
152000+ id: cd73a516-a481-4af5-8352-9b577465c77b
152001+ type: rum_rate_limit_config
152002+ schema:
152003+ $ref: "#/components/schemas/RumRateLimitConfigUpdateRequest"
152004+ description: The definition of the RUM rate limit configuration to create or update.
152005+ required: true
152006+ responses:
152007+ "200":
152008+ content:
152009+ application/json:
152010+ examples:
152011+ default:
152012+ value:
152013+ data:
152014+ attributes:
152015+ custom:
152016+ daily_reset_time: "08:00"
152017+ daily_reset_timezone: "+09:00"
152018+ quota_reached_action: stop
152019+ session_limit: 1000000
152020+ window_type: daily
152021+ mode: custom
152022+ org_id: 2
152023+ updated_at: "2026-03-04T21:52:53.526022Z"
152024+ updated_by: test@example.com
152025+ id: cd73a516-a481-4af5-8352-9b577465c77b
152026+ type: rum_rate_limit_config
152027+ schema:
152028+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
152029+ description: OK
152030+ "400":
152031+ $ref: "#/components/responses/BadRequestResponse"
152032+ "403":
152033+ $ref: "#/components/responses/NotAuthorizedResponse"
152034+ "404":
152035+ $ref: "#/components/responses/NotFoundResponse"
152036+ "429":
152037+ $ref: "#/components/responses/TooManyRequestsResponse"
152038+ summary: Create or update a RUM rate limit configuration
152039+ tags:
152040+ - Rum Rate Limit
152041+ x-codegen-request-body-name: body
152042+ x-unstable: |-
152043+ **Note**: This endpoint is in preview and is subject to change.
152044+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
151719152045 /api/v2/rum/events:
151720152046 get:
151721152047 description: |-
@@ -176619,6 +176945,9 @@ tags:
176619176945 description: Find out more at
176620176946 url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
176621176947 name: Rum Metrics
176948+ - description: |-
176949+ Manage RUM rate limit configurations for your organization's RUM applications.
176950+ name: Rum Rate Limit
176622176951 - description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.
176623176952 name: Rum Replay Heatmaps
176624176953 - description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration.
0 commit comments