Get User

Get data about users who have been identified in the browser via the FS.identify Browser API function.

Path Parameters

uid string required

The application-specific ID you've given to the user. You will have passed that ID through the FS.identify Browser API function.

Responses

200

---

A successful response.

Schema

Example

---

Schema

uid string optional
display_name string optional
email string optional
custom_vars object optional
property name* object optional
str_val string optional
int_val int64 optional
real_val double optional
bool_val boolean optional
date_val date-time optional
num_sessions uint64 optional
first_seen date-time optional
last_seen date-time optional
existing_operation object optional

If this user is already being deleted, the existing delete operation details will be returned, and most of the other fields will be empty.

id string optional

The id of the operation.

type string optional

Possible values: [DELETE_USER, SEARCH_EXPORT, DELETE_SESSION, DELETE_SEGMENT_SESSIONS, DELETE_SEGMENT_USERS]

The type of the operation.

details object optional

May contain additional information about the operation. See Operation Results and Details for operation specific information.

results object optional

If the operation produces results and the operation completed successfully, this will contain information relevant to the type of operation. See Operation Results and Details for operation specific information.

state string optional

Possible values: [PENDING, COMPLETED, FAILED]

The current state of the operation.

error_details string optional

If the state is FAILED, this will contain a message describing why the operation failed.

created_at date-time optional

UTC RFC 3339 timestamp for when the operation was scheduled.

finished_at date-time optional

UTC RFC 3339 timestamp for when the operation finished, either successfully or with an error.

estimate_pct_complete int64 optional

A number from 0 to 100 that indicates an estimation of how much progress has been made on a pending operation.

step string optional

Indicator of the operation's current step which can provide non-quantitative information about an operation's progress.

{
  "uid": "10154",
  "displayName": "Daniel Falko",
  "email": "daniel@falko.com",
  "numSessions": "6",
  "firstSeen": "2018-02-07T11:28:18.771Z",
  "lastSeen": "2018-04-19T20:49:50.433Z"
}

Loading...