Product response envelope

Current product endpoints return a resource envelope: data.object, data.brand_id, data.page, and nested data.data containing the dashboard data. Pagination fields for these endpoints are inside data.data. Unknown measurements remain null; verified zeros remain 0. Sensitive values are redacted.

Write scopes require beta enrollment. Draft and calendar edits do not publish content. External effects require the confirmation rules described below.

GET …/results (results:read), operation get_results

Query: period_days ∈ 10, 30, 90, 365 (default 30); limit (default 50) and cursor page the blogs and social rows. data contains attributed blog/social results, trends, totals (store-wide, attributed and estimates are kept separate), AI-assistant traffic, source readiness, WooCommerce store summary, share_of_voice and share_of_voice_ready. Social data is included only if the plan has social_autopilot.

POST …/results/refresh (results:refresh), operation refresh_results

Body: { "confirm": true }. Requires the social_autopilot plan feature. Costs 1 credit. Calls the capture-post-metrics Edge Function, which may contact providers. Refetch get_results afterwards.