Try a transformation before updating it

Try a transformation before updating it.

POST /1/transformations/{transformationID}/try

curl

cURL

curl --request POST \
  --url https://data.us.algolia.com/1/transformations/6c02aeb1-775e-418e-870b-1faccd4b2c0f/try \
  --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 '{"code":"lorem","type":"code","input":{"code":"lorem"},"sampleRecord":{},"authentications":[{"type":"googleServiceAccount","name":"lorem","platform":"bigcommerce","input":{"clientEmail":"[e-mail]","privateKey":"lorem"}}]}'

200

{
  "payloads": [
    "<string>"
  ],
  "error": {
    "code": 123,
    "message": "<string>"
  }
}

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.

Path Parameters

transformationID · string · required

Unique identifier of a transformation. Universally unique identifier (UUID) of a transformation.

Example:

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

Body

application/json

sampleRecord · object · required

The record to apply the given code to.

code · string · deprecated

It is deprecated. Use the input field with proper type instead to specify the transformation code.

type · enum<string>

The type of transformation, which can be either 'code' or 'noCode'.

Available options: code, noCode

input · Code · object

The input for the transformation, which can be either code or a no-code configuration.

Code

Show child attributes

input. code · string · required

The source code of the transformation.

authentications · object[]

Show child attributes

authentications. type · enum<string> · required

Type of authentication. This determines the type of credentials required in the input object.

Available options: googleServiceAccount, basic, apiKey, oauth, algolia, algoliaInsights, secrets

authentications. name · string · required

Descriptive name for the resource.

authentications. input · Google · object · required

Credentials for authenticating with a Google service account, such as BigQuery.

Google

Show child attributes

authentications.input. clientEmail · string · required

Email address of the Google service account.

Example:

"[e-mail]"

authentications.input. privateKey · string · required

Private key of the Google service account. This field is null in the API response.

authentications. platform · enum<string> | null

Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.

Available options: bigcommerce, commercetools, shopify

Response

200

application/json

OK

payloads · string[] · required

The array of stringified records returned by the transformation service.

error · transformationError · object

The error if the transformation failed.

Show child attributes

error. code · integer

The error status code.

error. message · string

A descriptive message explaining the failure.