All pages
Powered by GitBook
1 of 1

Loading...

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.

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"
}
get
Authorizations
AuthorizationstringRequired

Bearer token authentication using a Veza Personal API key.

Header Format: Authorization: Bearer <your-api-key>

Creating an API Key:

  1. Log into your Veza tenant
  2. Navigate to Administration → API Keys
  3. Generate a new API key and save the value securely
Path parameters
idstringRequired
Query parameters
snapshot_idstringOptional
include_result_statisticsbooleanOptional
include_approx_total_source_nodes_countbooleanOptional
page_sizestringOptional

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

page_tokenstringOptional

The token specifying the specific page of results to retrieve.

Responses
200

OK

application/json
default

Default error response

application/json
get
/api/v1/assessments/queries/{id}:result
{
  "result_type": "text",
  "number_value": "text",
  "timestamp_value": "text",
  "nodes_value": {
    "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-12-21T02:06:19.602Z",
          "count": 1,
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "risk_level": 1,
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ],
        "unsupported_conditions": {
          "ANY_ADDITIONAL_PROPERTY": {
            "conditions": [
              "text"
            ]
          }
        },
        "destination_node_percentage_of_total": 1,
        "tags": [
          {
            "type": "text",
            "key": "text",
            "value": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": null
            }
          }
        ],
        "specified_tags": [
          {
            "type": "text",
            "key": "text",
            "value": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": null
            }
          }
        ],
        "filtered_raw_permissions": [
          "text"
        ],
        "corresponding_effective_permissions": [
          "text"
        ],
        "single_entity_access_stats": {
          "last_used": "2025-12-21T02:06:19.602Z",
          "last_used_with_events_for": [
            {
              "name": "text",
              "last_used": "2025-12-21T02:06:19.602Z"
            }
          ]
        },
        "additional_node_properties": {
          "role_substitution_recommended_role": "text",
          "role_substitution_reason_for_high_priv_role": "text",
          "role_substitution_error": "text",
          "default_cohort_role_users_in_cohort": [
            "text"
          ],
          "default_cohort_role": "text",
          "default_cohort_role_all_common_roles": [
            "text"
          ],
          "default_cohort_role_error": "text",
          "login_anomaly_detection_stats": [
            {
              "time": "2025-12-21T02:06:19.602Z",
              "login_count": "text",
              "median_login_count": 1,
              "outlier_prediction": 1
            }
          ],
          "outlier_prediction": {
            "prediction": 1,
            "score": 1,
            "contributing_features": [
              {
                "name": "text",
                "value": 1,
                "explanation": "text"
              }
            ]
          },
          "associated_risks": [
            {
              "query_id": "text",
              "suppressed": true,
              "risk_level": 1
            }
          ]
        },
        "integration_type": "text",
        "joined_nodes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "id": "text",
            "type": "text",
            "properties": {},
            "destination_node_count": 1,
            "permissions": "[Circular Reference]",
            "engagement_access_stats": {
              "engagement_score": 1,
              "over_provisioned_score": 1,
              "total_count": "text",
              "accessed_count": "text"
            },
            "access_stats": {
              "last_used": "2025-12-21T02:06:19.602Z",
              "count": 1,
              "concrete_permissions": [
                "text"
              ],
              "canonical_permissions": [
                "text"
              ]
            },
            "risk_level": 1,
            "raw_permissions": [
              "text"
            ],
            "effective_permissions": [
              "text"
            ],
            "unsupported_conditions": {
              "ANY_ADDITIONAL_PROPERTY": {
                "conditions": [
                  "text"
                ]
              }
            },
            "destination_node_percentage_of_total": 1,
            "tags": [
              {
                "type": "text",
                "key": "text",
                "value": "text",
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": null
                }
              }
            ],
            "specified_tags": [
              {
                "type": "text",
                "key": "text",
                "value": "text",
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": null
                }
              }
            ],
            "filtered_raw_permissions": [
              "text"
            ],
            "corresponding_effective_permissions": [
              "text"
            ],
            "single_entity_access_stats": {
              "last_used": "2025-12-21T02:06:19.602Z",
              "last_used_with_events_for": [
                {
                  "name": "text",
                  "last_used": "2025-12-21T02:06:19.602Z"
                }
              ]
            },
            "additional_node_properties": {
              "role_substitution_recommended_role": "text",
              "role_substitution_reason_for_high_priv_role": "text",
              "role_substitution_error": "text",
              "default_cohort_role_users_in_cohort": [
                "text"
              ],
              "default_cohort_role": "text",
              "default_cohort_role_all_common_roles": [
                "text"
              ],
              "default_cohort_role_error": "text",
              "login_anomaly_detection_stats": [
                {
                  "time": "2025-12-21T02:06:19.602Z",
                  "login_count": "text",
                  "median_login_count": 1,
                  "outlier_prediction": 1
                }
              ],
              "outlier_prediction": {
                "prediction": 1,
                "score": 1,
                "contributing_features": [
                  {
                    "name": "text",
                    "value": 1,
                    "explanation": "text"
                  }
                ]
              },
              "associated_risks": [
                {
                  "query_id": "text",
                  "suppressed": true,
                  "risk_level": 1
                }
              ]
            },
            "integration_type": "text",
            "joined_nodes": "[Circular Reference]"
          }
        }
      }
    ],
    "next_page_token": "text",
    "has_more": true
  },
  "result_statistics": {
    "max_destination_node_count": "text",
    "min_destination_node_count": "text",
    "avg_destination_node_count": 1
  },
  "approx_total_source_nodes_count": "text"
}
GET /api/v1/assessments/queries/{id}:result HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*