> ## Documentation Index > Fetch the complete documentation index at: https://algolia.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a task run > Retrieve a single task run by its ID. **Required ACL:** `addObject`, `deleteIndex`, `editSettings` ## OpenAPI ````yaml specs/ingestion.yml get /1/runs/{runID} openapi: 3.1.0 info: title: Ingestion API summary: >- The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data description: > The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). ## Base URLs Base URLs for the Ingestion API: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Authentication Add these headers to authenticate requests: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Request bodies must be JSON objects. ## Response status and errors Response bodies are JSON objects. Successful responses return `2xx` statuses. Client errors return `4xx` statuses. Server errors return `5xx` statuses. Error responses have a `message` property with more information. ## Version The current version of the Ingestion API is version 1, indicated by the `/1/` in each endpoint's URL. version: 1.0.0 servers: - url: https://data.{region}.algolia.com variables: region: description: The region where your Algolia application is hosted. enum: - eu - us default: us security: - appId: [] apiKey: [] tags: - name: authentications x-displayName: Authentications description: >- Authentication resources describe how to connect to a source or destination. - name: destinations x-displayName: Destinations description: > Destinations are Algolia products or features where your data should be used, such as a search index or events. Algolia destinations require authentication with the `algolia` type. You can reference authentications by their ID when creating destinations. - name: observability x-displayName: Observability description: >- Check the status and details of your task runs. A run is one instance of a configured task. - name: sources x-displayName: Sources description: > Sources are third-party platforms or services from where you want to ingest your data. Sources may require authentication. To interact with such sources, you can reference an authentication resource by its ID. - name: tasks x-displayName: Tasks description: > Tasks contain information how your data should be read from a source and stored in a destination. Tasks have _triggers_ which determine when the task should run. - name: transformations x-displayName: Transformations description: > Transformations let you transform a record before it gets indexed in Algolia. paths: /1/runs/{runID}: get: tags: - observability summary: Retrieve a task run description: Retrieve a single task run by its ID. operationId: getRun parameters: - $ref: '#/components/parameters/pathRunID' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Run' '400': $ref: '#/components/responses/BadRequest' x-codeSamples: - lang: csharp label: C# source: >- // Initialize the client var client = new IngestionClient( new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION") ); // Call the API var response = await client.GetRunAsync("6c02aeb1-775e-418e-870b-1faccd4b2c0f"); // print the response Console.WriteLine(response); - lang: dart label: Dart source: |- // Initialize the client final client = IngestionClient( appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY', region: 'ALGOLIA_APPLICATION_REGION'); // Call the API final response = await client.getRun( runID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f", ); // print the response print(response); - lang: go label: Go source: >- // Initialize the client with your application region, eg. ingestion.ALGOLIA_APPLICATION_REGION client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US) if err != nil { // The client can fail to initialize if you pass an invalid parameter. panic(err) } // Call the API response, err := client.GetRun(client.NewApiGetRunRequest( "6c02aeb1-775e-418e-870b-1faccd4b2c0f")) if err != nil { // handle the eventual error panic(err) } // print the response print(response) - lang: java label: Java source: >- // Initialize the client IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"); // Call the API Run response = client.getRun("6c02aeb1-775e-418e-870b-1faccd4b2c0f"); // print the response System.out.println(response); - lang: javascript label: JavaScript source: >- // Initialize the client // Replace 'us' with your Algolia Application Region const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' }); // Call the API const response = await client.getRun({ runID: '6c02aeb1-775e-418e-870b-1faccd4b2c0f' }); // print the response console.log(response); - lang: kotlin label: Kotlin source: >- // Initialize the client val client = IngestionClient( appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION", ) // Call the API var response = client.getRun(runID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f") // print the response println(response) - lang: php label: PHP source: >- // Initialize the client $client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION'); // Call the API $response = $client->getRun( '6c02aeb1-775e-418e-870b-1faccd4b2c0f', ); // print the response var_dump($response); - lang: python label: Python source: >- # Initialize the client # In an asynchronous context, you can use IngestionClient instead, which exposes the exact same methods. client = IngestionClientSync( "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION" ) # Call the API response = client.get_run( run_id="6c02aeb1-775e-418e-870b-1faccd4b2c0f", ) # print the response print(response) - lang: ruby label: Ruby source: >- # Initialize the client client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION") # Call the API response = client.get_run("6c02aeb1-775e-418e-870b-1faccd4b2c0f") # print the response puts(response) - lang: scala label: Scala source: |- // Initialize the client val client = IngestionClient( appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION" ) // Call the API val response = Await.result( client.getRun( runID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f" ), Duration(100, "sec") ) // print the response println(response) - lang: swift label: Swift source: >- // Initialize the client let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us) // Call the API let response = try await client.getRun(runID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f") // print the response print(response) - lang: cURL label: curl source: |- curl --request GET \ --url https://data.us.algolia.com/1/runs/6c02aeb1-775e-418e-870b-1faccd4b2c0f \ --header 'accept: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' components: parameters: pathRunID: name: runID in: path required: true description: Unique identifier of a task run. schema: $ref: '#/components/schemas/RunID' schemas: Run: type: object additionalProperties: false properties: appID: type: string createdAt: $ref: '#/components/schemas/CreatedAt' runID: $ref: '#/components/schemas/RunID' status: $ref: '#/components/schemas/RunStatus' taskID: $ref: '#/components/schemas/taskID' type: $ref: '#/components/schemas/RunType' failureThreshold: $ref: '#/components/schemas/failureThreshold' finishedAt: $ref: '#/components/schemas/finishedAt' outcome: $ref: '#/components/schemas/RunOutcome' progress: title: runProgress type: object additionalProperties: false properties: expectedNbOfEvents: type: integer receivedNbOfEvents: type: integer required: - expectedNbOfEvents - receivedNbOfEvents reason: type: string description: More information about the task run's outcome. reasonCode: $ref: '#/components/schemas/RunReasonCode' startedAt: $ref: '#/components/schemas/startedAt' required: - runID - appID - taskID - status - type - createdAt RunID: type: string description: Universally unique identifier (UUID) of a task run. example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f CreatedAt: type: string description: Date and time when the resource was created, in RFC 3339 format. RunStatus: type: string description: Task run status. enum: - created - started - finished - skipped taskID: type: string description: Universally unique identifier (UUID) of a task. example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f RunType: type: string description: Task run type. enum: - reindex - update - discover - validate - push failureThreshold: type: integer minimum: 0 maximum: 100 description: >- Maximum accepted percentage of failures for a task run to finish successfully. finishedAt: type: string description: Date and time when the task finished, in RFC 3339 format. RunOutcome: type: string description: Task run outcome. enum: - success - failure RunReasonCode: type: string description: >- A code for the task run's outcome. A readable description of the code is included in the `reason` response property. enum: - internal - cancelled - critical - no_events - too_many_errors - lacking_events - ok - blocking - idle startedAt: type: string description: Date and time when the task started, in RFC 3339 format. ErrorBase: description: Error. type: object x-keep-model: true additionalProperties: true properties: message: type: string example: Invalid Application-Id or API-Key responses: BadRequest: description: Bad request or request arguments. content: application/json: schema: $ref: '#/components/schemas/ErrorBase' securitySchemes: appId: type: apiKey in: header name: x-algolia-application-id description: Your Algolia application ID. apiKey: type: apiKey in: header name: x-algolia-api-key description: > 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. ````