> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heralded.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Home

> Your weekly brief, focus and what needs you today.

Home opens with your weekly headline and the Heralded Score. The headline counts the work currently in **Needs you**, matching Work and the rail badge. Mentioned, Recommended and Understood sit beside it. Perception has [Praised](https://docs.heralded.ai/methodology/how-ai-describes-you.md).

The score keeps its report date. **Updating**, **Partial** and **Last update failed** describe its latest refresh.

## The week

Your focus cards show the topics, competitors and markets you star in [Strategy](https://docs.heralded.ai/concepts/strategy.md). Each has two figures and a short result. An unmeasured figure stays unknown.

**This week** brings together [changes](https://docs.heralded.ai/methodology/change.md), [results](https://docs.heralded.ai/methodology/verifying-actions.md) and competitor moves. Each row is a change against an earlier measurement. Something new, such as a question, engine, market or competitor, has no row until it has an earlier measurement to differ from. Pages AI starts citing are grouped per competitor, such as "AI started citing 3 Linear pages". A competitor's changes to its own site are one row a week, such as "Accumeo published 3 new pages and changed its pricing". A result links to the work it describes. A citation alone does not mean a piece is paying off. No effect and Fell keep their own labels. Pending signals and unavailable checks stay with the work they describe.

Select **See all** beside **This week** to open the week's own list: every observation of the week, newest first, ten to a page.

**Next weekly report** comes first, followed by **Today**. Today's observations appear at the bottom of **Today**. Below it, earlier days with observations have one row each, newest day first. The row leads with a work result or first citation, then crawler recovery, recommendation changes, mentions, citations and competitor changes. Within a kind, the change covering the most questions or pages leads. Select **and N other changes** to expand the rest of that day in the same order. Select it again to collapse them.

## Today

**Today** appears even when there are no observations. When decisions wait on you, its title counts them, such as **3 to decide**, and it shows up to three with a link to the rest. Select **Start** to walk every decision waiting on you, oldest ask first. It is the same walk as **Start** and **Review N** on Work. Decisions that arrive while you walk follow at the end.

When nothing waits on you, **Today** shows your team's two oldest open decisions and how long they have waited. If only Heralded has work running, it shows that work and its current stage. When nothing is in progress, it offers a place to start.

**Suggested next** gives each suggestion's reason and cost. Select its **Start** button to use the same start flow and credit checks as Work. You see one suggestion when five or more items are in flight, otherwise two. When nothing is in progress, **Where we'd begin** shows up to three, with **Start the first** above them. Suggestions in your focus come first, in Work's suggested order.

The same layout appears on desktop and phone. The workspace and brand switcher shows your brand's favicon, falling back to its first letter.

Readers without permission to act can open work but cannot start or change it. Staff, management-link readers and brand-grant holders keep their read-only access, including on **Review** pages.

## Read Home through the API

Use `GET /v1/brands/{brand_id}/weekly-brief?with_today=true`, `/week-timeline` and `/focus-cards`. Their MCP tools are `get_weekly_brief`, `get_week_timeline` and `get_focus_cards`. [Home fields](https://docs.heralded.ai/figures.md#home) describes the responses.

API keys and MCP receive the data behind the brief, timeline and focus. First-party sessions also receive the composed headline, event sentences and focus sentences.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.