API Reference

All endpoints are relative to your Reev instance URL. Authenticated endpoints require a valid session cookie.

Events

The tracker sends batched events to this endpoint. It is public (no session required) but rate-limited to 60 requests/minute per IP.

POST/api/eventsPublic

Ingest a batch of tracker events.

Param	Type	Description
`sessionId`*	string	Unique session ID generated by the tracker.
`projectId`*	string	Your project ID.
`events`*	array	Array of event objects (max 50 per batch).

Valid event types: pageview, click, scroll, form, error, vitals, page_leave, ux_issue, ux_feedback, suggestion_clicked, suggestion_dismissed

Returns 204 on success. Max payload: 512 KB.

Reports

UX feedback reports collected from popover responses.

GET/api/reportsAuth required

List feedback reports for a project.

Param	Type	Description
`projectId`*	string	Project ID.
`status`	string	"open" (default), "resolved", or "all".
`issueType`	string	Filter by issue type (rage_click, dead_link, etc.).
`search`	string	Search in message and page URL.
`limit`	number	Page size (default 20).
`offset`	number	Pagination offset.

PATCH/api/reportsAuth required

Update a report's status.

Param	Type	Description
`id`*	number	Report ID.
`status`*	string	"open" or "resolved".

Patterns

Automatically detected recurring UX issue patterns.

GET/api/patternsAuth required

List detected patterns for a project.

Param	Type	Description
`projectId`*	string	Project ID.
`status`	string	"open" (default), "resolved", or "all".
`issueType`	string	Filter by issue type.
`limit`	number	Page size (default 20).
`offset`	number	Pagination offset.

PATCH/api/patternsAuth required

Update a pattern's status. Also bulk-updates linked reports.

Param	Type	Description
`id`*	number	Pattern ID.
`status`*	string	"open" or "resolved".

Flow Suggestions

Manage navigation suggestions shown in the on-site widget.

GET/api/flowsAuth required

List all flow suggestions for a project.

Param	Type	Description
`projectId`*	string	Project ID.
`source`	string	Filter by source: "manual", "auto", or "sitemap".

POST/api/flowsAuth required

Create a flow suggestion.

Param	Type	Description
`projectId`*	string	Project ID.
`sourceUrlPattern`*	string	URL pattern where the suggestion appears.
`targetUrl`*	string	URL the suggestion links to.
`targetLabel`*	string	Display label for the suggestion.
`priority`	number	Sort priority (default 10).

PUT/api/flowsAuth required

Update a flow suggestion.

Param	Type	Description
`id`*	number	Suggestion ID.
`targetLabel`	string	New label.
`priority`	number	New priority.
`isActive`	boolean	Enable or disable.

DELETE/api/flows?id={id}Auth required

Delete a flow suggestion.

Param	Type	Description
`id`*	number	Suggestion ID (query param).

Flow Config

GET/api/flows/configAuth required

Get the flow widget configuration for a project.

Param	Type	Description
`projectId`*	string	Project ID.

PUT/api/flows/configAuth required

Update flow widget configuration.

Param	Type	Description
`projectId`*	string	Project ID.
`enabled`	boolean	Enable or disable the widget.
`displayMode`	string	"frustration" or "always".
`maxSuggestions`	number	Max suggestions to show.
`widgetPosition`	string	"bottom-right" or "bottom-left".
`widgetTheme`	string	"dark" or "light".
`autoDiscover`	boolean	Auto-generate suggestions from navigation patterns.

Suggest (Tracker)

Public endpoint called by the on-site widget to fetch suggestions for the current page.

GET/api/flows/suggestPublic

Get active suggestions for a page. Rate-limited to 30 req/min per IP.

Param	Type	Description
`projectId`*	string	Project ID.
`url`*	string	Current page URL.

Returns all active suggestions sorted by relevance to the current path. Excludes the current page from results.

Bulk Import

POST/api/flows/bulkAuth required

Create multiple flow suggestions in one request (max 50).

Param	Type	Description
`projectId`*	string	Project ID.
`suggestions`*	array	Array of { sourceUrlPattern, targetUrl, targetLabel, priority? }.

GET/api/flows/sitemapAuth required

Fetch and parse the project's sitemap.xml into a tree structure.

Param	Type	Description
`projectId`*	string	Project ID. The project must have a website_url configured.