> ## Documentation Index
> Fetch the complete documentation index at: https://iyree.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Reports
The Reports sub-client lets you create reports tied to an IYREE source function and the job that produced their rendered HTML.
```python theme={null}
from datetime import datetime
from iyree import IyreeClient, ReportPeriod
with IyreeClient(api_key="my-key") as client:
report = client.reports.create(
main_period=ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
),
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="...",
)
print(report.id)
```
***
## `create`
Create a new report. The SDK serializes `datetime` instances inside `main_period` and `compare_period` to ISO-8601 strings automatically, and drops any optional argument left as `None` from the request body.
```python theme={null}
report = client.reports.create(
main_period=ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
),
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="Weekly summary",
title="Weekly summary",
locations=[1, 2, 3],
)
```
### Parameters
Primary date range covered by the report. Pass a `ReportPeriod` dataclass or a plain dict with `date_from` and `date_to` keys (`datetime` values are accepted and serialized automatically).
```python theme={null}
from iyree import ReportPeriod
main_period = ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
)
# or equivalently
main_period = {"date_from": datetime(2026, 1, 1), "date_to": datetime(2026, 1, 31)}
```
Path identifying the source function that generated the report (e.g. `"f/iyree/reports/weekly"`).
Identifier of the job that produced the report.
Rendered HTML payload of the report.
Optional report title.
Optional report description.
Optional location identifiers the report is scoped to.
Optional comparison date range. Same shape as `main_period`.
Optional summary text.
Optional report name.
Optional workspace identifier.
### Returns `Report`
Server-assigned report identifier.
Report name.
Report title.
Report description.
How the report was created (e.g. `"PREDEFINED"`).
Function the report was generated from, or `None` if not provided by the server.
Function identifier.
Function name.
Function title.
Function description.
How the function was created (e.g. `"PREDEFINED"`).
Function type (e.g. `"basic"`).
Function status (e.g. `"active"`).
Location identifiers the report is scoped to. Empty list if none.
Primary date range covered by the report.
Start of the period.
End of the period.
Optional comparison date range, or `None` when not set. Same shape as `main_period`.
Summary text.
Rendered HTML payload returned by the server.
Job that produced this report, or `None` if not provided by the server.
Job identifier.
Path of the executed script.
Job kind (e.g. `"unknown"`).
Free-form trigger details (e.g. `{"type": "webapp"}`).
Job status (e.g. `"running"`).
Whether the job finished successfully.
Job creation timestamp.
Job start timestamp.
Total job duration in milliseconds.
Peak memory usage in kilobytes.
Whether the job is a step inside a flow.
Type of the underlying runnable (e.g. `"function"`).
Identifier of the underlying runnable.
### Errors
| Exception | Condition |
| ---------------------- | ----------------------------------------------- |
| `IyreeValidationError` | HTTP 422 — invalid payload |
| `IyreeNotFoundError` | HTTP 404 — referenced function or job not found |
| `IyreeAuthError` | Invalid API key |
| `IyreeTimeoutError` | Request timed out |
| `IyreeError` | Other HTTP errors |
### Examples
```python Minimal theme={null}
from datetime import datetime
from iyree import IyreeClient, ReportPeriod
with IyreeClient(api_key="my-key") as client:
report = client.reports.create(
main_period=ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
),
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="...",
)
print(report.id)
```
```python With compare_period theme={null}
from datetime import datetime
from iyree import IyreeClient, ReportPeriod
with IyreeClient(api_key="my-key") as client:
report = client.reports.create(
main_period=ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
),
compare_period=ReportPeriod(
date_from=datetime(2025, 12, 1),
date_to=datetime(2025, 12, 31),
),
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="...",
title="January vs December",
summary="Month-over-month comparison",
)
print(report.compare_period.date_from)
```
```python Dict periods theme={null}
from datetime import datetime
report = client.reports.create(
main_period={
"date_from": datetime(2026, 2, 1),
"date_to": datetime(2026, 2, 28),
},
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="...",
)
```
```python Scoped to locations theme={null}
report = client.reports.create(
main_period=ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
),
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="...",
locations=[1, 2, 3],
workspace_id="ws_42",
)
```
```python Async theme={null}
from datetime import datetime
from iyree import AsyncIyreeClient, ReportPeriod
async with AsyncIyreeClient(api_key="my-key") as client:
report = await client.reports.create(
main_period=ReportPeriod(
date_from=datetime(2026, 1, 1),
date_to=datetime(2026, 1, 31),
),
function_path="f/iyree/reports/weekly",
job_id="job-123",
html_content="...",
)
print(report.id)
```