read: forecasts.
A play or a tactic, across brands to every forecast with its effect, how well the band held, and the proper score by play, tactic, kind of buyer, framing, actor and content
Read forecasts against effects. The call needs the brand rung under a token with the read grant, and it is served by the platform.
The route takes ForecastsInput and returns a card whose body is ForecastsAnswer.
Request body#
The request body is ForecastsInput.
| field | type | required | note |
|---|---|---|---|
play | id | no | |
tactic | Tactic | no |
Response#
The route returns a card whose body is ForecastsAnswer. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.
Headers#
| header | required | meaning |
|---|---|---|
Scale-Scope | yes | the scope the call runs in: tenant/ |
Scale-As-True-On | no | the date the facts must have been true on; defaults to now |
Scale-As-Known-On | no | the date the facts must have been known on; defaults to now |
Scale-Key | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the brand rung and a token with the read grant. The platform serves this route.
Example#
The example sends the smallest body that ForecastsInput allows. The build validates it against the schema of ForecastsInput.
Example
curl -X POST https://api.scaleintelligence.co/v1/read/forecasts \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
-H "content-type: application/json" \
-d '{}'
import { client } from "@scale/sdk";
const answer = await client.read.forecasts({});
// answer.body is a ForecastsAnswer. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/forecasts",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
json={}).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/forecasts")
.header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
.json(&ForecastsInput { /* the fields of the page */ }).send().await?.json().await?;
MCP tool#
The MCP tool si.read.forecasts takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/ForecastsAnswer. The tool’s page describes it.
POST /v1/read/forecasts
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json
{}Claims#
| claim | state | route or tool |
|---|---|---|
| The platform serves the route /v1/read/forecasts at contract 0476e35e6e275db5. | target | /v1/read/forecasts |