Runs an aggregation on a data collection and returns the resulting list of items.

An aggregation enables you to perform certain calculations on your collection data, or on groups of items that you define, to retrieve meaningful summaries. You can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.

Inserts one or more references in the specified fields of items in a collection.

This endpoint adds one or more references to a collection. Each new reference in options.dataItemReferences specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.

Adds multiple items to a collection.

When each item is inserted into a collection, its ID is automatically assigned a random value. You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.

Removes one or more references.

Removes multiple items from a collection.

If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.

Inserts or updates multiple items in a collection.

This function inserts or updates each item provided, depending on whether it already exists in the collection. For each item:

• If you don't provide an ID, a new item is created.

• If you provide an ID that doesn't exist in the collection, a new item is created with that ID.

• If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its data._updatedDate field is changed to the current date and time.

Updates multiple items in a collection.

This function replaces each specified data item's existing data with the payload provided in the request.

Each item in the request must include an ID. If an item is found in the specified collection with the same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.

When an item is updated, its data._updatedDate field is changed to the current date and time.

Counts the number of items in a data collection that match the provided filtering preferences.

Retrieves an item from a collection.

Adds an item to a collection.

An item can only be inserted into an existing connection. You can create a new collection using the Data Collections API.

When an item is inserted into a collection, the item's ID is automatically assigned a random value. You can optionally provide a custom ID in dataItem.id when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.

If options.dataItem.data is empty, a new item is created with no data fields.

Inserts a reference in the specified field in an item in a collection.

A reference in options.dataItemReference specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.

Checks whether a field in a referring item contains a reference to a specified item.

Creates a query to retrieve items from a database collection.

The queryDataItems() function builds a query to retrieve data items from a collection and returns a DataItemsQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function.

You can refine the query by chaining DataItemsQueryBuilder functions onto the query. DataItemsQueryBuilder functions enable you to sort, filter, and control the results that queryDataItems() returns.

The queryDataItems() function runs with the following DataItemsQueryBuilder defaults that you can override:

• skip: 0
• limit: 50
• descending: by _createdDate

The functions that are chained to queryDataItems() are applied in the order they are called. For example, if you sort on an age field in ascending order and then on a name field in descending order, the results are sorted first by the age of the items and then, if there are multiple results with the same age, the items are sorted by name in descending order, per age value.

If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To get the data from referenced items, specify them in the options.includeReferencedItems parameter.

Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.

As with queryDataItems(), this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide. However, queryDistinctValues() doesn't return all of the full items that match the query. Rather, it returns all unique values of the field you specify in options.fieldName for items that match the query. If more than one item has the same value for that field, that value appears only once.

For more details on using queries, see API Query Language.

Retrieves the full items referenced in the specified field of an item.

Reference and multi-reference fields refer to items in different collections. Use this function to retrieve the full details of the referenced items themselves.

For example, suppose you have a Movies collection with an Actors field that contains references to items in a People collection. Querying the Movies collection using queryReferencedDataItems() returns the relevant People items referenced in the Actors field of the specified Movie item. This gives you information from the People collection about each of the actors in the specified movie.

Removes an item from a collection.

If any items in other collections reference the removed item in reference or multi-reference fields, those fields are cleared.

Removes the specified reference from the specified field.

Replaces references in a specified field of a specified data item.

This function replaces the existing reference or references contained in the field specified in options.referringItemFieldName within the data item specified in options.referringItemId. The function removes existing references and in their place it adds references to the items specified in options.newReferencedItemIds.

Inserts or updates an item in a collection.

The saveDataItem() function inserts or updates the specified item, depending on whether it already exists in the collection.

• If you don't provide an ID, a new item is created.

• If you provide an ID that does not exist in the collection, a new item is created with that ID.

• If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its data._updatedDate field is changed to the current date and time.

Removes all items from a collection.

If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.

Updates an item in a collection.

This function replaces the data item's existing data with the payload provided in options.dataItem.data in the request.

To update an item, you need to specify an item ID and a collection ID. If an item is found in the specified collection with the specified ID, that item is updated. If the collection doesn't contain an item with that ID, the request fails.

When an item is updated, its data._updatedDate field is changed to the current date and time.