---
title: "read: plan report"
description: "a strategy and a window (`PlanReportInput`) to each play completed, partial or missing, and the items done off plan"
section: reference
address: /reference/read/plan_report
contract: 0476e35e6e275db5
---
# read: plan report
a strategy and a window (`PlanReportInput`) to each play completed, partial or missing, and the items done off plan
[figure: The caller sends PlanReportInput to /v1/read/plan_report. The platform returns a card whose body is PlanReport.]
POST/v1/read/plan_report
Read the report of a plan. The call needs the strategy rung under a token with the read grant, and it is served by the platform.
The route takes [PlanReportInput](/concepts/planreportinput) and returns a card whose body is [PlanReport](/concepts/planreport).
## Request body
The request body is [PlanReportInput](/concepts/planreportinput).
| field | type | required | note |
|---|---|---|---|
| `strategy` | `id` | yes | |
| `window` | [Window](/concepts/window) | no | |
## Response
The route returns a card whose body is [PlanReport](/concepts/planreport). 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/, 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 strategy rung and a token with the read grant. The platform serves this route.
## Example
The example sends the smallest body that PlanReportInput allows. The build validates it against the schema of PlanReportInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/read/plan_report \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "strategy": "…" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.read.plan_report({
"strategy": "…"
});
// answer.body is a PlanReport. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/plan_report",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"strategy": "…"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/plan_report")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&PlanReportInput { /* the fields of the page */ }).send().await?.json().await?;
```