Algolia

This documentation for the Algolia integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Algolia, visit our connection instructions.

Version

This integration utilizes the Algolia Search API v1.

Base URL

The base URL used for all Algolia API endpoints contains the Application ID:

https://Application_ID.dsn.algolia.net/1

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/indexes	Validate credentials

---

Authentication & Authorization

The DataGrail Algolia integration connects using API key authentication which requires an API key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Algolia API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Limits

Limits in Algolia are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Algolia integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Get a list of indices.
2. Search retrieved indices for the Data Subject Email.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/indexes	Get a list of indices
POST	/indexes/index_name/query	Search an index

---