Read data, create studies, and automate your UX research workflow. Full REST API with JSON and Markdown responses.
Read and write endpoints with JSON and Markdown responses. AI agents can read study reports and create studies programmatically.
Bearer token authentication scoped to a single workspace. Keys are encrypted at rest and revocable instantly.
JSON by default. Send Accept: text/markdown to get structured Markdown instead. Perfect for LLMs.
Card sorts, tree tests, surveys, first click, five second, preference, prototype, live website, and interviews.
Create, update, and delete studies. Publish drafts, end studies, duplicate, and manage participants via API.
Authenticate with a Bearer token to read data and manage studies.
# List all published studies curl https://app.uxmetrics.com/api/v1/studies?status=published \ -H "Authorization: Bearer uxm_v1_your_key_here" # Get a study report as Markdown (for AI agents) curl https://app.uxmetrics.com/api/v1/studies/std_42/report.md \ -H "Authorization: Bearer uxm_v1_your_key_here" # Create a new card sort study curl -X POST https://app.uxmetrics.com/api/v1/studies?type=card_sort \ -H "Authorization: Bearer uxm_v1_your_key_here" \ -H "Content-Type: application/json" \ -d '{"study": {"name": "Navigation Card Sort", "sort_type": "open"}}' # Publish the study curl -X POST https://app.uxmetrics.com/api/v1/studies/std_42/publish \ -H "Authorization: Bearer uxm_v1_your_key_here"
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/workspace | Current workspace details |
| GET | /api/v1/folders | List folders |
| GET | /api/v1/folders/:id | Folder detail |
| GET | /api/v1/studies | List studies (filter by type, status, folder) |
| GET | /api/v1/studies/:id | Study detail with type-specific data |
| GET | /api/v1/studies/:id/metrics | Metrics only (lightweight) |
| GET | /api/v1/studies/:id/report.md | Full study report as Markdown |
| GET | /api/v1/studies/:id/participants | List participants |
| GET | /api/v1/studies/:id/participants/:pid | Participant detail |
| GET | /api/v1/studies/:id/participants/:pid/results | Individual results |
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/folders | Create a folder |
| PATCH | /api/v1/folders/:id | Update a folder |
| DELETE | /api/v1/folders/:id | Delete an empty folder |
| POST | /api/v1/studies?type=card_sort | Create a study (specify type) |
| PATCH | /api/v1/studies/:id | Update study settings |
| DELETE | /api/v1/studies/:id | Delete a draft study |
| POST | /api/v1/studies/:id/publish | Publish a draft study |
| POST | /api/v1/studies/:id/end | End a published study |
| POST | /api/v1/studies/:id/duplicate | Duplicate a study |
| POST | /api/v1/studies/:id/cards | Add cards (card sort) |
| POST | /api/v1/studies/:id/questions | Add questions (survey) |
| POST | /api/v1/studies/:id/participants/:pid/exclude | Exclude a participant |
| POST | /api/v1/studies/:id/participants/:pid/include | Re-include a participant |
Create an API key in your workspace settings to get started.