Skip to content

query.md

Latest commit

 

History

History
84 lines (55 loc) · 3.29 KB

query.md

File metadata and controls

84 lines (55 loc) · 3.29 KB
Raw

QueryManager

Box Query

Runs a query to discover Box items using a logical predicate, similar to a SQL WHERE clause. The predicate can filter across multiple metadata templates and item fields in a single request. Results can be sorted, paginated with markers, and shaped with fields so each entry includes additional item or metadata attributes.

This is the item-retrieval endpoint in the Query API (version 2026.0). Unlike the Metadata Query API, it is not limited to a single metadata template or to files and folders. For totals and grouped metrics over the same predicates, use Query Insights instead of paging through every matching item.

For predicate syntax, parameters, examples, pagination behavior, and error codes, see the Box Query guide. For shared response schemas, including Query results and result entries, see Query resources.

This operation is performed by calling function createQueryV2026R0.

See the endpoint docs at API Reference.

client.getQuery().createQueryV2026R0(new QueryRequestBodyV2026R0.Builder(new QueryRequestBodyV2026R0QueryField.Builder(predicate).params(mapOf(entryOf("name", "John"), entryOf("age", 50))).ancestors(Arrays.asList(new QueryAncestorReferenceV2026R0("0", "folder"))).build()).limit(10).fields(Arrays.asList("box:item:name", searchFrom)).build())

Arguments

  • requestBody QueryRequestBodyV2026R0
    • Request body of createQueryV2026R0 method
  • headers CreateQueryV2026R0Headers
    • Headers of createQueryV2026R0 method

Returns

This function returns a value of type QueryResultsV2026R0.

Returns a paginated list of items matching the query.

Create insights for Box items

Computes aggregated metrics over Box items matching a query predicate. Filters are applied first, followed by optional grouping, after which the requested metrics (such as sum, avg, min, max, and count) are computed for each resulting group or over the entire filtered dataset.

This operation is performed by calling function createQueryInsightV2026R0.

See the endpoint docs at API Reference.

client.getQuery().createQueryInsightV2026R0(new QueryInsightsRequestBodyV2026R0(new QueryInsightsRequestBodyV2026R0QueryField.Builder(predicate).params(mapOf(entryOf("minAmount", 0))).ancestors(Arrays.asList(new QueryAncestorReferenceV2026R0("0", "folder"))).groupBy(Arrays.asList(new QueryInsightsGroupByV2026R0.Builder(String.join("", mdPrefix, ".category")).bucketLimit(5).build())).build(), metrics))

Arguments

  • requestBody QueryInsightsRequestBodyV2026R0
    • Request body of createQueryInsightV2026R0 method
  • headers CreateQueryInsightV2026R0Headers
    • Headers of createQueryInsightV2026R0 method

Returns

This function returns a value of type QueryInsightsV2026R0.

Returns the computed insight entries.