Person Object
Always present (compact or detailed):
Field | Description | Type | Required? | ||||||
---|---|---|---|---|---|---|---|---|---|
id | Unique ID | string | Yes | ||||||
engagement_score_me_to_them | Score of how engaged the querying user is with this person | number | Yes | ||||||
engagement_score_them_to_me | Score of how engaged this person is with the querying user | number | Yes | ||||||
name | Person's name. | string | |||||||
photo_url |
Profile photo URL for this person, if there is one. This url will have an undetermined natural size. Specific sizes can be requested using the following parameters, appended to the URL:
|
string | |||||||
networks |
Array describing network identities that have been
rolled into this person object and their relationship to the
querying user. Will be in this form:
{ network: <network1>, network_id: <network ID>, relationship: [<relationship to user>], profile_url: <url> } , { network: <network2>, network_id: <network ID>, relationship: [ <relationship1 to user>, <relationship2 to user> ] , profile_url: <url> } |
array |
Detailed fields:
Field | Description | Type | Required? | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Person's email address | string | ||||||||||||
phone | Person's phone number | string | |||||||||||
edges |
Object describing the entities related to this person. Form will be: { <entity_type> : { "count": <total count for type>, "rel_types": { <relation type>: { "count": <count for rel type> } } } } For a person, the related entities may include:
|
object | |||||||||||
engagement_me_to_them |
Object describing the history of engagement from the querying user to this person. Example: { "shared_photo" : 44, "shared_checkin" : 1, "like" : 5, "mention" : 11, "shared_like" : 1 } |
object | |||||||||||
engagement_them_to_me |
Object describing the history of engagement from this person to the querying user. Example: { "shared_photo" : 44, "shared_checkin" : 1, "photo_mention" : 16, "like" : 6, "shared_like" : 1, "mention" : 5, "comment" : 2 } } |
object |