Skip to content

Latest commit

 

History

History
32 lines (27 loc) · 12.2 KB

eventslistrequest.md

File metadata and controls

32 lines (27 loc) · 12.2 KB

EventsListRequest

Example Usage

import { EventsListRequest } from "@polar-sh/sdk/models/operations/eventslist.js";

let value: EventsListRequest = {
  organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
};

Fields

Field Type Required Description
filter string ➖ Filter events following filter clauses. JSON string following the same schema a meter filter clause.
startTimestamp Date ➖ Filter events after this timestamp.
endTimestamp Date ➖ Filter events before this timestamp.
organizationId operations.EventsListQueryParamOrganizationIDFilter ➖ Filter by organization ID.
customerId operations.EventsListQueryParamCustomerIDFilter ➖ Filter by customer ID.
externalCustomerId operations.EventsListQueryParamExternalCustomerIDFilter ➖ Filter by external customer ID.
meterId string ➖ Filter by a meter filter clause.
name operations.NameFilter ➖ Filter by event name.
source operations.SourceFilter ➖ Filter by event source.
query string ➖ Query to filter events.
parentId string ➖ When combined with depth, use this event as the anchor instead of root events.
depth number ➖ 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 number ➖ Page number, defaults to 1.
limit number ➖ Size of a page, defaults to 10. Maximum is 100.
sorting components.EventSortProperty[] ➖ 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 Record<string, components.MetadataQuery> ➖ Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.