Events

January 26, 2026 · View on GitHub

(events)

Overview

Available Operations

list - List Events
list_names - List Event Names
get - Get Event
ingest - Ingest Events

list

List events.

Scopes: events:read events:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.list(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`filter_`	OptionalNullable[str]	:heavy_minus_sign:	Filter events following filter clauses. JSON string following the same schema a meter filter clause.
`start_timestamp`	date	:heavy_minus_sign:	Filter events after this timestamp.
`end_timestamp`	date	:heavy_minus_sign:	Filter events before this timestamp.
`organization_id`	OptionalNullable[models.EventsListQueryParamOrganizationIDFilter]	:heavy_minus_sign:	Filter by organization ID.
`customer_id`	OptionalNullable[models.EventsListQueryParamCustomerIDFilter]	:heavy_minus_sign:	Filter by customer ID.
`external_customer_id`	OptionalNullable[models.EventsListQueryParamExternalCustomerIDFilter]	:heavy_minus_sign:	Filter by external customer ID.
`meter_id`	OptionalNullable[str]	:heavy_minus_sign:	Filter by a meter filter clause.
`name`	OptionalNullable[models.NameFilter]	:heavy_minus_sign:	Filter by event name.
`source`	OptionalNullable[models.SourceFilter]	:heavy_minus_sign:	Filter by event source.
`query`	OptionalNullable[str]	:heavy_minus_sign:	Query to filter events.
`parent_id`	OptionalNullable[str]	:heavy_minus_sign:	When combined with depth, use this event as the anchor instead of root events.
`depth`	OptionalNullable[int]	:heavy_minus_sign:	Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.
`page`	Optional[int]	:heavy_minus_sign:	Page number, defaults to 1.
`limit`	Optional[int]	:heavy_minus_sign:	Size of a page, defaults to 10. Maximum is 100.
`sorting`	List[models.EventSortProperty]	:heavy_minus_sign:	Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
`metadata`	Dict[str, models.MetadataQuery]	:heavy_minus_sign:	Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.EventsListResponseEventsList

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	/

list_names

List event names.

Scopes: events:read events:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.list_names(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
`organization_id`	OptionalNullable[models.EventsListNamesQueryParamOrganizationIDFilter]	:heavy_minus_sign:	Filter by organization ID.
`customer_id`	OptionalNullable[models.EventsListNamesQueryParamCustomerIDFilter]	:heavy_minus_sign:	Filter by customer ID.
`external_customer_id`	OptionalNullable[models.EventsListNamesQueryParamExternalCustomerIDFilter]	:heavy_minus_sign:	Filter by external customer ID.
`source`	OptionalNullable[models.QueryParamSourceFilter]	:heavy_minus_sign:	Filter by event source.
`query`	OptionalNullable[str]	:heavy_minus_sign:	Query to filter event names.
`page`	Optional[int]	:heavy_minus_sign:	Page number, defaults to 1.
`limit`	Optional[int]	:heavy_minus_sign:	Size of a page, defaults to 10. Maximum is 100.
`sorting`	List[models.EventNamesSortProperty]	:heavy_minus_sign:	Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.EventsListNamesResponse

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	/

get

Get an event by ID.

Scopes: events:read events:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.get(id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`id`	str	:heavy_check_mark:	The event ID.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.Event

Errors

Error Type	Status Code	Content Type
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	/

ingest

Ingest batch of events.

Scopes: events:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.ingest(request={
        "events": [],
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`request`	models.EventsIngest	:heavy_check_mark:	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.EventsIngestResponse

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	/