Create report
Composes and files a report from one estate read, so the same figures read the same a month later.
POST /v1/patrol/report
| Address | https://api.hanzo.ai/v1/patrol/report |
| Method | POST |
| Operation | post_patrol_report |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Composes and files a report from one estate read, so the same figures read the same a month later. The text is stored on the document; the PDF is produced on read at /v1/patrol/report/{name}.
A client report naming a customer is an account of that customer's estate and is theirs to download; naming none covers every customer, which is an account of the operation.
Request
5 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
client | body | string | — | Client is the customer to report on, read by kind client. |
from | body | string | — | From is the start of the window to cover. |
incident | body | string | — | Incident is the incident to report on, required for kind incident. |
kind | body | string | — | Kind is shift, incident or client. |
to | body | string | — | To is the end of that window. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | patrol.patrolReportOut | created |
default | problem-details | refused |
201 body — 9 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolReport | — | |
data.at | body | string | — | At is when it was filed. |
data.body | body | string | — | Body is the report as text. |
data.client | body | string | — | Client is the customer it is about, or empty. |
data.from | body | string | — | From is the start of the window the report covers. |
data.incident | body | string | — | Incident is the incident it is about, or empty. |
data.kind | body | string | — | Kind is shift, incident or client. |
data.name | body | string | — | Name is the report's document name and the segment /v1/patrol/report/{name} addresses it by. |
data.to | body | string | — | To is the end of that window. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol report createimport { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPatrolReport({ client: "<client>", from: "<from>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).post_patrol_report(client="<client>", from="<from>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.PostPatrolReport(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, patrol_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = patrol_api::post_patrol_report(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new PatrolApi(client).postPatrolReport();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/patrol/report \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"client": "<client>",
"from": "<from>"
}'MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?