How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog Rum API

Manage your Real User Monitoring (RUM) applications, and search or aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/) for more information

Datadog Rum API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include RUM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.

This API exposes 14 operations across 8 paths, and defines 75 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

14 operations 8 paths 75 schemas 2 DELETE5 GET3 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog Rum API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes. An API key is passed in the header as DD-API-KEY (apiKeyAuth). An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • AuthZ — This API uses OAuth 2 with the implicit grant flow.
  • apiKeyAuth — Your Datadog API Key.
  • appKeyAuth — Your Datadog APP Key.

Paths & Operations 14

Across 8 paths, the API surfaces 14 operations — 2 DELETE, 5 GET, 3 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Rum 14

Manage your Real User Monitoring (RUM) applications, and search or aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/realusermoni…

POST
/api/v2/rum/analytics/aggregate
Datadog Aggregate Rum Events
AggregateRUMEvents body → 200400403429
GET
/api/v2/rum/applications
Datadog List All the Rum Applications
GetRUMApplications → 200404429
POST
/api/v2/rum/applications
Datadog Create a New Rum Application
CreateRUMApplication body → 200400429
PATCH
/api/v2/rum/applications/{app_id}/relationships/retention_filters
Datadog Order Rum Retention Filters
OrderRetentionFilters 1 param body → 200400403429
GET
/api/v2/rum/applications/{app_id}/retention_filters
Datadog Get All Rum Retention Filters
ListRetentionFilters 1 param → 200403429
POST
/api/v2/rum/applications/{app_id}/retention_filters
Datadog Create a Rum Retention Filter
CreateRetentionFilter 1 param body → 201400403429
DELETE
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Datadog Delete a Rum Retention Filter
DeleteRetentionFilter 2 params → 204403404429
GET
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Datadog Get a Rum Retention Filter
GetRetentionFilter 2 params → 200403404429
PATCH
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Datadog Update a Rum Retention Filter
UpdateRetentionFilter 2 params body → 200400403404429
DELETE
/api/v2/rum/applications/{id}
Datadog Delete a Rum Application
DeleteRUMApplication 1 param → 204404429
GET
/api/v2/rum/applications/{id}
Datadog Get a Rum Application
GetRUMApplication 1 param → 200404429
PATCH
/api/v2/rum/applications/{id}
Datadog Update a Rum Application
UpdateRUMApplication 1 param body → 200400404422429
GET
/api/v2/rum/events
Datadog Get a List of Rum Events
ListRUMEvents 6 params → 200400403429
POST
/api/v2/rum/events/search
Datadog Search Rum Events
SearchRUMEvents body → 200400403429

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are RUMApplicationAttributes (11 properties), RUMApplicationListAttributes (10 properties), RUMGroupBy (6 properties), RUMResponseMetadata (5 properties). Each schema is shown below with its type and property counts.

