Skip to main content

Overview

Burst Statistics exposes a custom beacon endpoint and a set of WordPress REST API routes under the burst/v1 namespace.

Using the REST API to get data

If you are connecting Burst to an external tool (AI workflow, BI dashboard, ETL pipeline), start with these two endpoints:

Both endpoints support Application Password authentication, making them suitable for server-to-server use without a browser session. See Authentication for setup instructions.

The remaining endpoints (do_action, get_action, goals, fields, etc.) are primarily used by the Burst admin dashboard and are documented in Admin endpoints.

Endpoints

EndpointMethodAuthPermission
{site}/burst-statistics/endpoint.phpPOSTNonePublic
burst/v1/trackPOSTNonePublic
burst/v1/menuGETNoncemanage
burst/v1/fields/getGETNoncemanage
burst/v1/fields/setPOSTNoncemanage
burst/v1/options/setPOSTNoncemanage
burst/v1/goals/getGETNonceview
burst/v1/goals/addPOSTNoncemanage
burst/v1/goals/setPOSTNoncemanage
burst/v1/goals/deletePOSTNoncemanage
burst/v1/goals/add_predefinedPOSTNoncemanage
burst/v1/data/{type}GETNonceview
burst/v1/data/ecommerce/{type}GETNonceview_sales
burst/v1/do_action/{action}POSTNoncemanage
burst/v1/get_action/{action}GETNonceview
burst/v1/posts/GETNoncemanage
burst/v1/mainwp-authPOSTRSA signaturePublic*

Permission levels

LevelCapabilityWho has it
managemanage_burst_statisticsAdministrators
viewview_burst_statisticsAdministrators and burst_viewer role holders accessing a share link
view_salesview_sales_burst_statisticsPro only; granted separately from view. Share link viewers require sales in the token's shared_tabs list