Docs / Reference / economics: study

economics: study.

`PricingStudyInput`: the methods to run, the buyer profiles, the rivals' window to the study as a fact and its candidate ladders as a set of options

Figure 1POST /v1/economics/studyspecified

The caller sends PricingStudyInput to /v1/economics/study. The platform returns a card whose body is PricingStudy.

POST/v1/economics/studya task, 202

Si.economics.study. The call needs the platform rung under a token with the act grant, and it is served by the platform.

The route takes PricingStudyInput and returns a card whose body is PricingStudy.

Request body#

The request body is PricingStudyInput.

field	type	required
`methods`	Method	yes
`kinds_of_buyer`	`[id]`	yes
`window`	Window	yes

Response#

The route returns a card whose body is PricingStudy. 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. This route runs as a long step and returns a task with status 202. POST /v1/work/status returns the task’s progress, and POST /v1/work/cancel stops the task.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`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 platform rung and a token with the act grant. The platform serves this route.

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/economics/study \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "methods": [], "kinds_of_buyer": [], "window": { "from": "…", "to": "…" } }'

import { client } from "@scale/sdk";
const answer = await client.economics.study({
    "methods": [],
    "kinds_of_buyer": [],
    "window": {
      "from": "…",
      "to": "…"
    }
  });
// answer.body is a PricingStudy. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/economics/study",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "methods": [],
      "kinds_of_buyer": [],
      "window": {
        "from": "…",
        "to": "…"
      }
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/economics/study")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&PricingStudyInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.economics.study 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/PricingStudy. The tool’s page describes it.

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

{
  "methods": [],
  "kinds_of_buyer": [],
  "window": {
    "from": "…",
    "to": "…"
  }
}

Without a key, this page shows the request only. The request body is PricingStudyInput, and the route returns a card whose body is PricingStudy.

Claims#

claim	state	route or tool
The platform serves the route /v1/economics/study at contract 0476e35e6e275db5.	target	`/v1/economics/study`