Ingest

Ingest job details

Return details for a specific ingest job, including a summary of the records, files, and feeds that were ingested.

get/ingest/jobs/{job-id}

Request

Path parameters

job-idstring required
Example:isj-20240827-54061-2l6XhD

The Amperity internal identifier for the ingest job, returned as id by GET /ingest/jobs. To find it in Amperity, open the Workflows page, click Recent Activity, select Ingest details under the job, and copy the job ID.

Query parameters

api_versionstring

A supported version of the Amperity API. You may use the api-version request header instead of the api_version request parameter.

Headers

Amperity-Tenantstring required

The ID for the tenant to which a request will be sent.

Api-Versionstring required

A supported version of the Amperity API.

Response

A summary of records, files, and feeds ingested in this job

idstring required

The Amperity internal identifier for the injest job.

workflow_idstring required

The Amperity internal identifier for the workflow that ran this job.

Example response

{
  "id": "isj-1f73r9u2",
  "tables": [
    {
      "ended_at": "2024-06-01T04:02:57.433Z",
      "errors": 200,
      "feed_id": "df-5L6d1veh",
      "files": [
        {
          "errors": 200,
          "file_id": "cb-20240618-71992-SF3Uz/part0.avro",
          "name": "part0.avro",
          "read": 1000
        }
      ],
      "inserted": 400,
      "job_id": "isj-1f73r9u2",
      "read": 1000,
      "rejected": 200,
      "started_at": "2024-06-01T04:02:54.433Z",
      "state": "succeeded",
      "table_name": "My table",
      "updated": 200
    }
  ],
  "workflow_id": "wf-20240618-3423-b45"
}

Changes

No recorded changes to this operation across all 1 revision of this API.