Brand Intelligence · API reference
Enterprise API v1
Programmatic access to anonymized search demand for Brand Intelligence tenants (OEM or Platform). Authenticate with an API key we issue — data is never public without credentials.
Base URL: https://www.gunsearchengine.com/api/enterprise. Operational model: Ontology. Product: Brand Intelligence.
OpenAPI for SwaggerHub / codegen
Import this URL into SwaggerHub, Postman, or any OpenAPI 3 tool:
https://www.gunsearchengine.com/openapi/enterprise-v1.yamlAuthentication
Authorization: Bearer ek_live_…
Keys are minted in Admin → Clients or by a portal client_admin via POST /v1/keys. The full secret is shown once. Portal cookie sessions can call the same data routes.
Editions & scope
- Platform — full-market anonymized demand
- OEM — your brand keys + up to 3 competitors only
OEM with empty brand keys fails closed (no silent full platform). Responses include a scope object.
Bootstrap
| Method | Path | Description |
|---|---|---|
| GET | /v1/health | Liveness + scope ready flag |
| GET | /v1/me | Client, scope, portal path |
| GET | /v1/settings | Weekly insights + edition keys |
| PATCH | /v1/settings | Toggle weekly_insights_enabled (portal admin cookie) |
Demand
hours: 1–168 (default 24). ET calendar windows.
| Method | Path | Description |
|---|---|---|
| GET | /v1/intel?hours=24 | Full demand package (cloud, map, UPC, unmet, rising, referrers) |
| GET | /v1/unmet?hours=24 | Zero-hit “Asked, not found” |
| GET | /v1/upc?hours=24 | SKU intensity leaderboard |
| GET | /v1/rising?hours=72 | Rising calibers (rollups) |
| GET | /v1/referrers?hours=24 | First-touch external referrer hosts |
Sessions
Sanitized only — no emails, session ids, seller hosts, or product URLs.
| Method | Path | Description |
|---|---|---|
| GET | /v1/sessions | Sanitized session feed (q, channel, term, limit, offset) |
| GET | /v1/sessions/export | JSON download ≤5k sessions + events (audited) |
API keys
Portal client_admin cookie required (not raw API key).
| Method | Path | Description |
|---|---|---|
| GET | /v1/keys | List keys (portal client_admin) |
| POST | /v1/keys | Create key — secret returned once |
| DELETE | /v1/keys?id= | Revoke key |
Rate limits
- Read routes (intel, sessions, slices, me, health): 60 / min / IP
- Export: 10 / min / IP
Privacy
Never returned: emails, session ids, seller hosts, product URLs, internal lead ids. May include free-text search slots, referrer host, landing UTM, and public catalog fields on the UPC board.
Get access
Brand Intelligence is invite-only. We provision a portal, set OEM or Platform edition, and issue keys.
Engineers: docs/enterprise-api.md and public/openapi/enterprise-v1.yaml in the repo. Spec is public at /openapi/enterprise-v1.yaml.