Amazon Web Services, Inc.

CloudWatch RUM

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use. You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.

Endpoints 20

App monitor

  • GETBatch get rum metric definitions/rummetrics/:AppMonitorName/metrics?destination=string&destinationArn=string&maxResults=0&nextToken=stringRetrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
  • POSTBatch create rum metric definitions/rummetrics/:AppMonitorName/metricsSpecifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch…
  • DELETEBatch delete rum metric definitions/rummetrics/:AppMonitorName/metrics?destination=string&destinationArn=string&metricDefinitionIds=Removes the specified metrics from being sent to an extended metrics destination. If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions…
  • PATCHUpdate rum metric definition/rummetrics/:AppMonitorName/metricsModifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions .
  • POSTCreate app monitor/appmonitorCreates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and…
  • GETGet app monitor/appmonitor/:NameRetrieves the complete configuration information for one app monitor.
  • DELETEDelete app monitor/appmonitor/:NameDeletes an existing app monitor. This immediately stops the collection of data.
  • PATCHUpdate app monitor/appmonitor/:NameUpdates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this…
  • GETGet resource policy/appmonitor/:Name/policyUse this operation to retrieve information about a resource-based policy that is attached to an app monitor.
  • PUTPut resource policy/appmonitor/:Name/policyUse this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based…
  • DELETEDelete resource policy/appmonitor/:Name/policy?policyRevisionId=stringRemoves the association of a resource-based policy from an app monitor.
  • GETList rum metrics destinations/rummetrics/:AppMonitorName/metricsdestination?maxResults=0&nextToken=stringReturns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. For more information about extended…
  • POSTPut rum metrics destination/rummetrics/:AppMonitorName/metricsdestinationCreates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently…
  • DELETEDelete rum metrics destination/rummetrics/:AppMonitorName/metricsdestination?destination=string&destinationArn=stringDeletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
  • POSTGet app monitor data/appmonitor/:Name/dataRetrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.
  • POSTList app monitors/appmonitors?maxResults=0&nextToken=stringReturns a list of the Amazon CloudWatch RUM app monitors in the account.
  • GETList tags for resource/tags/:ResourceArnDisplays the tags associated with a CloudWatch RUM resource.
  • POSTTag resource/tags/:ResourceArnAssigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors. Tags can…
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes one or more tags from the specified resource.
  • POSTPut rum events/appmonitors/:Id/Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your…

API details

Base URL
https://rum.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
20 operations on 9 pathsPOST 7GET 5DELETE 5PATCH 2PUT 1
Main resources
App monitor 16
Description format
AWS Smithy model, API version 2018-05-10

How to test the CloudWatch RUM in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CloudWatch RUM collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Batch get rum metric definitions” (GET /rummetrics/:AppMonitorName/metrics?destination=string&destinationArn=string&maxResults=0&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CloudWatch RUM?

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions… It is listed under Developer tools and has 20 endpoints.

Who publishes the CloudWatch RUM?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the CloudWatch RUM?

Requests go to https://rum.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the CloudWatch RUM?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the CloudWatch RUM have?

20 operations on 9 paths (7 POST, 5 GET, 5 DELETE, 2 PATCH, 1 PUT). The largest groups are App monitor.

Is forking the CloudWatch RUM free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.