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

Veza API key for authentication. Generate keys in Administration > API Keys.

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

cache_strategyinteger ยท enumOptional

Cache strategy to use. Defaults to CACHE_STRATEGY_LEGACY for backward compatibility.

result_order_bystringOptional

Field sorting to apply to the query results, using SQL ORDER BY syntax. Multiple sort fields can be specified, separated by commas. Each field can optionally specify ASC (ascending, default) or DESC (descending).

Field naming follows the same rules as the filters field:

  • PATH queries: use "source.", "destination.", or no prefix for path-level fields
  • NODE queries: use fields directly without prefix

All filterable fields (see filters field documentation) are also sortable. Some string fields (properties.name and properties.email) are sorted case-insensitively.

Examples:

  • destination_node_count DESC
  • destination.properties.risk_score DESC, source.id ASC
  • engagement_access_stats.engagement_score DESC
  • source.integration_type ASC, destination.type ASC
  • properties.email DESC
  • access_stats.last_used DESC

When aggregation/group_by is enabled, order_by is restricted to:

  • The group_by field itself (e.g., "type")
  • Aggregation result fields (e.g., "count" for OP_COUNT) Examples with aggregation:
  • count DESC (sort by aggregation result)
  • type ASC (sort by group_by field)
  • integration_type DESC (if grouping by integration_type)
Responses
chevron-right
200

OK

application/json
approx_total_source_nodes_countstringOptional
next_page_tokenstringOptional

The token to retrieve the next page of results.

has_morebooleanOptional

If true, more results are available.

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

Sample request:

Sample response:

Last updated

Was this helpful?