Skip to main content

6 Query the list of optimizations in a workspace

Description: Get user's (specified workspace) optimization list

6.1. Interface URL

Post http://${server-host}:${server-port}/api/v1/listAnalyses  

6.2. Request Parameters

FieldTypeRequiredDescription
userKeyStringYActivation code
workspaceIdStringNWorkspace ID (returns all user optimization information list if empty)
pageNumberintNPage number (default 1)
pageSizeintNPage size (default 10)

Request Example

{  
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"workspaceId": "1730187810133712898",
"pageNumber": 1,
"pageSize": 10
}

6.3. Response

FieldTypeDescription
codeintStatus code
messageStringDescription
dataObjectData

Data structure of data

FieldTypeDescription
recordsarrayWorkspace list information
analysisIdStringAnalysis ID
analysisNameStringAnalysis name
workspaceIdStringWorkspace ID
workspaceNameStringWorkspace name
statusStringAnalysis execution status
numberOfQueryintNumber of analyzed queries
numberOfSyntaxErrorintNumber of syntax errors
numberOfIndexintNumber of recommended indices
numberOfRewriteintNumber of rewritten queries
numberOfViolationsintNumber of violated rules
numberOfViolatedQueryintNumber of queries that violated rules
performanceImprovedoublePerformance improvement percentage
createUserIdStringCreator ID
createUserNameStringCreator name
createTimeStringCreation time
totalStringTotal
sizeStringPage size