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

Path parameters

id*string

Query parameters

Response

200401403404500502503

A successful response.

Body

application/json

result_typestring

number_valuestring (int64)

timestamp_valuestring

nodes_valueAssessmentQueryResultResponseNodes (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/assessments/queries/{id}:result', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "result_type": "text",
  "number_value": "text",
  "timestamp_value": "text",
  "nodes_value": {
    "values": [
      {
        "id": "text",
        "type": "text",
        "permissions": [],
        "engagement_access_stats": {
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2024-04-30T18:44:34.680Z",
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "destination_node_ids": [
          "text"
        ],
        "risk_level": "NONE",
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ]
      }
    ],
    "next_page_token": "text",
    "has_more": false
  }
}

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"
}