danger

You are viewing documentation for an older version.

Click here to view the latest documentation.

ID Types

Learn about the Entity ID types in your Profiles project.

You can use id_types to list the type of identifiers used in an ID stitcher. You can also use this parameter for creating entity_var and input_var. The data type of these identifiers must be string.

id_types:
  - name: user_id
    filters:
      - type: include/exclude
        value: "value"
      - type: include/exclude
        regex: "regex expression"
  - name: email
    maximum_edges:
      - user_id: 1
FieldDescription
name
Required
Name of the ID type.
filtersFilter(s) the ID types to include/exclude specific values. The filters are processed in the listed order.
maximum_edgesDefines cardinality rules that limit how many connections a node of an ID type can have to another node of other ID types.
typeFilter type - accepted values are include or exclude.
valueSpecify the value that should be matched exactly.
regexRegular expression to match.

Example

entities:
  - name: user
    id_column_name: user_rud_id
    id_types:
      - user_id
      - anonymous_id
      - email

id_types:
  - name: user_id
    maximum_edges:
      - email: 2
      - anonymous_id: 5
  - name: anonymous_id
    extends: user_id
    filters:
      - type: exclude
        value: "unknown"
      - type: exclude
        value: "NaN"
  - name: email
    filters:
      - type: include
        regex: "[A-Za-z0-9+_.-]+@(.+)"

Questions? Contact us by Email or on Slack