get_ui_annotations
Retrieve UI annotation data (heatmaps, click data) for a study, ideal for prototype and concept testing. First verify analytics generation via get_analytics_status.
Instructions
Get UI annotation data (heatmaps, click data) for a study.
Most relevant for studies with prototype or conceptTesting sections — these capture click interactions that appear as heatmaps and misclick data. For voice interview sections, this data may be sparse or empty.
⚠️ PREREQUISITE: Analytics must be generated first. Call get_analytics_status — if components are missing, call generate_analytics and wait for completion.
Args: study_id: The unique identifier of the study.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"study_id": "<study_id>"
},
"name": "get_ui_annotations"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| study_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |