Brand Intelligence · API reference
Enterprise API v1
Programmatic access to anonymized search demand for Brand Intelligence clients (OEM or Platform). Authenticate with an API key we issue — data is never public without credentials.
Base URL: https://www.gunsearchengine.com/api/enterprise. How the platform is modeled: Ontology. Product overview: Brand Intelligence.
Try it live · machine-readable spec
Explore endpoints in your browser, or import the same specification into Postman, SwaggerHub, or similar tools:
https://www.gunsearchengine.com/openapi/enterprise-v1.yamlAuthentication
Authorization: Bearer ek_live_…
We issue API keys that start with ek_live_. Create them in your Brand Intelligence portal (admin users) or we can provision them for you. The full secret is shown only once. While signed in to the portal, you can also call the same data routes from the browser.
Editions & scope
- Platform — full-market anonymized demand
- OEM — your brands plus up to three competitors only
OEM accounts with no brands configured return empty results — never a silent full-market feed. Responses include a scope object describing what you can see.
Getting started
| Method | Path | Description |
|---|---|---|
| GET | /v1/health | Health check and whether your brand scope is ready |
| GET | /v1/me | Your account, edition, and brand scope |
| GET | /v1/settings | Weekly email preference and edition details |
| PATCH | /v1/settings | Turn weekly insights email on or off (portal admin only) |
Demand
hours: 1–168 (default 24). Windows use Eastern Time calendar days.
| Method | Path | Description |
|---|---|---|
| GET | /v1/intel?hours=24 | Full demand package (cloud, map, top products, unmet demand, rising calibers, referrers) |
| GET | /v1/unmet?hours=24 | Searches that found nothing (“asked, not found”) |
| GET | /v1/upc?hours=24 | Most-searched products by UPC |
| GET | /v1/rising?hours=72 | Calibers gaining interest |
| GET | /v1/referrers?hours=24 | Where shoppers first arrived from (external sites) |
Sessions
Privacy-safe only — no emails, session ids, store hosts, or product purchase links.
| Method | Path | Description |
|---|---|---|
| GET | /v1/sessions | Privacy-safe session list (search text, channel, paging) |
| GET | /v1/sessions/export | JSON download of up to 5,000 sessions (audited) |
API keys
Creating and revoking keys requires a portal administrator signed in to the portal — not the API key alone.
| Method | Path | Description |
|---|---|---|
| GET | /v1/keys | List API keys (portal admin only) |
| POST | /v1/keys | Create a key — full secret shown only once |
| DELETE | /v1/keys?id= | Revoke a key |
Rate limits
- Read endpoints (demand, sessions, account, health): 60 per minute per IP
- Export: 10 per minute per IP
Privacy
Never returned: emails, session ids, store hosts, product URLs, or internal identifiers. May include free-text search terms, referrer host/path, landing campaign tags, and public catalog fields on the product leaderboard. Do not try to re-identify individuals from residual free text. See Privacy Policy.
Get access
Brand Intelligence is invite-only. We set up your portal, choose OEM or Platform, and issue API keys.
Machine-readable specification: /openapi/enterprise-v1.yaml · interactive sandbox.