Event & Records Connection API (0.1.0)

API powering the ingestion of Events and Records

Authentication

appId

Security Scheme Type	API Key
Header parameter name:	X-Algolia-Application-Id

apiKey

Security Scheme Type	API Key
Header parameter name:	X-Algolia-API-Key

sources

Sources API reference

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Responses

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:

appIdapiKey

path Parameters

path

required

string

Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters

parameters

string

Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Create a new ingestion job via URL.

Add an ingestion job that will fetch data from an URL.

Authorizations:

appIdapiKey

Request Body schema: application/json

type required	string Value: "csv" The type of the file to ingest.
uniqueIDColumn	string The name of the column that hold the unique identifier
required	object (postURLJobInput) The input of the job.
required	object (postURLJobTarget) The target of the job.

Responses

Request samples

Payload

Content type

application/json

{"type": "csv",
"uniqueIDColumn": "objectID",
"input": {"url": "string",
"method": "GET",
"auth": {"type": "basic",
"login": "johndoe",
"password": "mypassword"
}
},
"target": {"type": "search",
"indexName": "my_index_name",
"operation": "replace"
}
}

Response samples

200
400

Content type

application/json

{"task": {"id": "e0f6db8a-24f5-4092-83a4-1b2c6cb6d809",
"type": "csv"
}
}