RUMApplicationUpdateRequest
object
RUM application update request.
1 property 1 required
RUMResponseStatus
string
The status of the response.
RUMEventAttributes
object
JSON object containing all event attributes and their associated values.
4 properties
RUMApplicationUpdate
object
RUM application update.
3 properties 2 required
RUMApplicationListType
string
RUM application list type.
RUMApplicationCreateRequest
object
RUM application creation request attributes.
1 property 1 required
RUMApplicationUpdateType
string
RUM application update type.
RUMAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of RUM events from your organization.
5 properties
RUMGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
RUMAggregateBucketValueTimeseries
array
A timeseries array.
RUMGroupByTotalNumber
number
A number to use as the key value for the total bucket.
RUMResponseMetadata
object
The metadata associated with a request.
5 properties
RUMAggregateBucketValueSingleString
string
A single string value.
RumRetentionFilterAttributes
object
The object describing attributes of a RUM retention filter.
5 properties
RUMApplicationCreateAttributes
object
RUM application creation attributes.
2 properties 1 required
RUMGroupByTotal
A resulting object to put the given computes in over all the matching records.
RUMSearchEventsRequest
object
The request for a RUM events list.
4 properties
RUMQueryFilter
object
The search and filter query settings.
3 properties
RUMApplicationsResponse
object
RUM applications response.
1 property
RUMQueryPageOptions
object
Paging attributes for listing events.
2 properties
RumRetentionFiltersOrderData
object
The RUM retention filter data for ordering.
2 properties 2 required
RUMAnalyticsAggregateResponse
object
The response object for the RUM events aggregate API endpoint.
3 properties
RUMApplicationResponse
object
RUM application response.
1 property
RUMAggregateBucketValue
A bucket value, can be either a timeseries or a single value.
RUMQueryOptions
object
Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
2 properties
RUMEvent
object
Object description of a RUM event after being processed and stored by Datadog.
3 properties
RUMGroupByTotalString
string
A string to use as the key value for the total bucket.
RUMAggregationBucketsResponse
object
The query results.
1 property
RUMAggregateSort
object
A sort rule.
4 properties
RUMApplicationCreateType
string
RUM application creation type.
RUMApplicationType
string
RUM application response type.
RumRetentionFiltersResponse
object
All RUM retention filters for a RUM application.
1 property
RumRetentionFilterResponse
object
The RUM retention filter object.
1 property
RUMApplicationList
object
RUM application list.
3 properties 2 required
RumRetentionFilterType
string
The type of the resource. The value should always be retentionfilters.
RumRetentionFiltersOrderResponse
object
The list of RUM retention filter IDs along with type.
1 property
RUMBucketResponse
object
Bucket values.
2 properties
RumRetentionFilterQuery
string
The query string for a RUM retention filter.
APIErrorResponse
object
API error response.
1 property 1 required
RumRetentionFilterCreateRequest
object
The RUM retention filter body to create.
1 property 1 required
RUMGroupByMissingString
string
The missing value to use if there is string valued facet.
RumRetentionFilterEventType
string
The type of RUM events to filter on.
RUMEventType
string
Type of the event.
RUMGroupByMissing
The value to use for logs that don't have the facet used to group by.
RumRetentionFilterSampleRate
integer
The sample rate for a RUM retention filter, between 0 and 100.
RUMApplicationUpdateAttributes
object
RUM application update attributes.
2 properties
RunRetentionFilterName
string
The name of a RUM retention filter.
RumRetentionFilterID
string
ID of retention filter in UUID.
RUMAggregateSortType
string
The type of sorting algorithm.
RumRetentionFilterUpdateRequest
object
The RUM retention filter body to update.
1 property 1 required
RUMGroupBy
object
A group-by rule.
6 properties 1 required
RUMSort
string
Sort parameters when querying events.
RumRetentionFilterUpdateData
object
The new RUM retention filter properties to update.
3 properties 3 required
RUMComputeType
string
The type of compute.
RUMSortOrder
string
The order to use, ascending or descending.
RUMResponseLinks
object
Links attributes.
1 property
RumRetentionFilterEnabled
boolean
Whether the retention filter is enabled.
RUMApplication
object
RUM application.
3 properties 3 required
RUMApplicationAttributes
object
RUM application attributes.
11 properties 9 required
RUMAggregateBucketValueSingleNumber
number
A single number value.
RumRetentionFilterUpdateAttributes
object
The object describing attributes of a RUM retention filter to update.
5 properties
RUMApplicationCreate
object
RUM application creation.
2 properties 2 required
RumRetentionFilterCreateData
object
The new RUM retention filter properties to create.
2 properties 2 required
RUMApplicationListAttributes
object
RUM application list attributes.
10 properties 8 required
RumRetentionFiltersOrderRequest
object
The list of RUM retention filter IDs along with their corresponding type to reorder. All retention filter IDs should be included in the list created for a RUM…
1 property
RUMEventsResponse
object
Response object with all events matching the request and pagination information.
3 properties
RUMAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
RumRetentionFilterData
object
The RUM retention filter.
3 properties
RUMWarning
object
A warning message indicating something that went wrong with the query.
3 properties
RUMResponsePage
object
Paging attributes.
1 property
RUMAggregationFunction
string
An aggregation function.
RUMGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties 3 required
RumRetentionFilterCreateAttributes
object
The object describing attributes of a RUM retention filter to create.
5 properties 3 required
RUMGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
RUMCompute
object
A compute rule to compute metrics or timeseries.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-rum-api-openapi.yml Raw ↑

Other APIs Datadog publishes across the network.

Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog APM Retention Filters API
Where this information came from

This is an independent, third-party profile of Datadog Rum API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.