personalizer.io Documentation

Help Page Home

GET v1/Users

Loads the user profile information.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

UserProfile
NameTypeDescriptionComments
Age integer

Gender Gender

RelationshipStatus RelationshipStatus

HomeTown string

Location string

FreeText string

Used to feed the engine with any sort of descriptive or tag-based (e.g. comma-separated) text that could help the engine learn more about the user (e.g. Bio, Recent social status updates, etc).

InterestCategories Collection of string

List of high level user interest categories (e.g. Literature, Sports, Music, etc).

InterestKeywords Collection of string

List of keywords describing specific user interests (e.g. Poetry, Basketball, Rolling Stones, Technology, Rock and Roll, etc).

FirstName string

LastName string

FacebookUsername string

Used to identify the user accross other profiling sources.

TwitterHandle string

Used to identify the user accross other profiling sources.

EmailAddress string

Used to identify the user accross other profiling sources.

CellPhone string

Used to identify the user accross other profiling sources.

Response Formats

application/json, text/json

Sample:
{
  "Age": 20,
  "Gender": "Male",
  "RelationshipStatus": "Single",
  "HomeTown": "Winterfell",
  "Location": "Castle Black",
  "FreeText": "Jon Snow is a major character in the first, second, third, fourth and fifth seasons. / Lord Snow,Stark,Night's Watch",
  "InterestCategories": [
    "Fight",
    "Sports"
  ],
  "InterestKeywords": [
    "Night's Watch",
    "Castle Black",
    "Sword"
  ],
  "FirstName": "Jon",
  "LastName": "Snow",
  "FacebookUsername": "JonSnow",
  "TwitterHandle": "@JonSnow",
  "EmailAddress": "jonsnow@castleblack.com",
  "CellPhone": "2005667669"
}