Search for destinations

Searches for destinations.

POST /1/destinations/search

curl

cURL

curl --request POST \
  --url https://data.us.algolia.com/1/destinations/search \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"destinationIDs":["6c02aeb1-775e-418e-870b-1faccd4b2c0f"]}'

200

[
  {
    "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"
    ]
  }
]

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.

Body

application/json

API request body for searching destinations.

destinationIDs · string[] · required

Universally unique identifier (UUID) of a destination resource.

Response

200

application/json

OK

destinationID · string · required

Universally unique identifier (UUID) of a destination resource.

Example:

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

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

name · string · required

Descriptive name for the resource.

input · object · required

Show child attributes

input. indexName · string · required

Algolia index name (case-sensitive).

input. recordType · enum<string>

Record type for ecommerce sources.

Available options: product, variant, collection

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.

createdAt · string · required

Date of creation in RFC 3339 format.

updatedAt · string · required

Date of last update in RFC 3339 format.

owner · string | null

Owner of the resource.

authenticationID · string

Universally unique identifier (UUID) of an authentication resource.

Example:

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

transformationIDs · string[]

Universally unique identifier (UUID) of a transformation.