Sign in

v1

latestOpenAPI 3.1.02026-07-246026.9 KB

Retrieve the Status of Multiple Offline User Upload Jobs

Retrieve the status of multiple offline user upload jobs by group ID or date range. Use exactly one of the following query parameter combinations per request:

  • group_id: Returns all jobs associated with the specified group ID.
  • date_from and date_to: Returns all jobs created within the specified date range.
get/jobs

Query parameters

group_idstring
Example:group_123

Returns all jobs associated with the specified group ID. Use exactly one query parameter combination per request.

date_fromstring
Example:20201001

The beginning of the date range to return results for. Required when querying by date range. Format: yyyymmdd.

date_tostring
Example:20201031

The end of the date range to return results for. Required when querying by date range. Format: yyyymmdd.

Headers

appidstring required
Example:<YOUR_APP_ID>

Required. Your AIQUA app ID.

authorizationstring required
Example:Token <YOUR_API_TOKEN>

Required. Your AIQUA API token. Must start with "Token".

Response

Success

received_linesinteger

The total number of user profile lines across all matched jobs.

jobs_with_invalid_recordsstring[]

A list of job IDs that contain invalid or errored records. Use these IDs with Retrieve the Status of an Offline User Upload Job and the errors=1 parameter to retrieve error details.

group_idstring

The group ID used in the request. Returned when querying by group ID.

date_fromstring

The start of the date range used in the request. Returned when querying by date range.

date_tostring

The end of the date range used in the request. Returned when querying by date range.

Example response

{
  "matched_jobs": {
    "total": 4,
    "finished": 3,
    "invalid_schema": 1
  },
  "received_lines": 1000,
  "aggregation": {
    "created": 76,
    "updated": 980,
    "invalid": 5
  },
  "jobs_with_invalid_records": [
    "1578458079-356066"
  ],
  "group_id": "group_123",
  "date_from": "20201001",
  "date_to": "20201031"
}