Export user events

You can export user events using the ReachFive Console. This export allows you to retrieve all events or just the latest events. Exports are handled by jobs and can be executed on demand or scheduled as needed. You can export data in CSV or JSON format.

Why export user events?

When you export user events (as opposed to user profiles), you are able to then ingest these events into analytics tools such as Microsoft Customer Insights.

Understanding user events enables more in-depth analysis of what your customers are doing within your system such as updating emails, changing passwords, logging in, and so forth, thereby allowing you to leverage the capabilities of ReachFive and gather even more customer insight.

Exporting user events

The instructions below guide you step-by-step in exporting user events from the ReachFive Console. The visual below shows you a high-level flow of the process.

export events user flow

Prerequisites

  • You must have access to the ReachFive Console.

  • You must have a Developer, Manager, or Administrator role.

  • You must have the Export Jobs feature enabled.

Instructions

The instructions below apply to both creating and editing an export job definition.

If editing an existing export job, be sure to select the edit icon instead of creating a new definition.

  1. Go to Settings  Export definitions  User Events.

  2. Select New definition.

  3. Under General, give the export job a name and description. Don’t forget to Enable the job.

  4. Under Destination, choose the protocol you wish to use to export the file.

    • SFTP

    • S3

    • GCS

    1. Specify the Server host for the secure FTP site.

    2. Specify the Server port.

    3. Under Authentication method, choose the authentication method type:

      Username and password:

      1. Enter the Username for the server.

      2. Enter the Password for the server.

      OpenSSH:

      1. Enter the Username for the server.

      2. Enter the OpenSSH private key.

        example
        -----BEGIN ENCRYPTED PRIVATE KEY-----
MIIBpjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQI5yNCu9T5SnsCAggA
MBQGCCqGSIb3DQMHBAhJISTgOAxtYwSCAWDXK/a1lxHIbRZHud1tfRMR4ROqkmr4
kVGAnfqTyGptZUt3ZtBgrYlFAaZ1z0wxnhmhn3KIbqebI4w0cIL/3tmQ6eBD1Ad1
nSEjUxZCuzTkimXQ88wZLzIS9KHc8GhINiUu5rKWbyvWA13Ykc0w65Ot5MSw3cQc
w1LEDJjTculyDcRQgiRfKH5376qTzukileeTrNebNq+wbhY1kEPAHojercB7d10E
+QcbjJX1Tb1Zangom1qH9t/pepmV0Hn4EMzDs6DS2SWTffTddTY4dQzvksmLkP+J
i8hkFIZwUkWpT9/k7MeklgtTiy0lR/Jj9CxAIQVxP8alLWbIqwCNRApleSmqtitt
Z+NdsuNeTm3iUaPGYSw237tjLyVE6pr0EJqLv7VUClvJvBnH2qhQEtWYB9gvE1dS
BioGu40pXVfjiLqhEKVVVEoHpI32oMkojhCGJs8Oow4bAxkzQFCtuWB1
-----END ENCRYPTED PRIVATE KEY-----

    4. Specify the Path where the export file is to be sent.

      For example

      <serverhost>/path-to-file/file.csv.

      Example w/variables

      <serverhost>/path-to-file/file-{{datetime}}.csv

      See Export path variables for more details.

    1. Specify the URL for the S3 bucket.

    2. Specify the name Bucket.

    3. Enter the Region for the server.

    4. Enter the Access key for AWS.

    5. Enter the Secret key for AWS.

    6. Specify the Path where the export file is to be sent.

      For example

      <serverhost>/path-to-file/file.csv.

      Example w/variables

      <serverhost>/path-to-file/file-{{datetime}}.csv

      See Export path variables for more details.

    1. Specify the Project ID for the Google Cloud Storage.

    2. Specify the App name.

    3. Enter the User name for the server.

    4. Specify the name Bucket.

    5. Enter the Credentials in JSON format.

    6. Specify the Path where the export file is to be sent.

      For example

      <serverhost>/path-to-file/file.csv.

      Example w/variables

      <serverhost>/path-to-file/file-{{datetime}}.csv

      See Export path variables for more details.

  5. Still under Destination, if desired, click Overwrite existing file.

    What happens if I do that?

    overwrite existing file

    • When you check the box, the existing file is replaced by the new file. Data in the existing file is completely replaced.

    • If left unchecked, the new data is added to the existing file.

  6. Under Schedule, if desired, use a cron expression for scheduling the job.

  7. Under File format, select the file format type you wish to export. This will be either JSON or CSV.

    • JSON

    • CSV

    1. Choose the Encoding standard for your JSON file. This is either UTF-8 or ISO-8859-1.

    2. Define the fields to include in the export. You can include all attributes of the user event types model.

    3. Select the user profile fields to be exported.

      Choosing to include user profile fields as part of a user event export can significantly reduce the job performance.

    1. Choose the Encoding standard for your CSV file. This is either UTF-8 or ISO-8859-1.

    2. Define the columns to include in the export. You can include all attributes of the user event types model.

      You can drag and drop the fields to sort the order in which you want the columns displayed as part of the export job.

    3. Select the user profile fields to be exported.

      Choosing to include user profile fields as part of a user event export can significantly reduce the job performance.

    4. Enter your Delimiter. The default is ;.

    5. Enter your Quote char. The default is ".

    6. Enter your Escape character. The default is \.

    The data for custom fields that contain the multiple type (such as tags) are separated by the same Delimiter that is configured in the job definition.

  8. Optional If you want, you can filter user events.

    If you filter the events by the event type user_deleted or user_deleted_by_merge, only the user event types model is exported as no user profile fields would be available from a deleted user.

    export user events filter deletedUser

