Skip to content

Commit bee901e

Browse files
ysyneuysyneu
committed
docs(api): document RUM application links
1 parent f0fcf0d commit bee901e

4 files changed

Lines changed: 732 additions & 32 deletions

File tree

‎api-reference/openapi.en.json‎

Lines changed: 183 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15679,7 +15679,24 @@
1567915679
"created_by": 4441703362131,
1568015680
"updated_by": 3790925372131,
1568115681
"created_at": 1746673831462,
15682-
"updated_at": 1773398630657
15682+
"updated_at": 1773398630657,
15683+
"links": {
15684+
"enabled": true,
15685+
"systems": [
15686+
{
15687+
"id": "s3-crash-logs",
15688+
"name": "S3 Crash Logs",
15689+
"icon_text": "S3",
15690+
"icon_color": "#0F766E",
15691+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
15692+
"event_types": [
15693+
"crash",
15694+
"error"
15695+
],
15696+
"enabled": true
15697+
}
15698+
]
15699+
}
1568315700
},
1568415701
{
1568515702
"account_id": 2451002751131,
@@ -15708,7 +15725,11 @@
1570815725
"created_by": 2476444212131,
1570915726
"updated_by": 3122470302131,
1571015727
"created_at": 1742958482000,
15711-
"updated_at": 1772096392711
15728+
"updated_at": 1772096392711,
15729+
"links": {
15730+
"enabled": false,
15731+
"systems": []
15732+
}
1571215733
}
1571315734
]
1571415735
}
@@ -15810,7 +15831,24 @@
1581015831
"created_by": 4441703362131,
1581115832
"updated_by": 3790925372131,
1581215833
"created_at": 1746673831462,
15813-
"updated_at": 1773398630657
15834+
"updated_at": 1773398630657,
15835+
"links": {
15836+
"enabled": true,
15837+
"systems": [
15838+
{
15839+
"id": "s3-crash-logs",
15840+
"name": "S3 Crash Logs",
15841+
"icon_text": "S3",
15842+
"icon_color": "#0F766E",
15843+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
15844+
"event_types": [
15845+
"crash",
15846+
"error"
15847+
],
15848+
"enabled": true
15849+
}
15850+
]
15851+
}
1581415852
}
1581515853
}
1581615854
}
@@ -15910,7 +15948,11 @@
1591015948
"created_by": 2476444212131,
1591115949
"updated_by": 3122470302131,
1591215950
"created_at": 1742958482000,
15913-
"updated_at": 1772096392711
15951+
"updated_at": 1772096392711,
15952+
"links": {
15953+
"enabled": false,
15954+
"systems": []
15955+
}
1591415956
},
1591515957
{
1591615958
"account_id": 2451002751131,
@@ -15938,7 +15980,24 @@
1593815980
"created_by": 4441703362131,
1593915981
"updated_by": 3790925372131,
1594015982
"created_at": 1746673831462,
15941-
"updated_at": 1773398630657
15983+
"updated_at": 1773398630657,
15984+
"links": {
15985+
"enabled": true,
15986+
"systems": [
15987+
{
15988+
"id": "s3-crash-logs",
15989+
"name": "S3 Crash Logs",
15990+
"icon_text": "S3",
15991+
"icon_color": "#0F766E",
15992+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
15993+
"event_types": [
15994+
"crash",
15995+
"error"
15996+
],
15997+
"enabled": true
15998+
}
15999+
]
16000+
}
1594216001
}
1594316002
]
1594416003
}
@@ -15986,7 +16045,7 @@
1598616045
"RUM/Applications"
1598716046
],
1598816047
"x-mint": {
15989-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- `type` must be one of: `browser`, `ios`, `android`, `react-native`, `flutter`, `kotlin-multiplatform`, `roku`, `unity`.\n- `client_token` is auto-generated and used to initialize the RUM SDK.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
16048+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- `type` must be one of: `browser`, `ios`, `android`, `react-native`, `flutter`, `kotlin-multiplatform`, `roku`, `unity`.\n- `client_token` is auto-generated and used to initialize the RUM SDK.\n- `links.systems[].url` must start with `http` or `https`; `${var}` tokens are resolved from RUM event context.\n- `links.systems[].event_types` accepts: `crash`, `error`, `view`, `action`, `resource`, `session`, `all`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
1599016049
"href": "/en/api-reference/rum/applications/rum-application-write-create",
1599116050
"metadata": {
1599216051
"sidebarTitle": "Create application"
@@ -16047,7 +16106,24 @@
1604716106
"application_name": "My Web App",
1604816107
"type": "browser",
1604916108
"team_id": 2477033058131,
16050-
"is_private": false
16109+
"is_private": false,
16110+
"links": {
16111+
"enabled": true,
16112+
"systems": [
16113+
{
16114+
"id": "s3-crash-logs",
16115+
"name": "S3 Crash Logs",
16116+
"icon_text": "S3",
16117+
"icon_color": "#0F766E",
16118+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
16119+
"event_types": [
16120+
"crash",
16121+
"error"
16122+
],
16123+
"enabled": true
16124+
}
16125+
]
16126+
}
1605116127
}
1605216128
}
1605316129
}
@@ -16063,7 +16139,7 @@
1606316139
"RUM/Applications"
1606416140
],
1606516141
"x-mint": {
16066-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
16142+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- `links.systems[].url` must start with `http` or `https`; `${var}` tokens are resolved from RUM event context.\n- `links.systems[].event_types` accepts: `crash`, `error`, `view`, `action`, `resource`, `session`, `all`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
1606716143
"href": "/en/api-reference/rum/applications/rum-application-write-update",
1606816144
"metadata": {
1606916145
"sidebarTitle": "Update application"
@@ -16124,6 +16200,23 @@
1612416200
"channel_ids": [
1612516201
2490121812131
1612616202
]
16203+
},
16204+
"links": {
16205+
"enabled": true,
16206+
"systems": [
16207+
{
16208+
"id": "s3-crash-logs",
16209+
"name": "S3 Crash Logs",
16210+
"icon_text": "S3",
16211+
"icon_color": "#0F766E",
16212+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
16213+
"event_types": [
16214+
"crash",
16215+
"error"
16216+
],
16217+
"enabled": true
16218+
}
16219+
]
1612716220
}
1612816221
}
1612916222
}
@@ -38582,6 +38675,79 @@
3858238675
}
3858338676
}
3858438677
},
38678+
"RumApplicationLink": {
38679+
"type": "object",
38680+
"description": "External system link rendered on matching RUM event detail pages.",
38681+
"required": [
38682+
"name",
38683+
"url",
38684+
"event_types"
38685+
],
38686+
"properties": {
38687+
"id": {
38688+
"type": "string",
38689+
"description": "Stable client-side identifier for this external system."
38690+
},
38691+
"name": {
38692+
"type": "string",
38693+
"description": "Display name of the external system."
38694+
},
38695+
"icon_text": {
38696+
"type": "string",
38697+
"description": "Short text shown in the link icon."
38698+
},
38699+
"icon_color": {
38700+
"type": "string",
38701+
"description": "Display color for the link icon."
38702+
},
38703+
"url": {
38704+
"type": "string",
38705+
"format": "uri",
38706+
"description": "HTTP or HTTPS URL template. `${var}` tokens are resolved from the RUM event context."
38707+
},
38708+
"event_types": {
38709+
"type": "array",
38710+
"minItems": 1,
38711+
"items": {
38712+
"type": "string",
38713+
"enum": [
38714+
"crash",
38715+
"error",
38716+
"view",
38717+
"action",
38718+
"resource",
38719+
"session",
38720+
"all"
38721+
]
38722+
},
38723+
"description": "RUM event types where this external system link is shown."
38724+
},
38725+
"enabled": {
38726+
"type": "boolean",
38727+
"description": "Whether this external system link is enabled."
38728+
}
38729+
}
38730+
},
38731+
"RumApplicationLinks": {
38732+
"type": "object",
38733+
"description": "External link integration settings for the application.",
38734+
"properties": {
38735+
"enabled": {
38736+
"type": "boolean",
38737+
"description": "Whether external link integration is enabled."
38738+
},
38739+
"systems": {
38740+
"type": [
38741+
"array",
38742+
"null"
38743+
],
38744+
"items": {
38745+
"$ref": "#/components/schemas/RumApplicationLink"
38746+
},
38747+
"description": "External systems whose URL templates can be opened from matching RUM events."
38748+
}
38749+
}
38750+
},
3858538751
"RumApplicationTracing": {
3858638752
"type": "object",
3858738753
"description": "APM tracing integration settings.",
@@ -38662,6 +38828,9 @@
3866238828
"tracing": {
3866338829
"$ref": "#/components/schemas/RumApplicationTracing"
3866438830
},
38831+
"links": {
38832+
"$ref": "#/components/schemas/RumApplicationLinks"
38833+
},
3866538834
"status": {
3866638835
"type": "string",
3866738836
"enum": [
@@ -38801,6 +38970,9 @@
3880138970
},
3880238971
"tracing": {
3880338972
"$ref": "#/components/schemas/RumApplicationTracing"
38973+
},
38974+
"links": {
38975+
"$ref": "#/components/schemas/RumApplicationLinks"
3880438976
}
3880538977
}
3880638978
},
@@ -38886,6 +39058,9 @@
3888639058
},
3888739059
"tracing": {
3888839060
"$ref": "#/components/schemas/RumApplicationTracing"
39061+
},
39062+
"links": {
39063+
"$ref": "#/components/schemas/RumApplicationLinks"
3888939064
}
3889039065
}
3889139066
},

0 commit comments

Comments
 (0)