#Dashboards

Status: Available — GET /dashboards/overview and GET /dashboards/pulse. Planned — embedding dashboards by a signed token (stage 4). The internal fields of the "Overview" blocks may grow; availability and data_as_of in every block are stable.

Purpose: get ready-made slices of the "Overview" and "Pulse" screens in one request, so you can show them in your own system without assembling them from separate methods. The slices contain aggregates only.

#Contents

1. When to use it
2. Access
3. GET /dashboards/overview
4. GET /dashboards/pulse
5. Data freshness
6. Embedding by signed token
7. Errors
8. Examples
9. Open questions

#When to use it

#Access

#GET /dashboards/overview

A slice of the "Overview" screen: the strategic summary, key indicators, the funnel, and additional blocks. The data is the same as a dashboard employee sees, without the controls.

#Query parameters

Block windows with a fixed period (for example, clusters is 30 days, status is the cost of articles over 30 days) do not depend on from and to. The days parameter is a dashboard detail and is absent from the public API.

#Blocks

Each block carries its own availability and data_as_of (an object {source: date}), like the funnel and visibility sections (Reading analytics). Money in blocks is an object {"amount", "currency"}.

#Response (abridged)

{
  "data": {
    "from": "2026-10-01",
    "to": "2026-10-28",
    "blocks": {
      "kpi": {
        "availability": "ok",
        "data_as_of": { "g:search_console": "2026-10-25", "tracker": "2026-10-28", "crm": "2026-10-28" },
        "tiles": [
          { "key": "impressions", "current": 182400, "prev": 171900, "delta_pct": 6.1 },
          { "key": "clicks", "current": 4210, "prev": 3880, "delta_pct": 8.5 },
          { "key": "sessions", "current": 3920, "prev": 3601, "delta_pct": 8.9 },
          { "key": "ai_people", "current": 212, "prev": 140, "delta_pct": 51.4 },
          { "key": "revenue", "current": { "amount": "5240.00", "currency": "GBP" }, "prev": { "amount": "4100.00", "currency": "GBP" }, "delta_pct": 27.8 }
        ]
      },
      "funnel": { "availability": "ok", "data_as_of": { "g:search_console": "2026-10-25", "crm": "2026-10-28" }, "steps": [ ] },
      "ai_assistants": { "availability": "ok", "data_as_of": { "tracker": "2026-10-28" } }
    }
  }
}

The structure inside the blocks is shown in abridged form. The standing rule is availability (ok, no_data, no_source, not_connected), an optional reason, and data_as_of in every block; other block fields may grow, and the client ignores them. kpi tiles carry their own availability. A read failure of any block gives 503 for the whole request: a block is never replaced by an empty one.

#GET /dashboards/pulse

A slice of the "Promotion → Pulse" screen (promo/insights/pulse, also called "Findings and Pulse" in the dashboard): demand topics that have started to grow. Other screens with a similar name are not part of the public API. Each finding rests on several signal sources, each with its own outcome (spike means a surge) and comparison base.

#Query parameters

#Response

{
  "data": {
    "period": { "from": "2026-09-13", "to": "2026-10-10" },
    "new_7d": 3,
    "truncated": false,
    "alerts": [
      {
        "id": "alert_EXAMPLE_01",
        "topic_id": "topic_EXAMPLE_01",
        "topic_name": "Ниацинамид и пористость",
        "keyword": "ниацинамид для пор",
        "horizon": "short",
        "status": "open",
        "episode_start": "2026-10-04",
        "last_seen": "2026-10-10",
        "score": 0.82,
        "volume": 3400,
        "growth": 2.4,
        "sources": [
          { "code": "serp_suggest", "outcome": "spike", "value": 120, "base": 50 }
        ],
        "strategist_topic": { "id": "tpc_EXAMPLE_01", "status": "proposed" }
      }
    ],
    "data_as_of": { "pulse": "2026-10-10" }
  }
}

The evidence text (evidence.text) is not returned. A topic cannot be accepted for work through this method: reading is separate from action; strategist queue topics are approved and rejected by separate methods of the /strategist/topics resource (Strategist). The ceo/pulse screen is not part of the public API.

The values of the horizon, status, and source code fields in the example are illustrative; the list of values will be finalized.

#Data freshness

Each block reports data_as_of, an object {source: date}: the date through which each source's data is complete. Search consoles lag by 2–3 days; do not mistake the missing days for a drop. See Reading analytics for details.

#Embedding by signed token

Status: Planned. Embedding belongs to stage 4, together with the sandbox.

The idea: instead of passing an API key to a third-party site, your server obtains a short-lived signed dashboard token and outputs an <iframe> with the ready-made slice. The token is limited to one tenant, one slice, and an expiry time; the API key never leaves your server.

What is known at this stage:

• the token is issued by your server using the API key (parameters, lifetime, and format are defined at stage 4);
• the embedded dashboard shows aggregates only;
• embedding requires a separate frame-ancestors/CORS policy set in the tenant's settings.

Embedding is not available yet. For integrations, use server-side reading with a key for now.

#Errors

The format is application/problem+json; the shared catalog is in the Conventions.

#Examples

curl -sS 'https://formula-cream.pro/api/public/v1/dashboards/overview?from=2026-10-01&to=2026-10-28' \
  -H 'Authorization: Bearer sap_ru_live_EXAMPLE0KEYI_EXAMPLEEXAMPLEEXAMPLEEXAMPLEEXAMPLE'

const response = await fetch('https://wfacademy.org/api/public/v1/dashboards/pulse?from=2026-09-13&to=2026-10-10', {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
const { data } = await response.json();
for (const alert of data.alerts) console.log(alert.topic_name, alert.growth);

import os, requests

r = requests.get(
    "https://wfacademy.id/api/public/v1/dashboards/overview",
    headers={"Authorization": f"Bearer {os.environ['API_KEY']}"},
    params={"from": "2026-10-01", "to": "2026-10-28"},
    timeout=10,
)
r.raise_for_status()
print(list(r.json()["data"]["blocks"]))

#Open questions

1. Technical. The embedding token format, its lifetime, the set of permitted slices, and the frame-ancestors policy are defined at stage 4.
2. Technical. The set of blocks and the blocks parameter. The design names "ready-made slices" as a whole; the block list is taken from the dashboard, and choosing blocks by a parameter is a proposal.
3. For the owner. Infrastructure blocks (proxies, domain authority, article cost): whether it is appropriate to expose them in the external API has not been decided.
4. Technical. Uniform periods. Some dashboard blocks are calculated over a fixed window (30 days); how to present this when from and to are set will be finalized in OpenAPI.

Templates and examples