Get user data

This method returns all user’s data.

URL

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

For {id} you can use:

• Dashly ID
• Your User ID (in case user with such ID does not exist, new user with such ID is created)

Arguments

This method follows the general rules. Arguments are transmitted as GET or POST parameters.

Argument	Description
auth_token	Required. Authorization token (requires scope: user-read)
by_user_id	Optional. Set to true in case User ID is used for access. Default: false.
props	Get standard (system) properties. Default: true
props_events	Get properties, created by performed events. Default: false
props_custom	Get custom properties. Default: false
presence_details	Get detailed information on user status. Default: false
events	Get properties, created by performed events (more convenient). Default: false
segments	Get user’s segments. Default: false
notes	Get user’s notes. Default: false

Answer

{
  "meta": {
    "status": 200
  },
  "data": {
    "id": 96,
    "app": 1,

    "user_id": "124",

    "presence": "idle",
    "presence_details": {
      ...
    },

    "props": {
      "$name": "sdsd",
      "$email": "materkov@gmail.com",
      "$sessions": 50,
      ...
    },
    "props_events": {
      "$event_31_first": "2015-12-10T08:20:23",
      "$event_31_first": "2015-12-16T10:45:13",
      "$event_31_count": 1,
      ...
    },
    "props_custom": {
      "dao1": "value2",
      "dao2": ["9", "18", "21"],
    },

    "events": [
      {
        "first": 1450262713,
        "last": 1450265101,
        "count": 10,
        "event_type": {
          "id": 31,
          "name": "event4",
          "score": 10
        }
      },
      ...
    ],

    "notes": [
      ...
    ],

    "segments": [
      {
        "id": 4,
        "app": 1,
        "name": "Has name",
        "filters": "..."
      },
      ...
    ]
  }
}

Returns User object.

Returns basic data by default: id, app, user_id, presence, props.

Set true for corresponding arguments to get expanded data (props_events, props_custom, events, presence_details, notes, segments).

Example

curl -X GET https://api.dashly.app/v1/users/8173131?auth_token=XXX