Language

한국어 English Français 日本語 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED
이 페이지는 아직 한국어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

Rum Replay Heatmaps

Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.

Create replay heatmap snapshot

POST https://api.ap1.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.ap2.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.datadoghq.eu/api/v2/replay/heatmap/snapshotshttps://api.ddog-gov.com/api/v2/replay/heatmap/snapshotshttps://api.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.us3.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots

개요

Create a heatmap snapshot.

요청

Body Data (required)

Expand All

항목

유형

설명

data [required]

object

attributes

object

application_id [required]

string

device_type [required]

string

event_id [required]

string

is_device_type_selected_by_user [required]

boolean

session_id

string

snapshot_name [required]

string

start [required]

int64

view_id

string

view_name [required]

string

type [required]

enum

Snapshots resource type. Allowed enum values: snapshots

default: snapshots

{
  "data": {
    "attributes": {
      "application_id": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
      "device_type": "desktop",
      "event_id": "11111111-2222-3333-4444-555555555555",
      "is_device_type_selected_by_user": false,
      "session_id": "string",
      "snapshot_name": "My Snapshot",
      "start": 0,
      "view_id": "string",
      "view_name": "/home"
    },
    "type": "snapshots"
  }
}

응답

Created

Expand All

항목

유형

설명

data

object

attributes

object

application_id

string

created_at

date-time

created_by

string

created_by_handle

string

created_by_user_id

int64

device_type

string

event_id

string

is_device_type_selected_by_user

boolean

modified_at

date-time

org_id

int64

session_id

string

snapshot_name

string

start

int64

view_id

string

view_name

string

id

string

type [required]

enum

Snapshots resource type. Allowed enum values: snapshots

default: snapshots

{
  "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"
  }
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots" \
-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": {
      "application_id": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
      "device_type": "desktop",
      "event_id": "11111111-2222-3333-4444-555555555555",
      "is_device_type_selected_by_user": false,
      "snapshot_name": "My Snapshot",
      "start": 0,
      "view_name": "/home"
    },
    "type": "snapshots"
  }
}
EOF

List replay heatmap snapshots

GET https://api.ap1.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.ap2.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.datadoghq.eu/api/v2/replay/heatmap/snapshotshttps://api.ddog-gov.com/api/v2/replay/heatmap/snapshotshttps://api.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.us3.datadoghq.com/api/v2/replay/heatmap/snapshotshttps://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots

개요

List heatmap snapshots.

인수

쿼리 문자열

이름

유형

설명

filter[device_type]

string

Device type to filter snapshots.

filter[view_name] [required]

string

View name to filter snapshots.

page[limit]

integer

Maximum number of snapshots to return.

filter[application_id]

string

Filter by application ID.

응답

OK

Expand All

항목

유형

설명

data [required]

[object]

attributes

object

application_id

string

created_at

date-time

created_by

string

created_by_handle

string

created_by_user_id

int64

device_type

string

event_id

string

is_device_type_selected_by_user

boolean

modified_at

date-time

org_id

int64

session_id

string

snapshot_name

string

start

int64

view_id

string

view_name

string

id

string

type [required]

enum

Snapshots resource type. Allowed enum values: snapshots

default: snapshots

{
  "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"
    }
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Required query arguments
export filter[view_name]="/home"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots?filter[view_name]=${filter[view_name]}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Update replay heatmap snapshot

PATCH https://api.ap1.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.ap2.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.datadoghq.eu/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.ddog-gov.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.us3.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}

개요

Update a heatmap snapshot.

인수

경로 파라미터

이름

유형

설명

snapshot_id [required]

string

Unique identifier of the heatmap snapshot.

요청

Body Data (required)

Expand All

항목

유형

설명

data [required]

object

attributes

object

event_id [required]

string

is_device_type_selected_by_user [required]

boolean

session_id

string

start [required]

int64

view_id

string

id

string

type [required]

enum

Snapshots resource type. Allowed enum values: snapshots

default: snapshots

{
  "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"
  }
}

응답

OK

Expand All

항목

유형

설명

data

object

attributes

object

application_id

string

created_at

date-time

created_by

string

created_by_handle

string

created_by_user_id

int64

device_type

string

event_id

string

is_device_type_selected_by_user

boolean

modified_at

date-time

org_id

int64

session_id

string

snapshot_name

string

start

int64

view_id

string

view_name

string

id

string

type [required]

enum

Snapshots resource type. Allowed enum values: snapshots

default: snapshots

{
  "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"
  }
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Path parameters
export snapshot_id="00000000-0000-0000-0000-000000000001"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.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
    },
    "type": "snapshots"
  }
}
EOF

Delete replay heatmap snapshot

DELETE https://api.ap1.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.ap2.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.datadoghq.eu/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.ddog-gov.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.us3.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}https://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots/{snapshot_id}

개요

Delete a heatmap snapshot.

인수

경로 파라미터

이름

유형

설명

snapshot_id [required]

string

Unique identifier of the heatmap snapshot.

응답

No Content

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Path parameters
export snapshot_id="00000000-0000-0000-0000-000000000001"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/replay/heatmap/snapshots/${snapshot_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"