> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pawsql.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products.
> 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit.
> 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact.

# List optimization tasks

> Gets a paginated list of optimization tasks for the current user (within a specified workspace).



## OpenAPI

````yaml /openapi/pawsql-optimization-en.yaml post /listAnalyses
openapi: 3.0.3
info:
  title: PawSQL Optimization
  description: >
    PawSQL SQL optimization service external interfaces.


    The PawSQL optimization engine is a query optimization engine built for
    developers and DBAs, integrating database industry best practices for query
    optimization,

    providing powerful SQL auditing and rewrite optimization capabilities, and
    integrating the Paw Index Advisor index recommendation engine for cost-based
    index recommendations for slow queries.


    ## Authentication


    Most endpoints require authentication via `userKey` (activation code).

    The `userKey` can be obtained through the `/getUserKey` endpoint
    (email/password login).


    ## API Call Flow


    1. Call `/getUserKey` to obtain a userKey

    2. Call `/createWorkspace` to create a workspace (or pass DDL directly in
    `/createAnalysis`)

    3. Call `/createAnalysis` or `/createAnalysisAsync` to create an
    optimization task

    4. Call `/getAnalysisSummary` to obtain the optimization summary

    5. Call `/getStatementDetails` to obtain details for a single SQL statement
  version: 1.0.0
  contact:
    name: PawSQL Team
    url: https://pawsql.com
  license:
    name: PawSQL
    url: https://pawsql.com
servers:
  - url: /api/v1
    description: PawSQL Server
security:
  - userKey: []
tags:
  - name: Authentication
    description: Authentication endpoints
  - name: Workspace
    description: Workspace management endpoints
  - name: Optimization
    description: SQL optimization task endpoints
paths:
  /listAnalyses:
    post:
      tags:
        - Optimization
      summary: List optimization tasks
      description: >-
        Gets a paginated list of optimization tasks for the current user (within
        a specified workspace).
      operationId: listAnalyses
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUserRequestBody'
            examples:
              example:
                value:
                  userKey: CB698418-88B25371-67F15F01-XXXXXXXX
                  workspaceId: 1730187810133713000
                  pageNumber: 1
                  pageSize: 10
      responses:
        '200':
          description: Optimization task list
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResult'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PageResponse_AnalysisInfo'
              examples:
                success:
                  value:
                    code: 200
                    message: Success
                    data:
                      records:
                        - analysisId: '1730505660018876418'
                          analysisName: API-ANA-20260901143022
                          workspaceId: '1730187810133712898'
                          workspaceName: my-workspace
                          status: success1
                          numberOfQuery: 1
                          numberOfIndex: 1
                          numberOfRewrite: 2
                          performanceImprove: 85.5
                          createTime: '2026-09-01 14:30:22'
                      total: 1
                      size: 10
                      current: 1
                      pages: 1
components:
  schemas:
    ApiUserRequestBody:
      type: object
      description: User request (with pagination parameters)
      properties:
        userKey:
          type: string
          description: Activation code
          example: CB698418-88B25371-67F15F01-XXXXXXXX
        workspaceId:
          type: integer
          format: int64
          description: Workspace ID; returns all when omitted
        pageNumber:
          type: integer
          description: Page number, default 1
          example: 1
          default: 1
        pageSize:
          type: integer
          description: Items per page, default 10
          example: 10
          default: 10
    ApiResult:
      type: object
      description: Unified response body
      properties:
        code:
          type: integer
          description: Status code, 200 indicates success
          example: 200
        message:
          type: string
          description: Description message
          example: Success
        data:
          description: Response data
    PageResponse_AnalysisInfo:
      type: object
      description: Optimization task paginated response
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/AnalysisInfo'
        total:
          type: integer
          format: int64
          description: Total number of records
        size:
          type: integer
          format: int64
          description: Items per page
        current:
          type: integer
          format: int64
          description: Current page number
        pages:
          type: integer
          format: int64
          description: Total number of pages
    AnalysisInfo:
      type: object
      description: Optimization task information
      properties:
        analysisId:
          type: string
          description: Optimization task ID
        analysisName:
          type: string
          description: Optimization task name
        workspaceId:
          type: string
          description: Workspace ID
        workspaceName:
          type: string
          description: Workspace name
        status:
          type: string
          description: Optimization status
        numberOfQuery:
          type: integer
          description: Number of SQL statements
        numberOfSyntaxError:
          type: integer
          description: Number of syntax errors
        numberOfIndex:
          type: integer
          description: Number of recommended indexes
        numberOfRewrite:
          type: integer
          description: Number of rewrites
        numberOfViolations:
          type: integer
          description: Number of rule violations
        numberOfViolatedQuery:
          type: integer
          description: Number of SQL statements violating rules
        performanceImprove:
          type: number
          format: double
          description: Performance improvement percentage
        createUserId:
          type: string
          description: Creator ID
        createUserName:
          type: string
          description: Creator name
        createTime:
          type: string
          description: Creation time
  securitySchemes:
    userKey:
      type: apiKey
      in: header
      name: userKey
      description: Activation code, obtained via the /getUserKey endpoint

````