cfw-autumn/others/python-sdk/docs/sdks/events/README.md

Events

Overview

Available Operations

• list - List usage events for your organization. Filter by customer, feature, or time range.
• aggregate - Aggregate usage events by time period. Returns usage totals grouped by feature and optionally by a custom property.

list

List usage events for your organization. Filter by customer, feature, or time range.

Example Usage

from autumn_sdk import Autumn


with Autumn(
    x_api_version="2.1",
    secret_key="<YOUR_BEARER_TOKEN_HERE>",
) as autumn:

    res = autumn.events.list(offset=0, limit=50, customer_id="cus_123")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
offset	Optional[int]	➖	Number of items to skip
limit	Optional[int]	➖	Number of items to return. Default 100, max 1000.
customer_id	Optional[str]	➖	Filter events by customer ID
feature_id	Optional[models.ListEventsFeatureID]	➖	Filter by specific feature ID(s)
custom_range	Optional[models.ListEventsCustomRange]	➖	Filter events by time range
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ListEventsResponse

Errors

Error Type	Status Code	Content Type
errors.AutumnDefaultError	4XX, 5XX	*/*

aggregate

Aggregate usage events by time period. Returns usage totals grouped by feature and optionally by a custom property.

Example Usage

from autumn_sdk import Autumn


with Autumn(
    x_api_version="2.1",
    secret_key="<YOUR_BEARER_TOKEN_HERE>",
) as autumn:

    res = autumn.events.aggregate(customer_id="cus_123", feature_id="api_calls", range="30d", bin_size="day")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
customer_id	str	✔️	Customer ID to aggregate events for
feature_id	models.AggregateEventsFeatureID	✔️	Feature ID(s) to aggregate events for
group_by	Optional[str]	➖	Property to group events by. If provided, each key in the response will be an object with distinct groups as the keys
range	Optional[models.Range]	➖	Time range to aggregate events for. Either range or custom_range must be provided
bin_size	Optional[models.BinSize]	➖	Size of the time bins to aggregate events for. Defaults to hour if range is 24h, otherwise day
custom_range	Optional[models.AggregateEventsCustomRange]	➖	Custom time range to aggregate events for. If provided, range must not be provided
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AggregateEventsResponse

Errors

Error Type	Status Code	Content Type
errors.AutumnDefaultError	4XX, 5XX	*/*