API documentation.

Quick start

Create a key in Settings inside your Growth or Agency workspace: name it, pick its scopes, and copy it once. Keys use Bearer token auth and expire a year after they are created. Responses are JSON.

Endpoints

• GET /v1/projects:List your brands
• POST /v1/projects:Add a brand
• POST /v1/analyze:Trigger an analysis
• GET /v1/monitoring:List monitoring schedules for a brand
• POST /v1/monitoring:Create a monitoring schedule for a brand
• GET /v1/results:Fetch scored results for a brand, filterable by engine and date
• GET /v1/reports:List generated reports
• GET /v1/usage:API usage for the current billing period
• GET /v1/webhooks / POST /v1/webhooks:List or subscribe to webhook events

Webhook events

Every event below has a live dispatch site — there are no accept-but-never-fire subscriptions.

• analysis.completed:Fires when an analysis run finishes
• alert.triggered:Fires when an alert condition is met
• project.created:Fires when a brand is added
• project.updated:Fires when a brand's settings change
• monitoring.completed:Fires when a monitoring run finishes

Resource endpoints

• GET /v1/results/:id:Fetch a single stored result
• GET /v1/reports/:id:Fetch a single report
• GET /v1/webhooks/:id / PATCH / DELETE:Read, update or remove one webhook subscription

The full reference covers every endpoint. SDK examples for Node, Python, and Go are on the roadmap. Keys are self-serve in Settings; for anything else hello@pondral.com.