Get query result

GetAssessmentQueryResult returns the total number of results for a saved query.

To get node details for the source entity type, use GetAssessmentQueryNodes. To get related destination nodes for an individual result, use GetAssessmentQueryDestinationNodes.

get

/api/v1/assessments/queries/{id}:result

Authorizations

Path parameters

idstringrequired

Query parameters

snapshot_idstring · uint64

page_sizestring · int64

The maximum number of results to be returned. Fewer results may be returned even when more pages exist.

page_tokenstring

The token specifying the specific page of results to retrieve.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/assessments/queries/{id}:result' \
  --header 'Bearer: YOUR_API_KEY'

200

401

403

404

500

502

503

200

{
  "result_type": "text",
  "number_value": "text",
  "timestamp_value": "text",
  "nodes_value": {
    "next_page_token": "text",
    "has_more": true,
    "values": [
      {
        "id": "text",
        "type": "text",
        "properties": {},
        "destination_node_count": 1,
        "engagement_access_stats": {
          "engagement_score": 1,
          "over_provisioned_score": 1,
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2025-02-20T18:59:55.403Z",
          "count": 1,
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "risk_level": "NONE",
        "destination_node_percentage_of_total": 1,
        "permissions": [
          {
            "id": "text",
            "type": "text",
            "properties": {},
            "destination_node_count": 1,
            "engagement_access_stats": {
              "engagement_score": 1,
              "over_provisioned_score": 1,
              "total_count": "text",
              "accessed_count": "text"
            },
            "access_stats": {
              "last_used": "2025-02-20T18:59:55.403Z",
              "count": 1,
              "concrete_permissions": [
                "text"
              ],
              "canonical_permissions": [
                "text"
              ]
            },
            "risk_level": "NONE",
            "destination_node_percentage_of_total": 1,
            "permissions": "[Circular Reference]",
            "destination_node_ids": [
              "text"
            ],
            "raw_permissions": [
              "text"
            ],
            "effective_permissions": [
              "text"
            ]
          }
        ],
        "destination_node_ids": [
          "text"
        ],
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ]
      }
    ]
  }
}

A successful response.

Sample request:

curl -X 'GET' "$BASE_URL/api/v1/assessments/queries/6288f9ac-ff58-49b1-87a0-79ae7572448f:result" \
-H "authorization: Bearer $VEZA_TOKEN"

Sample Response:

The response will include a number_value representing the total number of results.

{
    "result_type": "number",
    "number_value": "6"
}