Reports

The Reports sub-client lets you create reports tied to an IYREE source function and the job that produced their rendered HTML.

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="<html><body>...</body></html>",
    )
    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.

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="<html><body>Weekly summary</body></html>",
    title="Weekly summary",
    locations=[1, 2, 3],
)

Parameters

ReportPeriod | Dict[str, Any]

required

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).

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)}

str

required

Path identifying the source function that generated the report (e.g. "f/iyree/reports/weekly").

str

required

Identifier of the job that produced the report.

str

required

Rendered HTML payload of the report.

str

Optional report title.

str

Optional report description.

List[int]

Optional location identifiers the report is scoped to.

ReportPeriod | Dict[str, Any]

Optional comparison date range. Same shape as main_period.

str

Optional summary text.

str

Optional report name.

str

Optional workspace identifier.

Returns `Report`

str

Server-assigned report identifier.

str

Report name.

str

Report title.

str

Report description.

str

How the report was created (e.g. "PREDEFINED").

ReportSourceFunction

Function the report was generated from, or None if not provided by the server.

Show ReportSourceFunction

str

Function identifier.

str

Function name.

str

Function title.

str

Function description.

str

How the function was created (e.g. "PREDEFINED").

str

Function type (e.g. "basic").

str

Function status (e.g. "active").

List[int]

Location identifiers the report is scoped to. Empty list if none.

ReportPeriod

Primary date range covered by the report.

Show ReportPeriod

datetime

Start of the period.

datetime

End of the period.

ReportPeriod

Optional comparison date range, or None when not set. Same shape as main_period.

str

Summary text.

str

Rendered HTML payload returned by the server.

ReportSourceJob

Job that produced this report, or None if not provided by the server.

Show ReportSourceJob

str

Job identifier.

str

Path of the executed script.

str

Job kind (e.g. "unknown").

Dict[str, Any]

Free-form trigger details (e.g. {"type": "webapp"}).

str

Job status (e.g. "running").

bool

Whether the job finished successfully.

datetime

Job creation timestamp.

datetime

Job start timestamp.

int

Total job duration in milliseconds.

int

Peak memory usage in kilobytes.

bool

Whether the job is a step inside a flow.

str

Type of the underlying runnable (e.g. "function").

str

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

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="<html><body>...</body></html>",
    )
    print(report.id)

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="<html><body>...</body></html>",
        title="January vs December",
        summary="Month-over-month comparison",
    )
    print(report.compare_period.date_from)

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="<html><body>...</body></html>",
)

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="<html><body>...</body></html>",
    locations=[1, 2, 3],
    workspace_id="ws_42",
)

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="<html><body>...</body></html>",
    )
    print(report.id)

Начало работы

Аналитика для ресторанов

BI функционал

Интеграции

`create`

Parameters

Returns `Report`

Errors

Examples

​create

​Parameters

​Returns Report

​Errors

​Examples

`create`

Parameters

Returns `Report`

Errors

Examples