--- title: Update replay heatmap snapshot description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Rum Replay Heatmaps --- # Update replay heatmap snapshot{% #update-replay-heatmap-snapshot %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------- | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/replay/heatmap/snapshots/{snapshot_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id} | ### Overview Update a heatmap snapshot. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------------- | ------ | ------------------------------------------ | | snapshot_id [*required*] | string | Unique identifier of the heatmap snapshot. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. | | data | attributes | object | Attributes for updating a heatmap snapshot, including event, session, and view context. | | attributes | event_id [*required*] | string | Unique identifier of the RUM event associated with the snapshot. | | attributes | is_device_type_selected_by_user [*required*] | boolean | Indicates whether the device type was explicitly selected by the user rather than auto-detected. | | attributes | session_id | string | Unique identifier of the RUM session associated with the snapshot. | | attributes | start [*required*] | int64 | Offset in milliseconds from the start of the session at which the snapshot was captured. | | attributes | view_id | string | Unique identifier of the RUM view associated with the snapshot. | | data | id | string | Unique identifier of the heatmap snapshot to update. | | data | type [*required*] | enum | Snapshots resource type. Allowed enum values: `snapshots` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "event_id": "11111111-2222-3333-4444-555555555555", "is_device_type_selected_by_user": false, "session_id": "string", "start": 0, "view_id": "string" }, "id": "00000000-0000-0000-0000-000000000001", "type": "snapshots" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} A single heatmap snapshot resource returned by create or update operations. | Parent field | Field | Type | Description | | ------------ | ------------------------------- | --------- | ------------------------------------------------------------------------------------------------- | | | data | object | Data object representing a heatmap snapshot, including its identifier, type, and attributes. | | data | attributes | object | Attributes of a heatmap snapshot, including view context, device information, and audit metadata. | | attributes | application_id | string | Unique identifier of the RUM application. | | attributes | created_at | date-time | Timestamp when the snapshot was created. | | attributes | created_by | string | Display name of the user who created the snapshot. | | attributes | created_by_handle | string | Email handle of the user who created the snapshot. | | attributes | created_by_user_id | int64 | Numeric identifier of the user who created the snapshot. | | attributes | device_type | string | Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). | | attributes | event_id | string | Unique identifier of the RUM event associated with the snapshot. | | attributes | is_device_type_selected_by_user | boolean | Indicates whether the device type was explicitly selected by the user rather than auto-detected. | | attributes | modified_at | date-time | Timestamp when the snapshot was last modified. | | attributes | org_id | int64 | Numeric identifier of the organization that owns the snapshot. | | attributes | session_id | string | Unique identifier of the RUM session associated with the snapshot. | | attributes | snapshot_name | string | Human-readable name for the snapshot. | | attributes | start | int64 | Offset in milliseconds from the start of the session at which the snapshot was captured. | | attributes | view_id | string | Unique identifier of the RUM view associated with the snapshot. | | attributes | view_name | string | URL path or name of the view where the snapshot was captured. | | data | id | string | Unique identifier of the heatmap snapshot. | | data | type [*required*] | enum | Snapshots resource type. Allowed enum values: `snapshots` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "application_id": "string", "created_at": "2019-09-19T10:00:00.000Z", "created_by": "string", "created_by_handle": "string", "created_by_user_id": "integer", "device_type": "string", "event_id": "string", "is_device_type_selected_by_user": false, "modified_at": "2019-09-19T10:00:00.000Z", "org_id": "integer", "session_id": "string", "snapshot_name": "string", "start": "integer", "view_id": "string", "view_name": "string" }, "id": "string", "type": "snapshots" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export snapshot_id="00000000-0000-0000-0000-000000000001" \# Curl command curl -X PATCH "https://api.datadoghq.com/api/v2/replay/heatmap/snapshots/${snapshot_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "event_id": "11111111-2222-3333-4444-555555555555", "is_device_type_selected_by_user": false, "start": 0 }, "id": "00000000-0000-0000-0000-000000000001", "type": "snapshots" } } EOF ##### ```python """ Update replay heatmap snapshot returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_replay_heatmaps_api import RumReplayHeatmapsApi from datadog_api_client.v2.model.snapshot_update_request import SnapshotUpdateRequest from datadog_api_client.v2.model.snapshot_update_request_data import SnapshotUpdateRequestData from datadog_api_client.v2.model.snapshot_update_request_data_attributes import SnapshotUpdateRequestDataAttributes from datadog_api_client.v2.model.snapshot_update_request_data_type import SnapshotUpdateRequestDataType body = SnapshotUpdateRequest( data=SnapshotUpdateRequestData( attributes=SnapshotUpdateRequestDataAttributes( event_id="11111111-2222-3333-4444-555555555555", is_device_type_selected_by_user=False, start=0, ), id="00000000-0000-0000-0000-000000000001", type=SnapshotUpdateRequestDataType.SNAPSHOTS, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = RumReplayHeatmapsApi(api_client) response = api_instance.update_replay_heatmap_snapshot( snapshot_id="00000000-0000-0000-0000-000000000001", body=body ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Update replay heatmap snapshot returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::RumReplayHeatmapsAPI.new body = DatadogAPIClient::V2::SnapshotUpdateRequest.new({ data: DatadogAPIClient::V2::SnapshotUpdateRequestData.new({ attributes: DatadogAPIClient::V2::SnapshotUpdateRequestDataAttributes.new({ event_id: "11111111-2222-3333-4444-555555555555", is_device_type_selected_by_user: false, start: 0, }), id: "00000000-0000-0000-0000-000000000001", type: DatadogAPIClient::V2::SnapshotUpdateRequestDataType::SNAPSHOTS, }), }) p api_instance.update_replay_heatmap_snapshot("00000000-0000-0000-0000-000000000001", body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Update replay heatmap snapshot returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.SnapshotUpdateRequest{ Data: datadogV2.SnapshotUpdateRequestData{ Attributes: &datadogV2.SnapshotUpdateRequestDataAttributes{ EventId: "11111111-2222-3333-4444-555555555555", IsDeviceTypeSelectedByUser: false, Start: 0, }, Id: datadog.PtrString("00000000-0000-0000-0000-000000000001"), Type: datadogV2.SNAPSHOTUPDATEREQUESTDATATYPE_SNAPSHOTS, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumReplayHeatmapsApi(apiClient) resp, r, err := api.UpdateReplayHeatmapSnapshot(ctx, "00000000-0000-0000-0000-000000000001", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumReplayHeatmapsApi.UpdateReplayHeatmapSnapshot`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumReplayHeatmapsApi.UpdateReplayHeatmapSnapshot`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Update replay heatmap snapshot returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumReplayHeatmapsApi; import com.datadog.api.client.v2.model.Snapshot; import com.datadog.api.client.v2.model.SnapshotUpdateRequest; import com.datadog.api.client.v2.model.SnapshotUpdateRequestData; import com.datadog.api.client.v2.model.SnapshotUpdateRequestDataAttributes; import com.datadog.api.client.v2.model.SnapshotUpdateRequestDataType; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); RumReplayHeatmapsApi apiInstance = new RumReplayHeatmapsApi(defaultClient); SnapshotUpdateRequest body = new SnapshotUpdateRequest() .data( new SnapshotUpdateRequestData() .attributes( new SnapshotUpdateRequestDataAttributes() .eventId("11111111-2222-3333-4444-555555555555") .isDeviceTypeSelectedByUser(false) .start(0L)) .id("00000000-0000-0000-0000-000000000001") .type(SnapshotUpdateRequestDataType.SNAPSHOTS)); try { Snapshot result = apiInstance.updateReplayHeatmapSnapshot("00000000-0000-0000-0000-000000000001", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumReplayHeatmapsApi#updateReplayHeatmapSnapshot"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Update replay heatmap snapshot returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_replay_heatmaps::RumReplayHeatmapsAPI; use datadog_api_client::datadogV2::model::SnapshotUpdateRequest; use datadog_api_client::datadogV2::model::SnapshotUpdateRequestData; use datadog_api_client::datadogV2::model::SnapshotUpdateRequestDataAttributes; use datadog_api_client::datadogV2::model::SnapshotUpdateRequestDataType; #[tokio::main] async fn main() { let body = SnapshotUpdateRequest::new( SnapshotUpdateRequestData::new(SnapshotUpdateRequestDataType::SNAPSHOTS) .attributes(SnapshotUpdateRequestDataAttributes::new( "11111111-2222-3333-4444-555555555555".to_string(), false, 0, )) .id("00000000-0000-0000-0000-000000000001".to_string()), ); let configuration = datadog::Configuration::new(); let api = RumReplayHeatmapsAPI::with_config(configuration); let resp = api .update_replay_heatmap_snapshot("00000000-0000-0000-0000-000000000001".to_string(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Update replay heatmap snapshot returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.RumReplayHeatmapsApi(configuration); const params: v2.RumReplayHeatmapsApiUpdateReplayHeatmapSnapshotRequest = { body: { data: { attributes: { eventId: "11111111-2222-3333-4444-555555555555", isDeviceTypeSelectedByUser: false, start: 0, }, id: "00000000-0000-0000-0000-000000000001", type: "snapshots", }, }, snapshotId: "00000000-0000-0000-0000-000000000001", }; apiInstance .updateReplayHeatmapSnapshot(params) .then((data: v2.Snapshot) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}