Skip to content
Docs

REST API Reference

All Pro endpoints use the namespace roadmap/v1, alongside the free plugin’s own routes.

Products

Section titled “Products”
Route Method Permission Description
/products GET Public List all products with metadata.
/products/{id} GET Public Single product, including item count.

Timeline

Section titled “Timeline”
Route Method Permission Description
/timeline GET Public Timeline data. Parameters: product (slug), start_date, end_date (YYYY-MM-DD).

Items

Section titled “Items”
Route Method Permission Description
/items/reorder POST edit_posts, re-checked against the specific item Update an item’s status and position from drag and drop. Body: item_id, new_status, new_position. Only accepts a status that already exists.
/items/merge POST edit_posts, re-checked against each item (delete on source, edit on target) Merge one item into another. Body: source_id, target_id. See Item merge.

Export

Section titled “Export”
Route Method Permission Description
/export GET export capability CSV download. Parameters: format (csv), product, status, date_from, date_to.

Analytics

Section titled “Analytics”

All analytics routes require the roadmap_view_analytics capability (administrators by default), except /analytics/track, which is public since it only records an event.

Route Method Description
/analytics GET Combined analytics payload.
/analytics/overview GET Total items, votes, comments, active users, popular items, recent activity.
/analytics/trends GET Parameters: period (7days, 30days, 90days, year).
/analytics/popular-items GET Parameters: product, period.
/analytics/recent-activity GET Parameters: product, period.
/analytics/charts GET Chart.js-formatted status distribution and votes-over-time. Parameters: product, period.
/analytics/track POST Public. Records one analytics event. Rate-limited and payload-capped per IP.

Changelog

Section titled “Changelog”
Route Method Permission Description
/changelog/products GET Public Products that have at least one changelog entry.
/changelog/by-product/{slug} GET Public Changelog entries for one product. Parameters: page, limit.

Guest suggestions

Section titled “Guest suggestions”
Route Method Permission Description
/guest-suggest POST roadmap_pro_enable_guest_suggestions must be on, plus rate limits Submit a suggestion. Body: title, description, guest_name, guest_email, optional category, product.
/guest-suggestions GET edit_posts List suggestions for moderation.
/guest-suggestions/{id}/approve POST edit_posts Approve a suggestion.
/guest-suggestions/{id}/reject POST edit_posts Reject a suggestion.

User profiles

Section titled “User profiles”
Route Method Permission Description
/users/{id}/activity GET Logged in by default; see roadmap_pro_public_user_profiles A user’s roadmap voting and comment activity.
/users/top-contributors GET Logged in by default; see roadmap_pro_public_user_profiles Most active users.

Webhooks

Section titled “Webhooks”

Requires manage_options. See Webhooks and custom fields for the payload and signature format.

Route Method Description
/webhooks GET List configured webhooks.
/webhooks POST Create a webhook. Body: url, secret, events (array).
/webhooks/{index} DELETE Remove a webhook by its list index.
/webhooks/test POST Send a test payload to a URL.

Custom fields

Section titled “Custom fields”
Route Method Permission Description
/custom-fields GET Public Field definitions.
/custom-fields POST manage_options Save field definitions.
Section titled “Related”