Create and configure a data view

This is an introduction to the recommended workflow for creating and defining data views. Review the following information before creating a data view.

Prerequisites

• To create a fully functioning data view, your instance of CONNECT data services must include Streams or Assets to include in the data view.

• If you want to include streams from a community within your data view, you must be a member of that community.

Data view objects

A data view is a declarative query and shape for your data. It includes the following objects, which you will configure as you complete the data view creation workflow:

• Query: Determines what data items are included in a data view. Queries can include streams or assets. A data view can have multiple queries.

• Data field set: Collections of fields originating from the same query.

• Data view shape: Determines if the data should be returned in the standard grouped row format or a narrow view, which is a pivot of the standard table.

• Index field: Determines the primary index type and label of the index. The index must be a timestamp and displays in the first column of the data view.

  Note: You can create data views with non-DateTime indexes using the REST API.

Data views also include other configurations such as grouping instructions and default date range and interval.

Design in iterations

Designing and editing a data view is an iterative process. Your first iteration of the data view will likely not work as expected and will require additional iterations. Adjust the included queries and data fields until it meets your requirements.

Only time series data is supported by the data views editor. For other data types, use the API console to read or update the data view.

API console

While creating or editing a data view, use the View in API Console to open the view in the API console. The API console includes the URI and query values for accessing your data view in its current configuration.

View in API Console button

Data view creation workflow

To create and define a data view, complete these tasks in order.

• Add a data view

  Begin creation of a data view by creating a data view object, which includes a name and description for the data view. The data view will not yet include any queries or data fields yet—you will add those later.

• Add a query

  Each data view includes one or more query. These queries determine what data items (streams or assets) are included in the data view.

• Select data field sets

  A data view includes one or more data field sets, which are collections of data fields originating from the same query. A data field is a property or metadata from the streams or assets included in a query. One field serves as the index while others contain information related to the data items (streams or assets).

  When configuring a data view, you can configure the data field set for each query by choosing which data fields you want to include in the data view.

• Configure data shape

  Data views can be configured to return data in either a standard shape or a narrow shape. Standard shape returns data in a grouped row format. Narrow shape is a pivot of the standard table.

• Preview and save the data view

  As you work with your data view, you can generate a preview of how the data will be shaped and organized. After you are satisfied with how the data is organized in the preview, you can view its URI in the API console to begin working with the data in a third-party application.