1Fetch Completed Jobs

Content-Type (Required)

String

Specifies media type of the request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the Login API.

Note: Session ID is required for token-based authentication.

–

requestJson (Required)

String

JSON definition containing the parameters and filter list.

Note: If this JSON is not provided, the API applies these defaults: maxRows=300, sortField=ORIGINAL_RUNTIME, sortOrder=DESC, sortDataType=1, and default filters as Job Listing = COMPLETED and Original Runtime = LAST 7 DAYS.

Note: An example JSON is provided under the Resources section below.

–

401

Authorization information is missing or invalid.

404

Connection, database, schema, or table not found.

412

Precondition failed. Required parameter missing.

500

Internal Server Error

maxRows

Number

Maximum number of records to return. If omitted, the default value is 300.

Any positive integer

300

sortField

String

Field used to sort the returned records. If omitted, defaults to ORIGINAL_RUNTIME.

Any supported filter field name (see Supported Filter Fields table)

"ORIGINAL_RUNTIME"

sortOrder

String

Sort order of the results.

ASC, DESC

"DESC"

sortDataType

Number

Data type of the sort field. Defaults to 1.

1

"1"

filters

Array of JSON Objects

Note: Details of supported objects are provided in the section Filter Objects

List of filters to apply. Multiple filters are combined using AND.

Array of filter objects

[ {...}, {...} ]

filters[].fieldName

String

Field on which the filter will be applied.

Any supported filter field name (see Supported Filter Fields table)

"FOLDER_NAME"

filters[].operation

String

Filter operation to perform. Supported operations depend on the selected field.

1. EQUALSIGNORECASE: Performs a case-insensitive exact match.

2. STARTSWITHIGNORECASE: Matches values that start with the specified text (case-insensitive).

3. CONTAINSIGNORECASE: Matches values containing the specified text (case-insensitive).

4. EQUAL_TO: Performs a case-sensitive exact match.

5. NOT_EQUAL_TO: Excludes values that exactly match the specified input.

6. INLIST: Matches any value from a comma-separated list.

7. NOTINLIST: Excludes values from a comma-separated list.

8. GREATER_THAN: Returns values greater than firstValue.

9. LESS_THAN: Returns values less than firstValue.

10. BETWEEN: Returns values within a range defined by firstValue and secondValue.

11. LAST: Filters data from a recent duration; firstValue is the number and secondValue is the unit (Day, Hour, or Minute), e.g., Last 7 Days.

12. CURRENT: Filters data for the current period; currently supports only Day (set firstValue to Day).

"EQUALSIGNORECASE"

filters[].dataType

String

Data type of the field being filtered.

CHAR, NUMBER

"CHAR"

filters[].firstValue

String

Primary value used by the selected operation. For CURRENT, specify Day. For LAST, specify the numeric value.

Depends on the selected field and operation

"User1"

filters[].secondValue

String

Secondary value required only for BETWEEN and LAST operations.

BETWEEN → End valueLAST → Day, Hour, Minute

"Day"

lastRecordEndTime

String

Pagination value returned in the previous response. Leave empty for the first request.

Value returned by the previous response

""

lastRecordValue

String

Pagination value returned in the previous response. Leave empty for the first request.

Value returned by the previous response

""

lastRecordValueDataType

String

Data type of lastRecordValue. Used internally for pagination. Leave empty for the first request.

Value returned by the previous response

""

ENTITY_NAME

CHAR

EQUALSIGNORECASE, STARTSWITHIGNORECASE, CONTAINSIGNORECASE

Any entity name

QUESTION_ID

CHAR

EQUALSIGNORECASE, STARTSWITHIGNORECASE, CONTAINSIGNORECASE

Any question ID

QUERY_CUBE_NAME

CHAR

EQUALSIGNORECASE, STARTSWITHIGNORECASE, CONTAINSIGNORECASE

Any query cube name

INSTANCE_NAME

CHAR

EQUALSIGNORECASE, STARTSWITHIGNORECASE, CONTAINSIGNORECASE

Any instance name

USER_NAME

CHAR

EQUALSIGNORECASE, STARTSWITHIGNORECASE, CONTAINSIGNORECASE

Any user name

FOLDER_NAME

CHAR

EQUALSIGNORECASE, STARTSWITHIGNORECASE, CONTAINSIGNORECASE

Any folder name

ACTION

CHAR

INLIST, NOTINLIST

Query Execution, Semantic Model Full Data Process, Semantic Model Incremental Data Process, Semantic Model Update Aggregates, Semantic Model Data Profile, Semantic Model Test Data Process, Semantic Model Without Data Process, Drop Partition, Dataset Data Profile, Cache Build, Email, NL Query Execution

QUERY_EXECUTED_ON

NUMBER

INLIST, NOTINLIST

KYVOS_ENGINE (Kyvos Engine)EXTERNAL_ENGINE (External SQL Engine)

OVERALL_STATUS

CHAR

INLIST, NOTINLIST

Success, Failed, PARTIALLY_SUCCESSFUL (Partial Success),CANCELED (Canceled)

ORIGINAL_RUNTIME

NUMBER

LAST, CURRENT, BETWEEN

Note: When using the option BETWEEN, the firstValue and secondValue should be provided as Unix timestamp.

Numeric values

EXECUTED_ON_GPU

NUMBER

EQUAL_TO, GREATER_THAN, LESS_THAN, BETWEEN

Numeric values

ELAPSED_TIME

NUMBER

GREATER_THAN, LESS_THAN, BETWEEN

Time in milliseconds

QUERY_TYPE

CHAR

EQUAL_TO

MDXSQLDAXWORKSHEET (Kyvos Worksheet)QNASHEET (Kyvos Chat Session)

FOLDER_ID

CHAR

EQUALSIGNORECASE

Any folder ID

QUERY_SOURCE

NUMBER

EQUAL_TO, NOT_EQUAL_TO, INLIST, NOTINLIST

NOT_AVAILABLE (Not Available)

OE_CACHE (Analytical Server

Cache)

QE_CACHE (Query Engine Cache)

DISK (Disk)

OE_QE (Analytical Server and Query Engine Cache)

OE_DISK (Analytical Server Cache and Disk)

QE_DISK (Query Engine Cache and Disk)

OE_QE_DISK (Analytical Server Cache, Query Engine Cache and Disk)