GET /api/entity/{table}/{fieldname}/{fieldval}

Personalization

Get single User Entity.

# get user whose user_id = user123
curl -s -H "Authorization: $LIOKEY" \
  -XGET "https://api.lytics.io/api/entity/user/user_id/user123" | jq '.'

# get user whose email = aaron@aaron.com
curl -s -H "Authorization: $LIOKEY" \
  -XGET "https://api.lytics.io/api/entity/user/email/aaron@aaron.com" | jq '.'

get/api/entity/{table}/{fieldname}/{fieldval}

Request

Base URL
https://api.lytics.io
URL
https://api.lytics.io/api/entity/{table}/{fieldname}/{fieldval}
Auth
API key in header Authorization

Path parameters

tablestring required

fieldnamestring required

fieldvalstring required

Field value of identity

Query parameters

account_idstring

Your Lytics account ID.

fieldsstring

comma delimited field list to be returned

fieldBlockliststring

comma delimited list of fields to exclude

include_fieldsboolean

if true include all the whitelisted fields

segmentsboolean

Should segments this user is member of be included?

metaboolean

Should Meta Fields be included?

downloadboolean

Should the content-disposition header set to attachment to download the user as a file?

Response

messagestring

statusnumber

Example response

{
  "data": {
    "segments": [
      "email_us_based",
      "web_users",
      "all"
    ]
  },
  "message": "success",
  "meta": {
    "by_fields": [
      "user_id",
      "email",
      "fbuid",
      "_uids"
    ],
    "format": "json",
    "name": "user"
  },
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.