Skip to main content
POST
/
1
/
sources
/
validate
curl
curl --request POST \
  --url https://data.us.algolia.com/1/sources/validate \
  --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 '{"type":"bigcommerce","name":"lorem","input":{"storeKeys":["lorem"],"locales":["fr-FR"],"url":"lorem","projectKey":"lorem","fallbackIsInStockValue":true,"productQueryPredicate":"lorem","customFields":{"inventory":["lorem"],"price":["lorem"],"category":["lorem"]}},"authenticationID":"6c02aeb1-775e-418e-870b-1faccd4b2c0f"}'
{
  "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "eventID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "data": [
    {}
  ],
  "events": [
    {
      "eventID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "status": "created",
      "type": "fetch",
      "batchSize": 10,
      "data": {},
      "publishedAt": "<string>"
    }
  ],
  "message": "<string>",
  "createdAt": "<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.

Body

application/json
​
type
enum<string>
required
Available options:
bigcommerce,
bigquery,
commercetools,
csv,
docker,
ga4BigqueryExport,
json,
shopify,
push
​
name
string
required

Descriptive name of the source.

​
input
object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
​
authenticationID
string

Universally unique identifier (UUID) of an authentication resource.

Example:

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

Response

OK

​
runID
string
required

Universally unique identifier (UUID) of a task run.

Example:

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

​
eventID
string

Universally unique identifier (UUID) of an event.

Example:

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

​
data
object[]

This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.

​
events
object[]

in case of error, observability events will be added to the response.

​
message
string

a message describing the outcome of the operation that has been ran (push, discover or validate) run.

​
createdAt
string

Date of creation in RFC 3339 format.

⌘I