List destinations

Retrieves a list of destinations.

GET /1/destinations

curl

cURL

curl --request GET \
  --url 'https://data.us.algolia.com/1/destinations?itemsPerPage=10&page=1&type=search&authenticationID=6c02aeb1-775e-418e-870b-1faccd4b2c0f&transformationID=6c02aeb1-775e-418e-870b-1faccd4b2c0f&sort=type&order=desc' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "destinations": [
    {
      "destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "type": "search",
      "name": "<string>",
      "input": {
        "indexName": "<string>",
        "recordType": "product",
        "attributesToExclude": [
          "<string>"
        ]
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "owner": "<string>",
      "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "transformationIDs": [
        "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
      ]
    }
  ],
  "pagination": {
    "nbPages": 2,
    "page": 2,
    "nbItems": 1,
    "itemsPerPage": 10
  }
}

Required ACL: addObject, deleteIndex, editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

itemsPerPage · integer · default: 10

Number of items per page.

Required range: 1 <= x <= 100

page · integer

Page number of the paginated API response. Page of the API response to retrieve.

Required range: x >= 1

type · enum<string>[]

Destination type.

Destination type.

• search. Data is stored in an Algolia index.

• insights. Data is recorded as user events in the Insights API.

Available options: search, insights

Example:

"search"

authenticationID · string[]

Authentication ID used by destinations.

Universally unique identifier (UUID) of an authentication resource.

transformationID · string

Get the list of destinations used by a transformation. Universally unique identifier (UUID) of a transformation.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

sort · enum<string> · default: createdAt

Property by which to sort the destinations.

Available options: name, type, updatedAt, createdAt

order · enum<string> · default: desc

Sort order of the response, ascending or descending. Ascending or descending sort order.

Available options: asc, desc

Response

200

application/json

OK

destinations · object[] · required

Show child attributes

destinations. destinationID · string · required

Universally unique identifier (UUID) of a destination resource.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

destinations. type · enum<string> · required

Destination type.

• search. Data is stored in an Algolia index.

• insights. Data is recorded as user events in the Insights API.

Available options: search, insights

destinations. name · string · required

Descriptive name for the resource.

destinations. input · object · required

Show child attributes

destinations.input. indexName · string · required

Algolia index name (case-sensitive).

destinations.input. recordType · enum<string>

Record type for ecommerce sources.

Available options: product, variant, collection

destinations.input. attributesToExclude · string[]

Attributes from your source to exclude from Algolia records.

Not all your data attributes will be useful for searching. Keeping your Algolia records small increases indexing and search performance.

• Exclude nested attributes with . notation. For example, foo.bar indexes the foo attribute and all its children except the bar attribute.
• Exclude attributes from arrays with [i], where i is the index of the array element. For example, foo.[0].bar only excludes the bar attribute from the first element of the foo array, but indexes the complete foo attribute for all other elements. Use * as wildcard: foo.[*].bar excludes bar from all elements of the foo array.

destinations. createdAt · string · required

Date of creation in RFC 3339 format.

destinations. updatedAt · string · required

Date of last update in RFC 3339 format.

destinations. owner · string | null

Owner of the resource.

destinations. authenticationID · string

Universally unique identifier (UUID) of an authentication resource.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

destinations. transformationIDs · string[]

Universally unique identifier (UUID) of a transformation.

pagination · object · required

Paginated API response.

Show child attributes

pagination. nbPages · integer · required

Number of pages in the API response.

Required range: x >= 1

pagination. page · integer · required

Page of the API response to retrieve.

Required range: x >= 1

pagination. nbItems · integer · required

Number of items in the API response.

Required range: x >= 0

pagination. itemsPerPage · integer · default: 10 · required

Number of items per page.

Required range: 1 <= x <= 100