Skip to main content

​
API Overview

​
Base URL

https://api.consumersignals.io
There is no version prefix. All endpoints are served directly under this base URL (e.g. /api/cpix, /api/signals).
API access requires an Enterprise plan. Contact sales@briefedmedia.com to get started.

​
Response Format

All responses return JSON. Successful responses and errors follow a consistent envelope structure.

​
Success

{
  "ok": true,
  "data": {
    "score": 62.4,
    "classification": "moderating"
  }
}

​
Error

{
  "ok": false,
  "error": "Invalid or expired JWT."
}
The ok field is always present. On success, the response body is in data. On failure, a human-readable message is in error.

​
Standard Headers

The API sets the following headers on every response:
HeaderDescription
X-Request-IDUnique identifier for the request. Include this value when contacting support.
Content-TypeAlways application/json for JSON endpoints.
Strict-Transport-SecurityEnforces HTTPS connections.
X-Content-Type-OptionsSet to nosniff to prevent MIME-type sniffing.
X-Frame-OptionsSet to DENY to prevent clickjacking.
X-XSS-ProtectionSet to 1; mode=block.
Referrer-PolicySet to strict-origin-when-cross-origin.

​
Geography Model

The API supports data for the United States and the United Kingdom. The US is the default geography when no geography parameter is specified. Where endpoints accept a geography parameter, use the ISO 3166-1 alpha-2 codes:
CodeGeography
USUnited States
UKUnited Kingdom

​
Versioning

The API does not use a version prefix in the URL path. Breaking changes, if any, will be communicated in advance through the changelog and via email to registered accounts.