@@ -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
@@ -74359,6 +74376,179 @@ components:
7435974376 $ref: "#/components/schemas/RumPermanentRetentionFilterData"
7436074377 type: array
7436174378 type: object
74379+ RumRateLimitAdaptiveConfig:
74380+ description: The configuration used when `mode` is `adaptive`.
74381+ properties:
74382+ max_retention_rate:
74383+ description: The maximum fraction of sessions to retain, in the range `(0, 1]`.
74384+ example: 0.5
74385+ exclusiveMinimum: true
74386+ format: double
74387+ maximum: 1
74388+ minimum: 0
74389+ type: number
74390+ required:
74391+ - max_retention_rate
74392+ type: object
74393+ RumRateLimitConfigAttributes:
74394+ description: The RUM rate limit configuration properties.
74395+ properties:
74396+ adaptive:
74397+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
74398+ custom:
74399+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
74400+ mode:
74401+ $ref: "#/components/schemas/RumRateLimitMode"
74402+ org_id:
74403+ description: The ID of the organization the rate limit configuration belongs to.
74404+ example: 2
74405+ format: int64
74406+ type: integer
74407+ updated_at:
74408+ description: The date the rate limit configuration was last updated.
74409+ example: "2026-03-04T15:37:54.951447Z"
74410+ type: string
74411+ updated_by:
74412+ description: The handle of the user who last updated the rate limit configuration.
74413+ example: test@example.com
74414+ type: string
74415+ required:
74416+ - mode
74417+ - org_id
74418+ type: object
74419+ RumRateLimitConfigData:
74420+ description: The RUM rate limit configuration object.
74421+ properties:
74422+ attributes:
74423+ $ref: "#/components/schemas/RumRateLimitConfigAttributes"
74424+ id:
74425+ description: The identifier of the scope the rate limit configuration applies to.
74426+ example: cd73a516-a481-4af5-8352-9b577465c77b
74427+ type: string
74428+ type:
74429+ $ref: "#/components/schemas/RumRateLimitConfigType"
74430+ required:
74431+ - id
74432+ - type
74433+ - attributes
74434+ type: object
74435+ RumRateLimitConfigResponse:
74436+ description: The RUM rate limit configuration response.
74437+ properties:
74438+ data:
74439+ $ref: "#/components/schemas/RumRateLimitConfigData"
74440+ required:
74441+ - data
74442+ type: object
74443+ RumRateLimitConfigType:
74444+ default: rum_rate_limit_config
74445+ description: The type of the resource, always `rum_rate_limit_config`.
74446+ enum:
74447+ - rum_rate_limit_config
74448+ example: rum_rate_limit_config
74449+ type: string
74450+ x-enum-varnames: ["RUM_RATE_LIMIT_CONFIG"]
74451+ RumRateLimitConfigUpdateAttributes:
74452+ description: The RUM rate limit configuration properties to create or update.
74453+ properties:
74454+ adaptive:
74455+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
74456+ custom:
74457+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
74458+ mode:
74459+ $ref: "#/components/schemas/RumRateLimitMode"
74460+ required:
74461+ - mode
74462+ type: object
74463+ RumRateLimitConfigUpdateData:
74464+ description: The RUM rate limit configuration to create or update.
74465+ properties:
74466+ attributes:
74467+ $ref: "#/components/schemas/RumRateLimitConfigUpdateAttributes"
74468+ id:
74469+ description: |-
74470+ The identifier of the scope the rate limit configuration applies to.
74471+ Must match `scope_id` in the path.
74472+ example: cd73a516-a481-4af5-8352-9b577465c77b
74473+ type: string
74474+ type:
74475+ $ref: "#/components/schemas/RumRateLimitConfigType"
74476+ required:
74477+ - id
74478+ - type
74479+ - attributes
74480+ type: object
74481+ RumRateLimitConfigUpdateRequest:
74482+ description: The body of a request to create or update a RUM rate limit configuration.
74483+ properties:
74484+ data:
74485+ $ref: "#/components/schemas/RumRateLimitConfigUpdateData"
74486+ required:
74487+ - data
74488+ type: object
74489+ RumRateLimitCustomConfig:
74490+ description: The configuration used when `mode` is `custom`.
74491+ properties:
74492+ daily_reset_time:
74493+ description: The time of day when the daily quota resets, in `HH:MM` 24-hour format.
74494+ example: "08:00"
74495+ pattern: "^([01]\\d|2[0-3]):[0-5]\\d$"
74496+ type: string
74497+ daily_reset_timezone:
74498+ description: The timezone offset used for the daily reset time, in `±HH:MM` format.
74499+ example: "+09:00"
74500+ pattern: "^[+-](0\\d|1[0-4]):[0-5]\\d$"
74501+ type: string
74502+ quota_reached_action:
74503+ $ref: "#/components/schemas/RumRateLimitQuotaReachedAction"
74504+ session_limit:
74505+ description: The maximum number of sessions allowed within the window.
74506+ example: 1000000
74507+ format: int64
74508+ minimum: 1
74509+ type: integer
74510+ window_type:
74511+ $ref: "#/components/schemas/RumRateLimitWindowType"
74512+ required:
74513+ - window_type
74514+ - session_limit
74515+ - daily_reset_time
74516+ - daily_reset_timezone
74517+ - quota_reached_action
74518+ type: object
74519+ RumRateLimitMode:
74520+ description: |-
74521+ The rate limit mode. `custom` enforces a fixed session limit, while
74522+ `adaptive` dynamically adjusts retention.
74523+ enum:
74524+ - custom
74525+ - adaptive
74526+ example: custom
74527+ type: string
74528+ x-enum-varnames: ["CUSTOM", "ADAPTIVE"]
74529+ RumRateLimitQuotaReachedAction:
74530+ description: The action to take when the session quota is reached.
74531+ enum:
74532+ - stop
74533+ - slowdown
74534+ example: stop
74535+ type: string
74536+ x-enum-varnames: ["STOP", "SLOWDOWN"]
74537+ RumRateLimitScopeType:
74538+ default: application
74539+ description: The type of scope the rate limit configuration applies to.
74540+ enum:
74541+ - application
74542+ example: application
74543+ type: string
74544+ x-enum-varnames: ["APPLICATION"]
74545+ RumRateLimitWindowType:
74546+ description: The window type over which the session limit is enforced.
74547+ enum:
74548+ - daily
74549+ example: daily
74550+ type: string
74551+ x-enum-varnames: ["DAILY"]
7436274552 RumRetentionFilterAttributes:
7436374553 description: The object describing attributes of a RUM retention filter.
7436474554 properties:
@@ -152944,6 +153134,142 @@ paths:
152944153134 tags:
152945153135 - Rum Metrics
152946153136 x-codegen-request-body-name: body
153137+ /api/v2/rum/config/rate-limit/{scope_type}/{scope_id}:
153138+ delete:
153139+ description: Delete the RUM rate limit configuration for a given scope.
153140+ operationId: DeleteRumRateLimitConfig
153141+ parameters:
153142+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
153143+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
153144+ responses:
153145+ "204":
153146+ description: No Content
153147+ "400":
153148+ $ref: "#/components/responses/BadRequestResponse"
153149+ "403":
153150+ $ref: "#/components/responses/NotAuthorizedResponse"
153151+ "404":
153152+ $ref: "#/components/responses/NotFoundResponse"
153153+ "429":
153154+ $ref: "#/components/responses/TooManyRequestsResponse"
153155+ summary: Delete a RUM rate limit configuration
153156+ tags:
153157+ - Rum Rate Limit
153158+ x-unstable: |-
153159+ **Note**: This endpoint is in preview and is subject to change.
153160+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
153161+ get:
153162+ description: Get the RUM rate limit configuration for a given scope.
153163+ operationId: GetRumRateLimitConfig
153164+ parameters:
153165+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
153166+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
153167+ responses:
153168+ "200":
153169+ content:
153170+ application/json:
153171+ examples:
153172+ default:
153173+ value:
153174+ data:
153175+ attributes:
153176+ custom:
153177+ daily_reset_time: "08:00"
153178+ daily_reset_timezone: "+09:00"
153179+ quota_reached_action: stop
153180+ session_limit: 1000000
153181+ window_type: daily
153182+ mode: custom
153183+ org_id: 2
153184+ updated_at: "2026-03-04T15:37:54.951447Z"
153185+ updated_by: test@example.com
153186+ id: cd73a516-a481-4af5-8352-9b577465c77b
153187+ type: rum_rate_limit_config
153188+ schema:
153189+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
153190+ description: OK
153191+ "400":
153192+ $ref: "#/components/responses/BadRequestResponse"
153193+ "403":
153194+ $ref: "#/components/responses/NotAuthorizedResponse"
153195+ "404":
153196+ $ref: "#/components/responses/NotFoundResponse"
153197+ "429":
153198+ $ref: "#/components/responses/TooManyRequestsResponse"
153199+ summary: Get a RUM rate limit configuration
153200+ tags:
153201+ - Rum Rate Limit
153202+ x-unstable: |-
153203+ **Note**: This endpoint is in preview and is subject to change.
153204+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
153205+ put:
153206+ description: |-
153207+ Create or update the RUM rate limit configuration for a given scope.
153208+ Returns the rate limit configuration object when the request is successful.
153209+ operationId: UpdateRumRateLimitConfig
153210+ parameters:
153211+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
153212+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
153213+ requestBody:
153214+ content:
153215+ application/json:
153216+ examples:
153217+ default:
153218+ value:
153219+ data:
153220+ attributes:
153221+ custom:
153222+ daily_reset_time: "08:00"
153223+ daily_reset_timezone: "+09:00"
153224+ quota_reached_action: stop
153225+ session_limit: 1000000
153226+ window_type: daily
153227+ mode: custom
153228+ id: cd73a516-a481-4af5-8352-9b577465c77b
153229+ type: rum_rate_limit_config
153230+ schema:
153231+ $ref: "#/components/schemas/RumRateLimitConfigUpdateRequest"
153232+ description: The definition of the RUM rate limit configuration to create or update.
153233+ required: true
153234+ responses:
153235+ "200":
153236+ content:
153237+ application/json:
153238+ examples:
153239+ default:
153240+ value:
153241+ data:
153242+ attributes:
153243+ custom:
153244+ daily_reset_time: "08:00"
153245+ daily_reset_timezone: "+09:00"
153246+ quota_reached_action: stop
153247+ session_limit: 1000000
153248+ window_type: daily
153249+ mode: custom
153250+ org_id: 2
153251+ updated_at: "2026-03-04T21:52:53.526022Z"
153252+ updated_by: test@example.com
153253+ id: cd73a516-a481-4af5-8352-9b577465c77b
153254+ type: rum_rate_limit_config
153255+ schema:
153256+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
153257+ description: OK
153258+ "400":
153259+ $ref: "#/components/responses/BadRequestResponse"
153260+ "403":
153261+ $ref: "#/components/responses/NotAuthorizedResponse"
153262+ "404":
153263+ $ref: "#/components/responses/NotFoundResponse"
153264+ "429":
153265+ $ref: "#/components/responses/TooManyRequestsResponse"
153266+ summary: Create or update a RUM rate limit configuration
153267+ tags:
153268+ - Rum Rate Limit
153269+ x-codegen-request-body-name: body
153270+ x-unstable: |-
153271+ **Note**: This endpoint is in preview and is subject to change.
153272+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
152947153273 /api/v2/rum/events:
152948153274 get:
152949153275 description: |-
@@ -178682,6 +179008,9 @@ tags:
178682179008 description: Find out more at
178683179009 url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
178684179010 name: Rum Metrics
179011+ - description: |-
179012+ Manage RUM rate limit configurations for your organization's RUM applications.
179013+ name: Rum Rate Limit
178685179014 - description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.
178686179015 name: Rum Replay Heatmaps
178687179016 - description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration.
0 commit comments