Get user events

This method allows you to get events that the user has performed in chronological order (from the newest to the oldest).

URL

GET https://api.dashly.app/users/{id}/events

For {id} you can use:

  • Dashly ID
  • User ID (add by_user_id=true parameter) 400 LookupError will be returned if there's no user with such id.

Parameters

Authentification parameters. Pagination. Pagination by Event object primary key.
id_as_string parameter.

Parameter Type Description
by_user_id Optional[boolean] Should be true in case you're using User ID instead of Dashly ID. Default: false
filter_name Optional[String] Specify event name to get only this event type
props_as_string Optional[boolean] If true, events properties will be returned as strings. Default: false
app Optional[ID] ID of requesting application. Default: calculated based on access token.

Note

Events properties might sometimes contain long integers which are misinterpreted by browser (64-bit numbers browser interpretation). id_as_string parameter does not affect events properties. Add props_as_string=true parameter to get all event's properties as strings.

Response

data field contains Conversation objects. meta field contains pagination parameters.

{
  "meta": {
    "next_before_position": [7936756],
    "status": 200
  },
  "data": [
    {
      "id": 335704586,
      "created": 1467192929,
      "type": {
        "id": 5857,
        "name": "MyEvent",
        "score": 0,
        "visible": true
      },
      "user": 22735768,
      "props": {
        "App": "Eva99"
      }
    },
    ...
  ]
}

Exceptions

Standart Web API exceptions

Example

Get all events of a user:

curl -X GET  -H "Authorization: Token XXX" "https://api.dashly.app/users/8173131/events"

Get events with name MyEventOne:

curl -X GET  -H "Authorization: Token XXX" "https://api.dashly.app/users/8173131/events?filter_name=MyEventOne"