Skip to main content
Documentation Powered by ReDoc

Event & Records Connection API (0.1.0)

Download OpenAPI specification:Download

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

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
object

Query parameters to be applied to the current query.

Responses

Response samples

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
object

Query parameters to be applied to the current query.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

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
object

Query parameters to be applied to the current query.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

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
object

Query parameters to be applied to the current query.

Responses

Response samples

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 (taskType)
Value: "csv"

The type of the task executed.

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

Content type
application/json
{
  • "type": "csv",
  • "uniqueIDColumn": "objectID",
  • "input": {
    },
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "task": {
    }
}