Scale Intelligence■ Docs
Docs / Reference / economics: benchmarks

economics: benchmarks.

A driver, and a population or a buyer profile to the benchmarks that apply, each with its interval, population, period, source and what its rights allow

Figure 1POST /v1/economics/benchmarksspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/economics/benchmarks4 headersCORE: ECONOMICSrung tenantgrant readRECORDreads or writesCARD, 200body [Benchmark]The input is BenchmarksInput. Every response carries the contract's hash.flows forwardthe result
The caller sends BenchmarksInput to /v1/economics/benchmarks. The platform returns a card whose body is [Benchmark].
POST/v1/economics/benchmarks

Si.economics.benchmarks. The call needs the tenant rung under a token with the read grant, and it is served by either, by the size bound.

The route takes BenchmarksInput and returns a card whose body is Benchmark.

Request body#

The request body is BenchmarksInput.

fieldtyperequirednote
driverKindOfMeasureyes
kind_of_buyertextno

Response#

The route returns a card whose body is Benchmark. 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#

headerrequiredmeaning
Scale-Scopeyesthe scope the call runs in: tenant/, then /brand/, then /strategy/
Scale-As-True-Onnothe date the facts must have been true on; defaults to now
Scale-As-Known-Onnothe date the facts must have been known on; defaults to now
Scale-Keynofor 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 tenant rung and a token with the read grant. The platform or the desktop app serves this route.

Example#

The example sends the smallest body that BenchmarksInput allows. The build validates it against the schema of BenchmarksInput.

Example
curl -X POST https://api.scaleintelligence.co/v1/economics/benchmarks \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "driver": "…" }'
import { client } from "@scale/sdk";
const answer = await client.economics.benchmarks({
    "driver": "…"
  });
// answer.body is a [Benchmark]. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/economics/benchmarks",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "driver": "…"
    }).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/economics/benchmarks")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&BenchmarksInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.economics.benchmarks takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Benchmark. The tool’s page describes it.

POST /v1/economics/benchmarks
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "driver": "…"
}
Without a key, this page shows the request only. The request body is BenchmarksInput, and the route returns a card whose body is [Benchmark].

Claims#

claimstateroute or tool
The platform serves the route /v1/economics/benchmarks at contract 0476e35e6e275db5.target/v1/economics/benchmarks