API Reference

Brands

Brands are the entities matched against engine answers: your own brand and any competitors you would like to track. Brand matches are what drive share of voice, sentiment, and citation tracking. Brands themselves are created by Pineprompt; only their classification is editable.

Endpoints

GET /api/v1/brands

List brands
Returns every brand belonging to the active project. The response is paginated.
PUT /api/v1/brands/{brand}

Update a brand
Reclassifies a brand. The only writable field on a brand is its kind, which may be own, competitor, or ignored. A project may have at most one own brand, so assigning own while another own brand already exists returns a 422. When you reclassify a brand from own or competitor to ignored, Pineprompt will automatically detach the brand from every segment it belonged to.