POpolar
events
public

List Events

Changed on

List events.

Scopes: events:read events:write

get/v1/events/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/events/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: events:read, events:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

filterstring nullable

Filter events following filter clauses. JSON string following the same schema a meter filter clause.

start_timestampstring date-time nullable

Filter events after this timestamp.

end_timestampstring date-time nullable

Filter events before this timestamp.

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737
string uuid4

The customer ID.

OR
string[]
string
OR
string[]
meter_idstring uuid4 nullable

The meter ID.

Filter by a meter filter clause.

string
OR
string[]
'system' | 'user'
OR
EventSource[]
querystring nullable

Query to filter events.

parent_idstring uuid4 nullable

The event ID.

When combined with depth, use this event as the anchor instead of root events.

depthinteger nullable

Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingEventSortProperty[] nullable

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.

metadataMetadataQuery nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

OR

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

  • 7059aba15124Revision changes
    • breaking

      added to the ////// response property oneOf list for the response status

    • breaking

      added to the ////// response property oneOf list for the response status

    • info

      added order.unvoided subscription.reinstated discriminator mapping keys to the ////// response property for the response status

    • info

      added order.unvoided subscription.reinstated discriminator mapping keys to the ////// response property for the response status