JSON connector

Use the JSON connector to index from a hosted JSON file without writing an indexing script. In this quickstart, you create a source for a public product dataset, an Algolia destination, and an on-demand synchronization task.

Before you begin

If you don’t have an Algolia account, create one for free.

Set up the JSON connector

Create a source, destination, transformation, and synchronization task for the sample product dataset.

The source tells the connector where to fetch the JSON file.
The destination tells the connector which Algolia index to write to.
The transformation changes records before the connector indexes them.
The task controls when the connector runs.

Choose the JSON connector

Connect the JSON source for the hosted sample product dataset.

Go to the Algolia dashboard and select your Algolia application.
Go to the Connectors page in the Algolia dashboard.
Select the JSON connector and click Connect.

Configure the source URL

Select None as your authentication method under Is your data source protected?.
In URL, enter https://dashboard.algolia.com/api/1/sample_datasets?type=apparel.
Select GET as the HTTP Method.

Create the JSON source

In Unique property identifier, enter objectID.
In Connector name, enter Quickstart products JSON source.
Select Create source.

Transform the records

This transformation adds a price_range attribute to each record. After the connector indexes your records, you can display price_range or configure it as a facet.Select Transform using the code editor and replace the placeholder Transformation code with this function:

JavaScript

async function transform(record, helper) {
    const price = Number(record.price);
    if (!Number.isFinite(price)) {
        return record;
    }
    if (price < 25) {
        record.price_range = "Under $25";
    } else if (price < 50) {
        record.price_range = "$25 to $49";
    } else if (price < 100) {
        record.price_range = "$50 to $99";
    } else {
        record.price_range = "$100 and up";
    }
    return record;
}

Select Save.

Create the destination index

Choose the Algolia index where the connector stores the product records.

Under Connect your data to Algolia Search, enter quickstart-products.
If you enter the name of an existing index, the connector overwrites the records and settings in that index.
Under Index credentials, select Create one for me. To use an existing key, choose one with the addObject, deleteIndex, and editSettings ACLs.
In Name, enter Quickstart products destination.
Select Create destination.

Create an on-demand synchronization task

Select On demand and Full reindexing.

Run the task

Select Create task, then Run and wait for the task to finish.

Verify the indexed records

When the task completes, open the quickstart-products index in the Algolia dashboard. The index contains product records with attributes such as title, description, product_type, price, price_range, and showcase_image.

You can use this index as the data source for Build your first search experience. Before you start the UI steps in that quickstart, configure product_type as a facet for the quickstart-products index.

Index your own JSON data

To index your own records, update the connector source URL to point to a JSON file you host. After you update the source, run the connector task again to index your records.

Source file format

Your JSON file must contain an array of JSON objects. For example:

JSON

[
  {
    "id": "product-1",
    "title": "Product name",
    "description": "Product description",
    "product_type": "Product type",
    "price": 49.99
  }
]

Each object must include a property with a value that’s unique across all records (id in this example). In the source configuration, set Unique property identifier to that property so the connector can use it as the Algolia objectID.

Source file location

Update the connector source URL to point to your hosted file. The source URL can use http, https, ftp, ftps, or sftp. For http or https sources, choose the request method your server expects:

GET if your server returns the file from a standard request.
POST if your server requires a POST request.

Source authentication

Select the authentication method for your file:

None if the file is public.
Basic Auth if the file requires a username and password.

Transformations

Use transformations to add computed attributes or change values before the connector indexes your records. To use a transformed attribute for search, faceting, or ranking, update the relevant index settings, such as searchableAttributes, attributesForFaceting, or customRanking.

Test transformations with repeated task runs. Transformations that read from and write to the same attribute, or extract a value and then delete the source attribute, can produce different results when the task runs again.

Synchronization schedule

After you create a task, you can edit it in the Algolia dashboard to choose when the connector runs:

On demand. Run the connector manually.
Scheduled. Select a predefined schedule or enter a custom cron expression.

Indexing strategy

You can choose how the connector updates your index. For information about full reindexing, full record updates, and partial record updates, see Data synchronization strategies.

Limitations

This connector is subject to the following limitations:

Search and Discovery platform

Optimization and Personalization

AI-powered experiences

Production and scale

Before you begin

Set up the JSON connector

Index your own JSON data

Source file format

Source file location

Source authentication

Transformations

Synchronization schedule

Indexing strategy

Limitations

See also

​Before you begin

​Set up the JSON connector

​Index your own JSON data

​Source file format

​Source file location

​Source authentication

​Transformations

​Synchronization schedule

​Indexing strategy

​Limitations

​See also

Before you begin

Set up the JSON connector

Index your own JSON data

Source file format

Source file location

Source authentication

Transformations

Synchronization schedule

Indexing strategy

Limitations

See also