API Reference: Data Views

Overview

Data Views are saved configurations that define how a collection's records are presented — which fields to display, how to filter, sort, and group, and which layout to render (LIST, TABLE, CALENDAR, MAP, DETAIL, PIVOT, CHART, or STATS). The standard-tier endpoints on this page list views, read a view's definition, and page through the records the view exposes. View authoring (creating views, managing display/filter fields, share tokens) is a privileged-tier surface — see Admin & Authoring Operations below.

Key Concepts

• Saved configuration — A view stores which fields to show plus filters and sort order; the definition is returned under config when you fetch a single view.
• Underlying collection — Every view belongs to one Data Collection (dataCollectionSimplyId), and reading a view requires read permission on that collection.
• View types — enumDataViewTypeId is one of LIST, DETAIL, CALENDAR, TABLE, MAP, PIVOT, CHART, STATS.
• External visibility — isPublished indicates the view is externally visible and can be embedded on third-party websites with a public access token.

List Data Views

Retrieve the views whose underlying collections your API key can read. Each item includes id, name, description, dataCollectionSimplyId, enumDataViewTypeId, and isPublished.

TypeScript SDK

const views = await s360.dataViews.list();

for (const view of views.data) {
  console.log(`${view.id}: ${JSON.stringify(view.name)} [${view.enumDataViewTypeId}] -> ${view.dataCollectionSimplyId}`);
}

cURL

curl -s "https://api.simply360.app/v1/data-views" \
  -H "Authorization: Bearer $S360_API_KEY"

Get a Data View

Retrieve a single view. The response adds a config object with the saved columns, filters, and sortOrder.

TypeScript SDK

const view = await s360.dataViews.get('VIEW-1234-ABCD');
console.log(`Name: ${JSON.stringify(view.data.name)}`);
console.log(`Type: ${view.data.enumDataViewTypeId}`);
console.log(`Collection: ${view.data.dataCollectionSimplyId}`);

cURL

curl -s "https://api.simply360.app/v1/data-views/VIEW-1234-ABCD" \
  -H "Authorization: Bearer $S360_API_KEY"

List a View's Records

Page through the records the view exposes. Each row is a record summary — id, dataCollectionSimplyId, name, isArchived, createdAt, updatedAt — returned newest first with limit (1–100, default 25) and offset pagination.

This endpoint currently returns summaries of the underlying collection's records; it does not include field values and does not apply the view's saved filter and sort configuration server-side. To retrieve field values or filtered result sets, read the view's config and use the Data Records list or search endpoints against the view's collection.

TypeScript SDK

const records = await s360.dataViews.getRecords('VIEW-1234-ABCD', {
  limit: 50,
  offset: 0,
});

console.log(`Total: ${records.meta.pagination.total}`);
for (const record of records.data) {
  console.log(record.id, record.name);
}

cURL

curl -s "https://api.simply360.app/v1/data-views/VIEW-1234-ABCD/records?limit=50" \
  -H "Authorization: Bearer $S360_API_KEY"

Public / Embedded Views

Data Views with External Visibility enabled can be embedded on third-party websites using the Simply360 embed library plus a public access token. Two token types exist: EMBED (purpose DATAVIEW_EMBED, used by the embed library) and ICS_FEED (calendar-feed URLs). Tokens authorize anonymous traffic to the published view without exposing your API key.

Manage tokens in the dashboard under the view's Embedding tab, or through the privileged token endpoints (POST / GET / DELETE /v1/data-views/{dataViewSimplyId}/public-access-tokens/{tokenType}). See Embedding DataViews, Wizards & the Conversation Widget for the full embed walkthrough.

Admin & Authoring Operations

DataView Studio authoring is exposed as privileged-tier endpoints (admin feature permissions required; not available to OAuth-scoped tokens):

Endpoint	Description
POST /v1/data-views / DELETE /v1/data-views/{dataViewSimplyId}	Create or delete an admin DataView.
GET / PUT /v1/data-views/{dataViewSimplyId}/admin-detail	Read or update the full authoring detail record.
GET /v1/data-views/admin-list	Audience- and permission-filtered View Studio authoring list. Pass dataCollectionSimplyId to restrict the list to one readable Collection before pagination.
GET /v1/data-views/by-collection/{dataCollectionSimplyId}	Collection-readable picker summaries only: public View ID, name, type, visibility flags, and Collection identity. Saved authoring configuration is never returned.
.../display-field-links, .../filter-field-links, .../calendar-date-info-field-links	Add, update, delete, and reorder the view's display, filter, and calendar date field links.
GET /v1/data-views/{dataViewSimplyId}/eligible-fields	List fields eligible for the view's display links.
GET /v1/data-views/{dataViewSimplyId}/share-readiness	Share-readiness checks for DataView Studio.
GET /v1/data-views/internal-name-validation	Validate an internal name within the selected team.

Usage Notes

• Views respect data permissions: listing or reading a view requires read access to its underlying collection, and callers without full data access only see views for collections they can read.
• Direct legacy /dataview configuration routes require sysadmin, Team Admin, or full-data access. New first-party authoring clients use the audience- and field-guarded /v1 routes.
• The collection picker and admin list use page and pageSize. Execution-record endpoints use limit and offset. Totals are in meta.pagination. See Pagination, Sorting & Field Selection.
• GET /v1/data-views/{dataViewSimplyId}/internal-token (standard tier) returns the internal token first-party surfaces use to render a view.
• Views reference their fields and collection by simplyId, so view configurations are portable across environments.