Search Filters
From Social ID Developers
Revision as of 14:05, 8 July 2016 by Gabriel.prado (Talk | contribs)
The standard used in contact search is "SQL-like": the syntax is very similar with what we use to query relational databases. Some examples:
SQL | People Search API | select * from profile where profile.gender = 'male' | profile.gender = 'male' | select * from profile where profile.gender = 'male' or profile.religion = 'Atheist' | profile.gender = 'male' or profile.religion = 'Atheist' |
---|
Contents |
Logical Operators
Code | Operation | Example | and | Conjunction | profile.name.formatted = 'Guilherme Silva' and profile.gender = 'male' | or | Disjunction | profile.name.formatted = 'Guilherme Silva' or profile.gender = 'male' | not | Negation | not profile.gender = 'male' |
---|
Relational Operators
Code | Operation | Example | = | Equality | profile.name.formatted = 'Guilherme Silva' | != | Difference | profile.name.formatted != 'Guilherme Silva' | < | Lesser than | profile.id < 100 | > | Greater than | profile.id > 100 | <= | Lesser than or equals | profile.id <= 100 | >= | Greater than or equals | profile.id >= 100 | like | "like" operator | profile.name.given_name like 'Guilher%' | between | Between :A and :B | profile.id between 1 and 3 | in | "in" operator | profile.id IN (100, 99, 104) | is null | Attribute is null | profile.religion is null | is not null | Attribute is not null | profile.religion is not null |
---|
Namespaces
The fields can be specified in the "namespace.field_name" standard. We have the following namespaces and fields:
person
Field | Description | person.id | Identification number | person.email | Email address | person.created | Creation date/time | person.updated | Date/time of the last update |
---|
profile
Field | Description | profile.display_name | Display name | profile.name.formatted | Full name | profile.name.family_name | Last name | profile.name.middle_name | Middle name | profile.name.given_name | First name | profile.name.honorific_prefix | Honorific (prefix) | profile.name.honorific_suffix | Honorific (suffix) | profile.nickname | Nickname | profile.updated | Date/time of the last update | profile.birthday | Birthday | profile.gender | Gender | profile.preferred_username | Preferred username | profile.utf_offset | UTC offset | profile.about_me | About me | profile.current_location | Current location | profile.religion | Religion | profile.status | Last Twitter status, if available | profile.emails.value | profile.emails.type | profile.emails.primary | profile.urls.value | profile.urls.type | profile.urls.primary | profile.phone_numbers.value | profile.phone_numbers.type | profile.ims.value | profile.ims.type | profile.languages_spoken.name | profile.languages_spoken.level | profile.addresses.formatted | profile.addresses.street_address | profile.addresses.locality | profile.addresses.region | profile.addresses.postal_code | profile.addresses.country | profile.organizations.name | profile.organizations.department | profile.organizations.title | profile.organizations.type | profile.organizations.start_date | profile.organizations.end_date | profile.organizations.location | profile.organizations.description | profile.organizations.primary | profile.educations.name | profile.educations.type | profile.educations.start_date | profile.educations.end_date | profile.educations.description | profile.educations.degree | profile.interests.name | profile.interests.category | profile.interests.link | profile.likes.name | profile.likes.category | profile.likes.link | profile.political_views | profile.picture_url | profile.profile_url | profile.locale | profile.verified_account | profile.verified_email | profile.hometown | profile.interested_in_meeting | profile.quotes | profile.significant_other | profile.industry | profile.professional_headline | profile.specialties | profile.honors |
---|
custom
The custom fields that can be used for search depend on the custom fields created on Webforms. Each marketing account has its own collection of custom fields. To search on these fields you can simply create rules using "custom.field_name".
login_app
Field | Description | login_app.id | Login app identification number |
---|
campaign
Field | Description | campaign.id | Campaign identification number |
---|