latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Events

Returns a list of events

Gets events, extending back 30 days, filtered by the specified path parameter.

get/events

Query parameters

createdTimeobject

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt—return values where the createdTime field is after this timestamp
  • gte—return values where the createdTime field is after or equal to this timestamp
  • lt—return values where the createdTime field is before this timestamp
  • lte—return values where the createdTime field is before or equal to this timestamp
endingBeforestring

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstring

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

typestring

Represents a specific event name, or a group of events using * as a wildcard. The returned list is filtered to include only matching events. You may pass either <code>type</code> or <code>types</code>, but not both.

typesstring

An array containing less than 20 specific event names. The returned list is filtered to include only matching events. You may pass either <code>type</code> or <code>types</code>, but not both.

Response

200 OK. The response contains a <code>data</code> attribute that consists of an array. Each entry in the array is a separate event object.

hasMoreboolean

Indicates whether more elements are available. If <code>false</code> this set represents the end of the list.

Example response

{
  "hasMore": true,
  "data": [
    {
      "createdTime": "2018-08-29T09:12:33Z",
      "digitalRiverVersion": "2018-04-19",
      "liveMode": true,
      "type": "charge.succeeded"
    }
  ]
}