Get query nodes

GetAssessmentQueryNodes returns node details for entities in the query results, with a paginated response.

Please note that the total number of the results is not provided . To get a result count, use GetAssessmentQueryResult.

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
apply_risk_suppressed_constraintbooleanOptional
properties_to_getstring[]Optional

The properties that are returned on node, this allows the ability to limit the amount of properties retrieved through the graph This currently is only available on the source_node_types collection If used during an export, it is supported for source_node_types, relates_to_expression.node_types and path summary node types. In this case, the field is used to filter which properties will be exported, in the order in which they are specified.

include_all_source_tags_in_resultsbooleanOptional

These fields control whether or not tags will be included in source and/or destination results

include_all_destination_tags_in_resultsbooleanOptional
fetch_cached_resultsbooleanOptional
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.

order_bystringOptional

destination_node_count ASC and destination_node_count DESC are valid values

Responses
200

OK

application/json
get
/api/v1/assessments/queries/{id}:nodes

Sample request:

Sample response:

Last updated

Was this helpful?