Export user profiles to an audience

This guide shows how to fetch and browse user profiles with Algolia’s Advanced Personalization API. Use these code snippets to call the API and retrieve user data for segmentation. Exporting an audience lets you group users who share a specific . Use these groups to run focused email or ad campaigns. For example, export users who like camping or hiking. Then send them promotional content about outdoor gear.

Before you begin

Ensure you have a query string builder utility, such as the qs library available in your project.

Fetch user profiles

The Advanced Personalization API exposes an endpoint to retrieve user profiles based on specified parameters. Here’s a function to communicate with this endpoint:

JavaScript

import qs from 'qs';

export async function fetchUserProfiles(params) {
  const { appId, apiKey, region, ...usersParams } = params;
  const response = await fetch(
    `https://ai-personalization.${region}.algolia.com/2/users${qs.stringify(
      usersParams,
      { addQueryPrefix: true }
    )}`,
    {
      headers: {
        'X-Algolia-Application-Id': appId,
        'X-Algolia-API-Key': apiKey,
      },
    }
  );

  if (!response.ok) {
    const errorMessage = await response.text();
    throw new Error(errorMessage);
  }

  const json = await response.json();

  return json;
}

The function takes as parameters an object containing:

appId: your Algolia
apiKey: your Algolia search , with search, browse, and recommendation ACLs
region: the Algolia region (for example, "us", "eu")
Additional parameters for retrieving user profiles

Browse user profiles

To iterate through all user profiles and handle pagination automatically, use this function:

JavaScript

export async function browseUserProfiles(callback, params) {
  let nextPageToken = '';
  do {
    const response = await fetchUserProfiles({
      ...params,
      nextPageToken,
    });
    nextPageToken = response.nextPageToken;

    await callback(response.users);
  } while (nextPageToken);
}

Process batches of user profiles

Here’s an example of how to process batches of user profiles:

JavaScript

async function processUsers(users) {
  // Perform operations with all users in the batch
}

await browseUserProfiles(processUsers, {
  appId: 'ALGOLIA_APPLICATION_ID',
  apiKey: 'ALGOLIA_SEARCH_API_KEY',
  region: 'us',
  affinity: 'category:camping',
  limit: 100
});

Segment users by their category:camping affinity and target them with focused strategies. For example, send them an email about a discount on camping products. Find the list of available parameters in the REST API documentation.

Search and Discovery platform

Optimization and Personalization

AI-powered experiences

Production and scale

Export user profiles to an audience

Before you begin

Fetch user profiles

Browse user profiles

Process batches of user profiles

​Before you begin

​Fetch user profiles

​Browse user profiles

​Process batches of user profiles

Before you begin

Fetch user profiles

Browse user profiles

Process batches of user profiles