@@ -1565,6 +1565,23 @@ components:
15651565 required: true
15661566 schema:
15671567 $ref: "#/components/schemas/RumPermanentRetentionFilterID"
1568+ RumRateLimitScopeIDParameter:
1569+ description: |-
1570+ The identifier of the scope the rate limit configuration applies to.
1571+ For the `application` scope, this is the RUM application ID.
1572+ in: path
1573+ name: scope_id
1574+ required: true
1575+ schema:
1576+ example: cd73a516-a481-4af5-8352-9b577465c77b
1577+ type: string
1578+ RumRateLimitScopeTypeParameter:
1579+ description: The type of scope the rate limit configuration applies to.
1580+ in: path
1581+ name: scope_type
1582+ required: true
1583+ schema:
1584+ $ref: "#/components/schemas/RumRateLimitScopeType"
15681585 RumRetentionFilterIDParameter:
15691586 description: Retention filter ID.
15701587 in: path
@@ -71652,6 +71669,179 @@ components:
7165271669 $ref: "#/components/schemas/RumPermanentRetentionFilterData"
7165371670 type: array
7165471671 type: object
71672+ RumRateLimitAdaptiveConfig:
71673+ description: The configuration used when `mode` is `adaptive`.
71674+ properties:
71675+ max_retention_rate:
71676+ description: The maximum fraction of sessions to retain, in the range `(0, 1]`.
71677+ example: 0.5
71678+ exclusiveMinimum: true
71679+ format: double
71680+ maximum: 1
71681+ minimum: 0
71682+ type: number
71683+ required:
71684+ - max_retention_rate
71685+ type: object
71686+ RumRateLimitConfigAttributes:
71687+ description: The RUM rate limit configuration properties.
71688+ properties:
71689+ adaptive:
71690+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
71691+ custom:
71692+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
71693+ mode:
71694+ $ref: "#/components/schemas/RumRateLimitMode"
71695+ org_id:
71696+ description: The ID of the organization the rate limit configuration belongs to.
71697+ example: 2
71698+ format: int64
71699+ type: integer
71700+ updated_at:
71701+ description: The date the rate limit configuration was last updated.
71702+ example: "2026-03-04T15:37:54.951447Z"
71703+ type: string
71704+ updated_by:
71705+ description: The handle of the user who last updated the rate limit configuration.
71706+ example: test@example.com
71707+ type: string
71708+ required:
71709+ - mode
71710+ - org_id
71711+ type: object
71712+ RumRateLimitConfigData:
71713+ description: The RUM rate limit configuration object.
71714+ properties:
71715+ attributes:
71716+ $ref: "#/components/schemas/RumRateLimitConfigAttributes"
71717+ id:
71718+ description: The identifier of the scope the rate limit configuration applies to.
71719+ example: cd73a516-a481-4af5-8352-9b577465c77b
71720+ type: string
71721+ type:
71722+ $ref: "#/components/schemas/RumRateLimitConfigType"
71723+ required:
71724+ - id
71725+ - type
71726+ - attributes
71727+ type: object
71728+ RumRateLimitConfigResponse:
71729+ description: The RUM rate limit configuration response.
71730+ properties:
71731+ data:
71732+ $ref: "#/components/schemas/RumRateLimitConfigData"
71733+ required:
71734+ - data
71735+ type: object
71736+ RumRateLimitConfigType:
71737+ default: rum_rate_limit_config
71738+ description: The type of the resource, always `rum_rate_limit_config`.
71739+ enum:
71740+ - rum_rate_limit_config
71741+ example: rum_rate_limit_config
71742+ type: string
71743+ x-enum-varnames: ["RUM_RATE_LIMIT_CONFIG"]
71744+ RumRateLimitConfigUpdateAttributes:
71745+ description: The RUM rate limit configuration properties to create or update.
71746+ properties:
71747+ adaptive:
71748+ $ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
71749+ custom:
71750+ $ref: "#/components/schemas/RumRateLimitCustomConfig"
71751+ mode:
71752+ $ref: "#/components/schemas/RumRateLimitMode"
71753+ required:
71754+ - mode
71755+ type: object
71756+ RumRateLimitConfigUpdateData:
71757+ description: The RUM rate limit configuration to create or update.
71758+ properties:
71759+ attributes:
71760+ $ref: "#/components/schemas/RumRateLimitConfigUpdateAttributes"
71761+ id:
71762+ description: |-
71763+ The identifier of the scope the rate limit configuration applies to.
71764+ Must match `scope_id` in the path.
71765+ example: cd73a516-a481-4af5-8352-9b577465c77b
71766+ type: string
71767+ type:
71768+ $ref: "#/components/schemas/RumRateLimitConfigType"
71769+ required:
71770+ - id
71771+ - type
71772+ - attributes
71773+ type: object
71774+ RumRateLimitConfigUpdateRequest:
71775+ description: The body of a request to create or update a RUM rate limit configuration.
71776+ properties:
71777+ data:
71778+ $ref: "#/components/schemas/RumRateLimitConfigUpdateData"
71779+ required:
71780+ - data
71781+ type: object
71782+ RumRateLimitCustomConfig:
71783+ description: The configuration used when `mode` is `custom`.
71784+ properties:
71785+ daily_reset_time:
71786+ description: The time of day when the daily quota resets, in `HH:MM` 24-hour format.
71787+ example: "08:00"
71788+ pattern: "^([01]\\d|2[0-3]):[0-5]\\d$"
71789+ type: string
71790+ daily_reset_timezone:
71791+ description: The timezone offset used for the daily reset time, in `±HH:MM` format.
71792+ example: "+09:00"
71793+ pattern: "^[+-](0\\d|1[0-4]):[0-5]\\d$"
71794+ type: string
71795+ quota_reached_action:
71796+ $ref: "#/components/schemas/RumRateLimitQuotaReachedAction"
71797+ session_limit:
71798+ description: The maximum number of sessions allowed within the window.
71799+ example: 1000000
71800+ format: int64
71801+ minimum: 1
71802+ type: integer
71803+ window_type:
71804+ $ref: "#/components/schemas/RumRateLimitWindowType"
71805+ required:
71806+ - window_type
71807+ - session_limit
71808+ - daily_reset_time
71809+ - daily_reset_timezone
71810+ - quota_reached_action
71811+ type: object
71812+ RumRateLimitMode:
71813+ description: |-
71814+ The rate limit mode. `custom` enforces a fixed session limit, while
71815+ `adaptive` dynamically adjusts retention.
71816+ enum:
71817+ - custom
71818+ - adaptive
71819+ example: custom
71820+ type: string
71821+ x-enum-varnames: ["CUSTOM", "ADAPTIVE"]
71822+ RumRateLimitQuotaReachedAction:
71823+ description: The action to take when the session quota is reached.
71824+ enum:
71825+ - stop
71826+ - slowdown
71827+ example: stop
71828+ type: string
71829+ x-enum-varnames: ["STOP", "SLOWDOWN"]
71830+ RumRateLimitScopeType:
71831+ default: application
71832+ description: The type of scope the rate limit configuration applies to.
71833+ enum:
71834+ - application
71835+ example: application
71836+ type: string
71837+ x-enum-varnames: ["APPLICATION"]
71838+ RumRateLimitWindowType:
71839+ description: The window type over which the session limit is enforced.
71840+ enum:
71841+ - daily
71842+ example: daily
71843+ type: string
71844+ x-enum-varnames: ["DAILY"]
7165571845 RumRetentionFilterAttributes:
7165671846 description: The object describing attributes of a RUM retention filter.
7165771847 properties:
@@ -147474,6 +147664,142 @@ paths:
147474147664 tags:
147475147665 - Rum Metrics
147476147666 x-codegen-request-body-name: body
147667+ /api/v2/rum/config/rate-limit/{scope_type}/{scope_id}:
147668+ delete:
147669+ description: Delete the RUM rate limit configuration for a given scope.
147670+ operationId: DeleteRumRateLimitConfig
147671+ parameters:
147672+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
147673+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
147674+ responses:
147675+ "204":
147676+ description: No Content
147677+ "400":
147678+ $ref: "#/components/responses/BadRequestResponse"
147679+ "403":
147680+ $ref: "#/components/responses/NotAuthorizedResponse"
147681+ "404":
147682+ $ref: "#/components/responses/NotFoundResponse"
147683+ "429":
147684+ $ref: "#/components/responses/TooManyRequestsResponse"
147685+ summary: Delete a RUM rate limit configuration
147686+ tags:
147687+ - Rum Rate Limit
147688+ x-unstable: |-
147689+ **Note**: This endpoint is in preview and is subject to change.
147690+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147691+ get:
147692+ description: Get the RUM rate limit configuration for a given scope.
147693+ operationId: GetRumRateLimitConfig
147694+ parameters:
147695+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
147696+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
147697+ responses:
147698+ "200":
147699+ content:
147700+ application/json:
147701+ examples:
147702+ default:
147703+ value:
147704+ data:
147705+ attributes:
147706+ custom:
147707+ daily_reset_time: "08:00"
147708+ daily_reset_timezone: "+09:00"
147709+ quota_reached_action: stop
147710+ session_limit: 1000000
147711+ window_type: daily
147712+ mode: custom
147713+ org_id: 2
147714+ updated_at: "2026-03-04T15:37:54.951447Z"
147715+ updated_by: test@example.com
147716+ id: cd73a516-a481-4af5-8352-9b577465c77b
147717+ type: rum_rate_limit_config
147718+ schema:
147719+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
147720+ description: OK
147721+ "400":
147722+ $ref: "#/components/responses/BadRequestResponse"
147723+ "403":
147724+ $ref: "#/components/responses/NotAuthorizedResponse"
147725+ "404":
147726+ $ref: "#/components/responses/NotFoundResponse"
147727+ "429":
147728+ $ref: "#/components/responses/TooManyRequestsResponse"
147729+ summary: Get a RUM rate limit configuration
147730+ tags:
147731+ - Rum Rate Limit
147732+ x-unstable: |-
147733+ **Note**: This endpoint is in preview and is subject to change.
147734+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147735+ put:
147736+ description: |-
147737+ Create or update the RUM rate limit configuration for a given scope.
147738+ Returns the rate limit configuration object when the request is successful.
147739+ operationId: UpdateRumRateLimitConfig
147740+ parameters:
147741+ - $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
147742+ - $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
147743+ requestBody:
147744+ content:
147745+ application/json:
147746+ examples:
147747+ default:
147748+ value:
147749+ data:
147750+ attributes:
147751+ custom:
147752+ daily_reset_time: "08:00"
147753+ daily_reset_timezone: "+09:00"
147754+ quota_reached_action: stop
147755+ session_limit: 1000000
147756+ window_type: daily
147757+ mode: custom
147758+ id: cd73a516-a481-4af5-8352-9b577465c77b
147759+ type: rum_rate_limit_config
147760+ schema:
147761+ $ref: "#/components/schemas/RumRateLimitConfigUpdateRequest"
147762+ description: The definition of the RUM rate limit configuration to create or update.
147763+ required: true
147764+ responses:
147765+ "200":
147766+ content:
147767+ application/json:
147768+ examples:
147769+ default:
147770+ value:
147771+ data:
147772+ attributes:
147773+ custom:
147774+ daily_reset_time: "08:00"
147775+ daily_reset_timezone: "+09:00"
147776+ quota_reached_action: stop
147777+ session_limit: 1000000
147778+ window_type: daily
147779+ mode: custom
147780+ org_id: 2
147781+ updated_at: "2026-03-04T21:52:53.526022Z"
147782+ updated_by: test@example.com
147783+ id: cd73a516-a481-4af5-8352-9b577465c77b
147784+ type: rum_rate_limit_config
147785+ schema:
147786+ $ref: "#/components/schemas/RumRateLimitConfigResponse"
147787+ description: OK
147788+ "400":
147789+ $ref: "#/components/responses/BadRequestResponse"
147790+ "403":
147791+ $ref: "#/components/responses/NotAuthorizedResponse"
147792+ "404":
147793+ $ref: "#/components/responses/NotFoundResponse"
147794+ "429":
147795+ $ref: "#/components/responses/TooManyRequestsResponse"
147796+ summary: Create or update a RUM rate limit configuration
147797+ tags:
147798+ - Rum Rate Limit
147799+ x-codegen-request-body-name: body
147800+ x-unstable: |-
147801+ **Note**: This endpoint is in preview and is subject to change.
147802+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147477147803 /api/v2/rum/events:
147478147804 get:
147479147805 description: |-
@@ -171532,6 +171858,9 @@ tags:
171532171858 description: Find out more at
171533171859 url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
171534171860 name: Rum Metrics
171861+ - description: |-
171862+ Manage RUM rate limit configurations for your organization's RUM applications.
171863+ name: Rum Rate Limit
171535171864 - description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.
171536171865 name: Rum Replay Heatmaps
171537171866 - description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration.
0 commit comments