Skip to main content
GET
/
v1
/
projects
/
{project}
/
plans
/
{plan}
/
planCheckRuns
cURL
curl --request GET \
  --url https://api.example.com/v1/projects/{project}/plans/{plan}/planCheckRuns
{
  "planCheckRuns": [
    {
      "name": "<string>",
      "type": "TYPE_UNSPECIFIED",
      "status": "STATUS_UNSPECIFIED",
      "target": "<string>",
      "sheet": "<string>",
      "results": [
        {
          "status": "ADVICE_LEVEL_UNSPECIFIED",
          "title": "<string>",
          "content": "<string>",
          "code": 123,
          "sqlSummaryReport": {
            "statementTypes": [
              "<string>"
            ],
            "affectedRows": "<string>",
            "changedResources": {
              "databases": [
                {
                  "name": "<string>",
                  "schemas": [
                    {
                      "name": "<string>",
                      "tables": [
                        {
                          "name": "<string>",
                          "tableRows": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "views": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "functions": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "procedures": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          "sqlReviewReport": {
            "startPosition": {
              "line": 123,
              "column": 123
            },
            "endPosition": {
              "line": 123,
              "column": 123
            }
          }
        }
      ],
      "error": "<string>",
      "createTime": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

​
project
string
required

The project id.

​
plan
string
required

The plan id.

Query Parameters

​
latestOnly
boolean

If set to true, only the latest plan check run will be returned.

​
filter
string

Filter is used to filter plan check runs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values.
  • result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.

For example: status in ["DONE", "FAILED"] status == "RUNNING" result_status in ["SUCCESS", "ERROR"] result_status == "WARNING"

Response

OK

​
planCheckRuns
object[]

The plan check runs from the specified request.