API Reference#

The Brandwave REST API gives you programmatic access to your marketing record: activity, spend, outcomes, and brand signals in one structured source. Use standard HTTP requests from any language, platform, or tool.

Base URL#

https://api.gobrandwave.com/v1

Request format#

All requests must include an Authorization header with your API key. Request bodies should be JSON-encoded with the Content-Type: application/json header.

curl https://api.gobrandwave.com/v1/activities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response format#

All responses return JSON. List endpoints return paginated results with items and totalCount fields.

{
  "items": [...],
  "totalCount": 42
}

Decision-ready contracts#

The Reporting resource includes canonical campaign portfolio, comparison, stakeholder brief, recommendation, launch-readiness, and closeout operations. Monetary responses include an ISO currency, and metric responses include measurement status, coverage, freshness, estimation provenance, warnings, and methodology so clients do not need to infer evidence quality.

Campaign create and update requests can store planning intent directly: summary, objective, audience, key message, desired outcomes, channels, owner, and tags. Campaign mutations return a receipt with the customer-facing target, changed fields, derived status, and reversibility. Use the campaign mutation preview operation when you need the same presentation before a write.

HTTP status codes#

Next steps#