Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT data services

Data views and the API Console

  • Last UpdatedApr 22, 2024
  • 2 minute read

While creating or editing a data view, you can launch it within the API Console by choosing the View in API Console button. Launching the data view in the API console allows you to refine the data view endpoint query before specifying its URI in your application code or Microsoft Power BI.

View in API Console button

The View in API console button.

Data view API console parameters

When viewing a data view from the API Console, you can edit the default parameters that you configured during initial creation of the data view. Additionally, you can provide continuation tokens (in support of data pagination), caching data, or choose different support response formats.

Field

Description

startIndex

The inclusive start boundary of the data view data.

endIndex

The inclusive end boundary of the data view data.

count

The number of data points included in the request.

interval

The requested interval between index values.

continuationToken

The field for specifying a continuation token when a request returns. For more information on this field and the Load from Response button, see API console.

cache

The field for setting cache behavior. Values include:

  • Preserve (default): Uses cached information, if available.

  • Refresh: Forces the resource to re-resolve.

form

The file format that request response returns. For information on the response forms available, see the table below.

Response forms

When requesting data views from the API Console, the REST API is capable of returning requests in a variety of file formats. Select a form from the dropdown. Supported response forms include:

Form

Description

default (JSON)

Object-style JSON.

table (Table)

Table-style JSON.

tableh (Table with headers)

Table-style JSON with header row.

csv (Comma separated values)

Comma-separated values.

csvh (Comma separated values with headers)

Comma-separated values with header row.

parquet (Apache Parquet)

Parquet format. For more information on the Parquet format, see Parquet data format.

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in