Filter export jobs

If you want to minimise database impact, you can filter what to export to limit the size of files that are generated. Filters allow you to define a range of values to export only user events that meet certain requirements.

The more filters you add, the more refined the data becomes.
Operator limitations

As you might expect, not all of the operators listed below are available to all value types.

The operators listed below are marked with the value types they support:

  • Enumeration

  • Dates & Integers

  • String

  • Boolean

Filter operators
Operator Description Supports

=

Equal to/equivalent.

Example: Event Type = login_not_matching_password.

  • Dates & Integers

  • Enumeration

  • String

  • Boolean

>

Greater than.

Example: Event Date > <date> (only events that happened after this date are exported).

Dates & Integers

≥

Greater than or equal to.

Example: Event Date ≥ <date> (only events that happened on or after this date are exported).

Dates & Integers

<

Less than.

Example: Event Date < <date> (only events that happened before this date are exported).

Dates & Integers

≤

Less than or equal to.

Example: Event Date ≤ <date> (only events that happened on or before this date are exported).

Dates & Integers

between

Between (inclusive) two specified values.

Example: Event Date between <dateA> and <dateB> (only events that happened between <dateA> and <dateB> (inclusive) are exported).

Dates & Integers

is not empty

The value for the specified filter is not empty.

Example: Event Auth Type is not empty (only events with the a value for the Event Auth Type field are exported).

  • Dates & Integers

  • String

  • Boolean

is empty

The value for the specified filter is empty.

Example: Event Auth Type is empty (only events with no value for the Event Auth Type field are exported).

  • Dates & Integers

  • String

  • Boolean

is any of

The filter includes any of the specified values.

Example: Event Type is any of login; signup (any event type that includes either login or sign up is exported).

You can paste up to 10k items separated by a semi-colon (;). Each item separated by a semi-colon (;) is treated as a unique value.

  • Dates & Integers

  • Enumeration

  • String

is none of

The filter excludes any of the specified values.

Example: Event Type is none of password_changed; password_reset (password_changed and password_reset events are excluded in the export).

You can paste up to 10k items separated by a semi-colon (;). Each item separated by a semi-colon (;) is treated as a unique value.

  • Dates & Integers

  • Enumeration

  • String

starts with

Filter values that start with the specified value.

Example: Event User Agent starts with a (only Event User Agents beginning with a are exported).

String

ends with

Filter values that end with the specified value.

Example: Event User Agent ends with x (only Event User Agents ending in x are exported).

String

contains

Filters values that contain the specified value.

Example: Event User Agent contains b (only Event User Agents containing b are exported).

String

before

Filters values that have occured before the specified time.

Example: Event Date before 30 days (Only events occurring before the last 30 days are exported). In other words, it excludes the last 30 days from the results.

String

since

Filters values that have occurred since the specified timeframe.

You must specify a unit (such as days or hours) for the export job to run successfully.

Format: <N> <duration>

Example: Event Date since 4 days (Only events occurring in the last 4 days are exported).

Accepts:

Days

  • d

  • day

  • days

Hours

  • h

  • hour

  • hours

Minutes

  • min

  • minute

  • minutes

Seconds

  • s

  • sec

  • second

  • seconds

Milliseconds

  • ms

  • milli

  • millisecond

  • milliseconds

Microseconds

  • µs

  • micro

  • microsecond

  • microseconds

Nanoseconds

  • ns

  • nano

  • nanosecond

  • nanoseconds

String

Run export job

Click 16 next to the export definition.

When you start a run, logs are created and available in Show job reports.

All job logs are accessible in the Settings  Job reports.

User event jobs are labelled with the user-events-export-external tag under the Type column on the ReachFive Console.

user event export job report

Export path variables

In some cases, you might want to add meta information to the path of an export file for identification and analysis purposes. With export path variables, you can do just that. Wherever you would like a variable in the path, simply add it to the name of the file as shown here:

<serverhost>/path-to-file/{{datetime}}-file-{{job_execution_id}}.csv (1)
1 In this example, {datetime} and {job_execution_id} are inserted as part of the file name as part of the export.
The export path variable feature is available for all export types including exporting profiles, user events, and consents.

Available export path variables

The following variables are available for you to use as part of your export.

  • {{datetime}} is the job execution date in the format of yyyy-MM-dd HH-mm-ss.

  • {{date}} is the job execution date in the format of yyyy-MM-dd.

  • {{time}} is the job execution time in the format of HH-mm-ss.

  • {{*datePattern}} lets you set the date pattern as shown here.

  • {{account}} is the name of the account where the export occurred.

  • {{job_execution_id}} is the specific id of the export being executed.