Skip to main content

​
Quickstart

This guide walks you through obtaining a JWT, making your first API call, and interpreting the response.
API access is available exclusively on the Enterprise plan. To discuss access, contact sales@briefedmedia.com.

​
Step 1: Obtain a JWT

Sign in at id.briefedmedia.com. After authentication, your account dashboard provides a JWT. Copy the token value — you will use it in the Authorization header for all API requests.
JWTs are short-lived credentials signed with HMAC-SHA256. They are not API keys. Your token must include the products.consumer_signals claim to access Consumer Signals endpoints.

​
Step 2: Make your first request

Call the CPIx endpoint to retrieve the current Consumer Price Index signal: 
curl https://api.consumersignals.io/api/cpix \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

​
Step 3: Interpret the response

A successful response returns the CPIx composite score along with directional change data and underlying drivers: 
{
  "ok": true,
  "data": {
    "score": 62.4,
    "change": -1.8,
    "change_period": "7d",
    "classification": "moderating",
    "geography": "US",
    "as_of": "2026-03-31T00:00:00Z",
    "drivers": [
      {
        "category": "grocery",
        "signal_strength": 0.74,
        "direction": "declining",
        "contribution": -0.9
      },
      {
        "category": "discretionary_retail",
        "signal_strength": 0.61,
        "direction": "stable",
        "contribution": -0.2
      },
      {
        "category": "dining_out",
        "signal_strength": 0.68,
        "direction": "declining",
        "contribution": -0.7
      }
    ]
  }
}
The classification field summarises the overall demand regime. Possible values include accelerating, stable, moderating, and contracting.

​
Step 4: Explore signals

Retrieve the full set of consumer signals with GET /api/signals: 
curl https://api.consumersignals.io/api/signals \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
This returns a broader dataset of granular consumer demand indicators across sectors and geographies.

​
Next steps

Authentication

JWT lifecycle, plan tiers, and alternative auth methods.

Consumer Signals Guide

Deep dive into the signals data model and sector taxonomy.

API Reference

Full endpoint documentation with request and response schemas.

Rate Limits

Understand throttling on AI-powered endpoints.