AMamperity
Ingest

Ingest job details list

Return a list of ingest jobs from your tenant that occurred within the previous 7 days.

get/ingest/jobs

Request

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.

with_totalboolean

Set this value to true to include a total count of all results. Default value: false. Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.

created_fromstring date-time required

A timestamp that defines the start (inclusive) of the time window in which ingest jobs started. Required with created_to; the window cannot exceed 7 days. Must be in ISO-8601 format and in UTC, and may be a date alone, such as 2024-06-01.

created_tostring date-time required

A timestamp that defines the end (exclusive) of the time window in which ingest jobs started. Required with created_from; the window cannot exceed 7 days. Must be in ISO-8601 format and in UTC, and may be a date alone, such as 2024-06-08.

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 the set of jobs from the given datetime range (not to exceed 7 days)

next_tokenstring

CURRENTLY UNUSED BUT RESERVED FOR FUTURE USE: The cursor value to use in a subsequent request to return the next page of results.

totalinteger

The total count of all results. This property is only returned when with_total is set to true in a request.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "next_token": "ZVEy1iwsKBs9a6H"
}

Changes

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