Ingest Algolia User Profiles data into Experience Platform using the UI

Last update: 2025-05-26
  • Topics:
  • Sources
    View more on this topic
  • Created for:
  • Developer

This tutorial guides you through ingesting data from your Algolia User Profiles account into Adobe Experience Platform using the user interface.

Get started

IMPORTANT

Before you begin, make sure you’ve completed the prerequisites outlined in the Algolia User Profiles overview.

This tutorial assumes familiarity with the following Experience Platform components:

Gather required credentials

To connect Algolia to Adobe Experience Platform, provide the following credentials:

Credential Description
Application ID The unique identifier assigned to your Algolia account.
API Key The credential for authenticating and authorizing API requests to Algolia’s services.

For more information, refer to the Algolia authentication documentation.

Connect your Algolia account

In the Experience Platform UI, select Sources from the left navigation to open the Sources workspace. Use the Categories panel or search bar to find your desired source.

To connect Algolia, choose the Algolia source card under Data & Identity Partners and select Set up.

TIP

If a source does not yet have an authenticated account, it shows the Set up option. Once authenticated, this changes to Add data.

The sources catalog with the Algolia User Profiles source selected.

Authentication

Use an existing account

To use an existing account, choose Existing account and select the Algolia User Profiles account you want to use. Then select Next.

The existing account interface.

Create a new account

To create a new account, select New account, then enter a name, an optional description, and your Algolia credentials. Select Connect to source and wait for the connection to establish.

The new account interface.

Add data

After your Algolia User Profiles account is created, the Add data step appears. Use it to select and preview user profile data for ingestion.

  • On the left, enter optional Indices and Affinity(s).
  • On the right, preview up to 100 rows of user profiles.

Once done, select Next.

The select data step of the workflow.

Provide dataflow details

If using an existing dataset, choose one associated with a schema that includes the Algolia Profile field group. Make sure the Algolia User Token field is using the Algolia User Token identity namespace. If the Algolia User Token is not currently created or assigned, instructions are provided below.

The existing dataset step.

If creating a new dataset, select a schema using the Algolia Profile field group.

The new dataset step.

Create Algolia User Token identity namespace

You will need to create the Algolia User Token identity namespace if it doesn’t already exist in your organization.

Use the left navigation and select Identities to access the Identity Service UI workspace and then select Create identity namespace.

Next, provide a Display Name and an Identity Symbol for your custom namespace. During this step, you must also configure the type of your namespace. When finished, select Create.

Create identity namespace screen.

Custom namespace config Value
Display Name Algolia User Token
Identity Symbol AlgoliaUserToken
Select a type Cookie ID

Once added, the namespace appears in the list. You can now apply it in your schema.

Successful creation of the Algolia Identity namespace.

Apply your namespace to your schema

Use the left navigation and select Schemas to access the Schemas UI workspace. Use the schemas workspace to create or update a schema with the Algolia Profile Details field group. Next, navigate to the User Token field and use the right-rail to select the Identity box. Additionally, use the input box to define the Algolia User Token identity namespace. When finished, select Save.

Set identity on field.

After the User Token field is assigned the Algolia User Token identity namespace, the identity appears in the user profile for any profile.

The user profile interface.

Map data fields to an XDM schema

Use the mapping interface to map your source data to schema fields. For more information, refer to the mapping guide.

The mapping step.

Schedule ingestion runs

Next, use the scheduling interface to define the ingestion schedule of your dataflow.

The scheduling step of the sources workflow.

Scheduling configuration Description
Frequency Configure frequency to indicate how often the dataflow should run. You can set your frequency to:
  • Once: Set your frequency to once to create a one-time ingestion. Configurations for interval and backfill are unavailable when creating a one-time ingestion dataflow. By default, the scheduling frequency is set to once.
  • Minute: Set your frequency to minute to schedule your dataflow to ingest data on a per-minute basis.
  • Hour: Set your frequency to hour to schedule your dataflow to ingest data on a per-hour basis.
  • Day: Set your frequency to day to schedule your dataflow to ingest data on a per-day basis.
  • Week: Set your frequency to week to schedule your dataflow to ingest data on a per-week basis.
Interval Once you select a frequency, you can then configure the interval setting to establish the time frame between every ingestion. For example, if you set your frequency to day and configure the interval to 15, then your dataflow will run every 15 days. You cannot set the interval to zero. The minimum accepted interval value for each frequency is as follows:
  • Once: n/a
  • Minute: 15
  • Hour: 1
  • Day: 1
  • Week: 1
Start Time The timestamp for the projected run, presented in UTC time zone.
Backfill Backfill determines what data is initially ingested. If backfill is enabled, all current files in the specified path will be ingested during the first scheduled ingestion. If backfill is disabled, only the files that are loaded in between the first run of ingestion and the start time will be ingested. Files loaded prior to the start time will not be ingested.

Review your dataflow

Use the review page for a summary of your dataflow prior to ingestion. Details are grouped in the following categories:

  • Connection - Shows the source type, the relevant path of the chosen source file, and the number of columns within that source file.
  • Assign dataset & map fields - Shows which dataset the source data is being ingested into, including the schema that the dataset adheres to.
  • Scheduling - Shows that active period, frequency, and interval of the ingestion schedule.

Once you have reviewed your dataflow, select Finish and allow some time for the dataflow to be created.

The review step of the sources workflow.

Next steps

By following this tutorial, you have successfully created a dataflow to bring intent data from your Algolia source to Experience Platform. For additional resources, visit the documentation outlined below.

Monitor your dataflow

Once your dataflow has been created, you can monitor the data that is being ingested through it to view information on ingestion rates, success, and errors. For more information on how to monitor dataflow, visit the tutorial on monitoring accounts and dataflows in the UI.

Update your dataflow

To update configurations for your dataflows scheduling, mapping, and general information, visit the tutorial on updating sources dataflows in the UI.

Delete your dataflow

You can delete dataflows that are no longer necessary or were incorrectly created using the Delete function available in the Dataflows workspace. For more information on how to delete dataflows, visit the tutorial on deleting dataflows in the UI.

On this page