Margin queries

Margin methods are synchronous and available under nozle.margin.

from nozle import Nozle

nozle = Nozle()  # reads NOZLE_SECRET_KEY

summary = nozle.margin.summary(
    from_date="2026-07-01",
    to_date="2026-07-31",
)

customers = nozle.margin.by_customer(from_date="2026-07-01")
metrics = nozle.margin.by_metric()
plans = nozle.margin.by_plan()
models = nozle.margin.by_model()

Methods

Method	Endpoint	Purpose
`summary(**params)`	`/summary`	Aggregate margin summary.
`by_customer(**params)`	`/customers`	Margin grouped by customer.
`by_metric(**params)`	`/metrics`	Margin grouped by Feature.
`by_plan(**params)`	`/plans`	Margin grouped by plan.
`by_model(**params)`	`/models`	Margin grouped by model.
`trend(granularity, **params)`	`/trend`	Time-series margin data.

All non-None keyword arguments are forwarded as string query parameters. Use the parameter names expected by your deployed API.

Date filters

from_date and to_date are aliases for the API’s from and to. Each takes a YYYY-MM-DD date or an RFC3339 timestamp. A plain date to_date includes that whole day; an RFC3339 value is an exclusive instant. If you send only one end, the API derives the other (only to_date: the month before it; only from_date: until now). An unparseable value, or an end that is not after the start, returns 400 with {"code": "invalid_date_range", "error": "..."}.

Trend granularity

trend = nozle.margin.trend(
    granularity="day",
    from_date="2026-07-01",
    to_date="2026-07-31",
)

granularity accepts hour, day, week, or month and defaults to day.

Result typing

Margin responses are typed as Any. Validate or narrow them before relying on their fields.

summary = nozle.margin.summary(from_date="2026-07-01")

if not isinstance(summary, dict):
    raise TypeError("Unexpected margin response")

The Margin Simulate API is not exposed by the Python SDK. Call the Margin simulate API directly from your backend.

Setup

Billing

Customers

Entitlements

Margin Intelligence

LLM Usage

Margin queries

Methods

Date filters

Trend granularity

Result typing

​Methods

​Date filters

​Trend granularity

​Result typing

Methods

Date filters

Trend granularity

Result typing