Query resources

Query for your items.

Query insight entry

A single computed insight entry, containing its grouping keys (if applicable) and the computed metrics.

Attributes and example

Property	Type	Required	Description
`key`	array of `string`	Yes	The grouping key values associated with the entry. Contains one value per `group_by` field for `group` entries, and is empty for `overall` and `other` entries.
`type`	`enum<string>`	Yes	The type of insight entry, indicating how the associated metrics are aggregated. Available options: `group`, `overall`, `other`.
`metrics`	`object`	Yes	A map of metric aliases to their computed results. For `other` entries, the count is reported under the `totalCountBeyondTopGroups` key.

Example

{
  "key": [
    "ContractType1"
  ],
  "type": "group",
  "metrics": {
    "totalContractValue": {
      "type": "sum",
      "values": {
        "sum": 180000
      }
    },
    "countContractType": {
      "type": "count",
      "values": {
        "count": 245
      }
    }
  }
}

Query insights

The computed results of an insights request, as a list of insight entries.

Attributes and example

Property	Type	Required	Description
`insights`	array of Query insight entry	Yes	The list of computed insight entries. Each entry corresponds to a group, the overall dataset, or the aggregate of groups outside the top results.

Example

{
  "insights": [
    {
      "key": [
        "ContractType1"
      ],
      "type": "group",
      "metrics": {
        "totalContractValue": {
          "type": "sum",
          "values": {
            "sum": 180000
          }
        },
        "countContractType": {
          "type": "count",
          "values": {
            "count": 245
          }
        }
      }
    },
    {
      "key": [
        "ContractType4"
      ],
      "type": "group",
      "metrics": {
        "totalContractValue": {
          "type": "sum",
          "values": {
            "sum": 100000
          }
        },
        "countContractType": {
          "type": "count",
          "values": {
            "count": 185
          }
        }
      }
    },
    {
      "key": [
        "ContractType2"
      ],
      "type": "group",
      "metrics": {
        "totalContractValue": {
          "type": "sum",
          "values": {
            "sum": 200000
          }
        },
        "countContractType": {
          "type": "count",
          "values": {
            "count": 150
          }
        }
      }
    },
    {
      "key": [],
      "type": "other",
      "metrics": {
        "totalCountBeyondTopGroups": {
          "type": "count",
          "values": {
            "count": 165
          }
        }
      }
    }
  ]
}

Query result entry

A single item matching the query. Always includes the item type and id. If a fields parameter was specified in the request, then additional item and/or metadata fields will be provided.

Attributes and example

Property	Type	Required	Description
`id`	`string`	Yes	The unique identifier of the matching item.
`type`	`string`	Yes	The type of the matching item.

Example

{
  "id": "12345",
  "type": "file"
}

Query results

A paginated list of items matching the query, using milestone-based marker pagination.

Attributes and example

Property	Type	Required	Description
`entries`	array of Query result entry	Yes	The list of items matching the query predicate.
`next_marker`	`string`	Yes	The marker for the start of the next page of results. When `null`, there are no further results available. Can be `null`.
`limit`	`integer`	Yes	The limit that was used for this request. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed.

Example

{
  "entries": [
    {
      "id": "12345",
      "type": "file",
      "box": {
        "item": {
          "name": "My Form"
        }
      },
      "enterprise_12345678": {
        "book": {
          "$parent": "file_12345",
          "$scope": "enterprise_12345678",
          "$template": "book",
          "$version": 4,
          "isbn": "1871263670",
          "purchasePrice": 234.57,
          "publicationYear": "1937"
        }
      }
    }
  ],
  "next_marker": "xppy0jjG1kBRSc7NBBSgQmBz1Gk6VaQdg5Vyb+Ob0iA=",
  "limit": 1
}

v2025.0

v2026.0

Query insight entry

Query insights

Query result entry

Query results

​Query insight entry

​Query insights

​Query result entry

​Query results

Query insight entry

Query insights

Query result entry

Query results