# Briefed

## Docs

- [Sector Analysis](https://docs.briefedmedia.com/api-reference/ai/analyze.md): AI-driven sector analysis that evaluates consumer pressure dynamics, segment impacts, and contrarian factors for a given sector.
- [Investigate](https://docs.briefedmedia.com/api-reference/ai/investigate.md): Submit a natural-language question for AI-powered consumer signal analysis. Returns a synthesised narrative with sourced implications.
- [Investigate (Streaming)](https://docs.briefedmedia.com/api-reference/ai/investigate-stream.md): Streaming variant of the Investigate endpoint. Returns server-sent events for real-time consumption of AI-powered analysis.
- [Create Alert](https://docs.briefedmedia.com/api-reference/alerts/create.md): Create a new alert to receive notifications when specified conditions are met.
- [Delete Alert](https://docs.briefedmedia.com/api-reference/alerts/delete.md): Permanently delete an alert. Only the alert owner may delete it.
- [List Alerts](https://docs.briefedmedia.com/api-reference/alerts/list.md): Retrieve all alerts associated with a given email address.
- [Get Alert Token](https://docs.briefedmedia.com/api-reference/alerts/token.md): Exchange an email address for a persistent hex alert token used to authenticate subsequent alert and view operations.
- [Update Alert](https://docs.briefedmedia.com/api-reference/alerts/update.md): Update an existing alert. Only the alert owner may modify it.
- [Views](https://docs.briefedmedia.com/api-reference/alerts/views.md): Create, list, and delete saved views. Views store a named configuration of geography, driver selections, and investigation questions.
- [Authentication](https://docs.briefedmedia.com/api-reference/authentication.md): API reference for authentication methods on the Consumer Signals API.
- [Briefing Deck](https://docs.briefedmedia.com/api-reference/briefings/deck.md): Retrieve the latest weekly briefing formatted for slide-deck export.
- [Briefing History](https://docs.briefedmedia.com/api-reference/briefings/history.md): Retrieve a rolling window of past weekly briefings.
- [Latest Briefing](https://docs.briefedmedia.com/api-reference/briefings/latest.md): Retrieve the most recent weekly consumer-signals briefing for a given geography.
- [CPIx Score](https://docs.briefedmedia.com/api-reference/core/cpix.md): Retrieve the current CPIx composite score with driver-level decomposition.
- [Drivers](https://docs.briefedmedia.com/api-reference/core/drivers.md): Retrieve the full set of CPIx drivers with current values and directional trends.
- [CPIx History](https://docs.briefedmedia.com/api-reference/core/history.md): Retrieve historical CPIx score time series for charting and backtesting.
- [Weekly Narrative](https://docs.briefedmedia.com/api-reference/core/narrative.md): Retrieve the weekly CPIx narrative briefing with structured editorial sections.
- [Signals](https://docs.briefedmedia.com/api-reference/core/signals.md): Retrieve active consumer inflation signals with severity, sector impacts, and historical context.
- [Signal Accuracy](https://docs.briefedmedia.com/api-reference/core/signals-accuracy.md): Retrieve accuracy and partial-hit rates for each signal type.
- [Signal Backtesting](https://docs.briefedmedia.com/api-reference/core/signals-backtesting.md): Retrieve full backtesting results including ledger, summary statistics, by-type breakdown, and performance over time.
- [Signal Credibility](https://docs.briefedmedia.com/api-reference/core/signals-credibility.md): Retrieve credibility scores and metadata for signal types within a geography.
- [Errors](https://docs.briefedmedia.com/api-reference/errors.md): HTTP error codes, response format, and troubleshooting guidance for the Consumer Signals API.
- [UK Consumer Macro](https://docs.briefedmedia.com/api-reference/market-data-uk/macro.md): UK consumer macro indicators including consumer sentiment, food prices, and retail sales.
- [Community Sentiment](https://docs.briefedmedia.com/api-reference/market-data-uk/reddit-sentiment.md): Daily UK household financial stress scores derived from activity in UK personal finance communities.
- [UK Retail Prices](https://docs.briefedmedia.com/api-reference/market-data-uk/retail-prices.md): Monthly UK retail price indices including year-over-year changes.
- [UK Labour](https://docs.briefedmedia.com/api-reference/market-data-uk/uk-labour.md): Monthly UK labour market indicators including unemployment, vacancies, payroll employees, and job postings.
- [UK Macro](https://docs.briefedmedia.com/api-reference/market-data-uk/uk-macro.md): Monthly UK macroeconomic indicators including inflation and bond yields.
- [CPI Sub-Indices](https://docs.briefedmedia.com/api-reference/market-data-us/bls-cpi.md): Monthly Consumer Price Index data across key spending categories.
- [US Credit](https://docs.briefedmedia.com/api-reference/market-data-us/credit.md): Quarterly US consumer credit delinquency rates across major lending categories.
- [Household Costs](https://docs.briefedmedia.com/api-reference/market-data-us/household-cost.md): Weekly US household cost indicators including energy prices and borrowing rates.
- [US Housing](https://docs.briefedmedia.com/api-reference/market-data-us/housing.md): US housing market data covering asking prices and market activity.
- [US Labour](https://docs.briefedmedia.com/api-reference/market-data-us/labour.md): Weekly initial and continued unemployment claims data.
- [US Macro](https://docs.briefedmedia.com/api-reference/market-data-us/macro-us.md): Monthly US macroeconomic indicators including consumption expenditure and consumer confidence.
- [Income-Stratified Spending](https://docs.briefedmedia.com/api-reference/market-data-us/oi.md): Income-stratified consumer spending data, tracking spending patterns across income cohorts.
- [US Spending](https://docs.briefedmedia.com/api-reference/market-data-us/spending.md): Monthly US consumer spending indicators covering vehicle sales, restaurant revenue, and e-commerce.
- [US Transport](https://docs.briefedmedia.com/api-reference/market-data-us/transport.md): Monthly US transportation indicators including freight indices and trucking data.
- [API Overview](https://docs.briefedmedia.com/api-reference/overview.md): Base URL, response envelope, standard headers, and geography model for the Consumer Signals API.
- [Census MARTS](https://docs.briefedmedia.com/api-reference/sectors/census-marts.md): Retrieve Census Bureau MARTS retail sales data for consumer-signal context.
- [Company Exposure](https://docs.briefedmedia.com/api-reference/sectors/company.md): Retrieve the consumer-signal exposure profile for a specific company.
- [Earnings](https://docs.briefedmedia.com/api-reference/sectors/earnings.md): Retrieve upcoming and recent earnings events for tracked consumer companies.
- [Import Pressure](https://docs.briefedmedia.com/api-reference/sectors/import-pressure.md): Retrieve import-pressure scores and EU/UK price-gap analysis for a UK sector.
- [Sector Overview](https://docs.briefedmedia.com/api-reference/sectors/sector.md): Retrieve consumer-signal pressure scores, trends, and company exposure for a specific sector.
- [Trend Baskets](https://docs.briefedmedia.com/api-reference/trends/baskets.md): List all available trend baskets and their constituent keywords for a geography.
- [Composite Trends](https://docs.briefedmedia.com/api-reference/trends/composite.md): Retrieve the composite consumer-signal score time series.
- [Trend History](https://docs.briefedmedia.com/api-reference/trends/history.md): Retrieve historical score, smoothed value, and momentum for a single trend basket.
- [Regional Trends](https://docs.briefedmedia.com/api-reference/trends/regional.md): Retrieve a regional breakdown of consumer-signal trends within a geography.
- [Trends](https://docs.briefedmedia.com/api-reference/trends/trends.md): Retrieve the latest scored trend baskets with momentum indicators.
- [Authentication](https://docs.briefedmedia.com/authentication.md): How to authenticate with the Consumer Signals API using JWTs, alert tokens, and admin credentials.
- [Briefings & Narratives](https://docs.briefedmedia.com/guides/briefings-and-narratives.md): AI-generated weekly briefings with structured analysis, company exposure, and forward-looking outlook.
- [Consumer Signals](https://docs.briefedmedia.com/guides/consumer-signals.md): Overview of the Consumer Signals platform — what it does, what the API delivers, and key concepts.
- [Rate Limits](https://docs.briefedmedia.com/guides/rate-limits.md): Rate limiting policy for AI-powered endpoints on the Consumer Signals API.
- [Sectors & Companies](https://docs.briefedmedia.com/guides/sectors-and-companies.md): Sector intelligence, company exposure analysis, and the UK import pressure model.
- [Introduction](https://docs.briefedmedia.com/index.md): Consumer Signals API — early-warning intelligence on consumer demand, pricing behaviour, and spending patterns across the US and UK.
- [Quickstart](https://docs.briefedmedia.com/quickstart.md): Authenticate and retrieve your first Consumer Signals data in under five minutes.

## OpenAPI Specs

- [openapi](https://docs.briefedmedia.com/api-reference/openapi.json)

## Optional

- [Briefed Media](https://briefedmedia.com)