Segments allow Admins to create saved groups of users and are used as part of the Campaigns feature to send targeted messages at scale.
Segments are dynamic groups of users. Users are part of a given segment based on selected attributes of their Gainfully platform data. Users cannot be manually added or removed from a given segment.
To get started, navigate to the Admin menu and select Segments > + CREATE.
After naming the segment, you can begin defining the query with rules and groups.
Select ADD RULE and then choose an Attribute to begin building your query. After choosing from the drop down menu of Attributes, choose/enter the Option and Value.
Some Attributes will offer a drop down menu of Values, while others will require you to enter text.
You can add multiple rules within a group. You can also add multiple groups.
Rules within a given group will always be related by the AND clause. Rules between groups will always be related by the OR clause. This logic applies to level 1 groups.
The exception to this is level 2 groups, which will always be related by the AND clause. See the examples below for level 1 vs. level 2 groups.
Level 1 groups using the OR clause
Level 2 groups using the AND clause
Adding level 1 and level 2 groups
In the below example, the query will return:
1) all users who are connections of the Putnam organization who are licensed in Arizona
2) all users who are connections of the Putnam organization who are licensed in New York
Note the same result can be found by using a comma in between the states for the finra_registered_states Value as shown below. The comma allows you to use just one group.
Check out additional sample queries by selecting the HELP button from the Admin menu.
Attributes can have one of the following types: String, Integer, Boolean, Date.
See the definitions and examples below:
Organization: type string, is the organization with whom a user can be connected with.
Relationship type: type string, is the relationship type of a user with an organization.Possible values: member or connection.
finra_basic_info.bc_scope: type string, says if user is an active Broker regulated by FINRA.Possible values: Active or Inactive.
finra_basic_info.ia_scope: type string, says if user is an active Investment Adviser. SEC sitePossible values: Active or Inactive.
finra_basic_info.date_in_industry: type date, represents starting date in industry.
finra_basic_info.id: type integer, represents CRD number of user
finra_current_employments.bc_scope: type string, says if user is currently employed by a Broker-Dealer firm.Possible values: ACTIVE or INACTIVE.
finra_current_employments.branch_office.id: type integer, represents branch office id of current employer firm.
finra_current_employments.branch_office.zip_code: type string, represents branch office zip code of current employer firm.
finra_current_employments.ia_scope: type string, says if user is currently employed by an Investment Adviser firm.Possible values: ACTIVE or INACTIVE.
finra_current_employments.id: type integer, represents branch office CRD number
finra_current_employments.name: type string, represents current employer firm name.
finra_registered_sro: type string, represents SRO Registrations of that user.Example values: FINRA.
finra_registered_state: type string, states where user has a valid FINRA license.Example values: Arizona, California, Colorado.
finra_product_exam_category: type string, represents name of category of passed product examinations.Example values: Series 63, Series 65.
finra_state_exam_category: type string, represents name of category of passed state examinations.Example values: Series 7, SIE.
nipr_licensing_states: type string, state abbreviations where user has a valid NIPR license.Example values: DE, PA.
Options is the operator that establishes the connection between <attribute> and <value>.
Depending on the attribute type, <option> tan take one of the following values:
- equals: must be an exact match, case sensitive.
- not equals: must be different, case sensitive.
- in: must be one of [value1, value2, ...]
- excludes: must not be any of [value1, value2, ...]
- contains: must match part of a string
- exists: property must be defined
- not exists: property must not be defined
- =, >, ≥, <, ≤.