v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBWidgets
Get a widget
Retrieve a widget by its UUID for a given experience type.
get/api/v2/widgets/{experience_type}/{uuid}
Path parameters
experience_type'ccm_reports' | 'logs_reports' | 'csv_reports' | 'product_analytics' required
Widget experience types that differentiate between the products using the specific widget.
Example:ccm_reports
The experience type for the widget.
uuidstring uuid required
The UUID of the widget.
Response
OK
Example response
{
"data": {
"attributes": {
"created_at": "2024-01-15T00:00:00.000Z",
"definition": {
"title": "My Widget",
"type": "bar_chart"
},
"modified_at": "2024-01-15T00:00:00.000Z",
"tags": [
"team:my-team"
]
},
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"relationships": {
"created_by": {
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "users"
}
},
"modified_by": {
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "users"
}
}
},
"type": "widgets"
},
"included": [
{
"attributes": {
"handle": "john.doe@example.com",
"name": "John Doe"
},
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "users"
}
]
}