Skip to content

Function: countObjectsByAql() ​

ts
function countObjectsByAql(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  totalCount?: number;
}>;

Defined in: src/assets/api/objects.ts:176

This API provides the total count of objects that match a specified AQL query. Please note that this operation may incur performance latency.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ qlQuery: string; }-
parameters.qlQuerystringThe AQL that will filter the objects.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; totalCount?: number; }>