Get a list of User's events

Get a list of user events

Parameter

Accessible via URL http://api.channel.io/open/v4/users/{userId}/events and HTTP GET

Parameter

Example

Required

Description

Parameter type

userId

12345

Required

ID of User

Path

since

500000

Optional

Epoch time in microseconds of the first message to be retrieved.
If the since parameter is left empty, the list retrieved will start with the first message (as specified by the order parameter).

Qeury

sortOrder

desc (or asc)

Required

Sorting order.

  • available values : asc, desc, both
  • default value : desc

Query

limit

40

Optional

Restrict the maximum number of results

  • min : 1
  • max : 500
  • default : 25

Query

Example

GET http://api.channel.io/open/v4/users/12345/events?limit=40&since=500000&sortOrder=desc

Response

Returns a set of event along with related information.

{
  "prev": "string",
  "next": "string",
  "events": [
    {
      "userId": "string",
      "id": "string",
      "channelId": "string",
      "name": "string",
      "property": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "createdAt": 1624422342386,
      "expireAt": 1624422342387,
      "version": 0
    }
  ]
}