What's New
Changelog - 5.2.1
Release 5.2
Changelog - 5.1.3
Changelog - 5.1.2
Changelog - 5.1.1
Release 5.1
Changelog - 5.0.5
Changelog - 5.0.4
Changelog - 5.0.3
Changelog - 5.0.2
Changelog - 5.0.1
Release 5.0
Changelog - 4.3.4
Changelog - 4.3.3
Changelog - 4.3.2
Changelog - 4.3.1
Release 4.3 (Fall 2023)
Changelog - 4.2.7
Changelog - 4.2.6
Changelog - 4.2.5
Changelog - 4.2.4
Changelog - 4.2.3
Changelog - 4.2.1
Changelog - 4.2.2
Release 4.2
Changelog - 4.1.5
Changelog - 4.1.4
Changelog - 4.1.3
Changelog - 4.1.2
Changelog - 4.1.1
Release 4.1
Release 4.0
Release 3.9
Release 3.8
Release 3.7
Release 3.6
Release 3.5
Release 3.4
Release 3.3
Release 3.2
Release 3.1
Release 3.0
Release 2.4.1
Release 2.4
Free Cloud Trial
Release 1.8
Release 2.3
Release 2.2
Release 2.1
Release 2.0
Release 1.7
Release 1.6
Release 1.5
Getting Started
Quick Guide
Best Practices Guide
Search - Best Practices
Vizpads (Explore) - Best Practices
Insights (Discover) - Best Practices
Predict - Best Practices
Data - Best Practices
Glossary
Tellius 101
Navigating around Tellius
System requirements
Tellius Architecture
Installation steps for Tellius
Guided tours for quick onboarding
Customizing Tellius
Search (Natural Language)
Search in Tellius
Guide Me
How to Search
Business View List / Columns
Query
Query
Percentage Queries
Time Period Queries
Live Query
Generating Insights-based queries from Search
Search Result
Discover Insights
Interactions
Chart Operations
Add to Vizpad
Table View
Switch Chart type
Change Chart Config
Apply Filters
Change Formatting
Measure Aggregation - Market Share Change
View Raw Data
Download/ Export
Embed URL
Partial Data for Visualization
Best-fit visual
Add to Vizpad
Adding the chart to a Vizpad
Customize the auto-picked columns
Search Query Inspector
Teach Tellius
History
Guided Search
Add Guided Search Experience
Display Names in the Search Guide
Guided Search
Guided Search Syntax and Attributes
Deep Dive
Maps in Search
Search Keywords
Percentage Queries
Time Period Queries
Year-over-Year Analysis
Additional Filters
Pagination
List View In Search Results
Marketshare queries
Embed Search
Personalized Search
Search Cheat Sheet
Filters in Help Tellius Learn
Explore (Vizpads)
Dashboards in Tellius
Vizpad Creation
Create Interactive Content
Create Visualization Charts
List of Charts
Common Chart Types
Line Chart
Bar Chart
Pie Chart
Year-over-Year Functionality in Vizpad
Area Chart
Combo Chart
KPI Target Chart
Treemaps
Bubble Chart
Histogram
Heat-Map Charts
Scatter Chart
Other Charts
Cumulative line chart
Cohort Chart
Explainable AI Charts
For each chart
Create Visualization Charts
Global Filters
Embedded Filters
Other Content
Anomaly management for charts
Creating Interactive Content
Vizpad level Interactions
Viz level Interactions
Discover Insights
Drivers
Discover hidden insights - Genius Insights
How Genius Insights works
Discoveries in Insight
Anomalies on Trend
Interactions
Chart Operations
Switch Chart type
Change Chart Config
Apply Filters
Change Formatting
Add X/Y Axis Target Lines to Scatter Chart
Improvements to Conditional Formatting
Adding Annotations to Tables
Displaying query execution time
Embedding Vizpad
Vizpad Consumption
Collection of Interactive Content
Vizpad level Interactions
Global Filter on the fly
Global Resolutions
Refresh
Notifications / Alerts
Share
Download / Export
Unique name for Vizpads
Edit Column Width
Viz level Interactions
Importing bulk filter values
Multi-Business View Vizpads
Discover (Genius Insights)
Discoveries
What are discoveries
Type of Discoveries in Tellius
Create Discoveries
Kick-off Key Drivers
Edit Insights
Key Driver Insights
Components of Key Drivers
What are Key Drivers
Edit Key Driver Insights
Segment Drivers
Trend Drivers
Trend Insights (Why Insights)
Components of Trend Insights
WHAT: Top Contributors
WHY: Top Reasons
HOW: Top Recommendations
Seamlessly navigating to "Why" from "What"
Create Trend Insight
Edit Trend Insights
What are Trend Insights
Comparison Insights
Components of Comparison Insights
Create Comparison Insight
What are Comparison Insights
Edit Comparison Insights
Others Actions
Save
Refresh
Share Insights
Download
Adding Insights to Vizpad
Insights Enhancements
Embedding Insight
Impact Calculation for Top Contributors
Marketshare
Live Insights
Predict (Machine Learning)
Machine Learning
AutoML
How to create AutoML models
Leaderboard
Prediction
Others
What is AutoML
Point-n-Click Predict
Feed (Track Metrics)
Assistant (Conversations)
Tellius on Mobile devices
Data (Connect, Transform, Model)
Connectors
Connector Setup
Google BigQuery
Google Cloud SQL
Connecting to a PostgreSQL Cloud SQL Instance
Connecting to an MSSQL Cloud SQL Instance
Connecting to a MySQL Cloud SQL Instance
Snowflake
PrivateLink
Snowflake Best Practices
OAuth support for Snowflake
Integrating Snowflake with Azure AD via OAuth
Integrating Snowflake with Okta via OAuth
Edit Connector
Live Connect
Data Import
Cache
Direct Business View
JDBC connector for PrestoDB
Amazon S3
Time-to-Live (TTL) and Caching
Loading Excel sheets
Looker SQL Interface
Databricks
Connecting to an AlloyDB Cluster
List of Connectors by Type
Tables Connections
Custom SQL
Schedule Connector Refresh
Share Connections
Datasets
Load Datasets
Configure Datasets (Measure/Dimensions)
Transform Datasets
Create Business View
Share Datasets
Copy Datasets
Delete Datasets
Swapping datasources
Metadata migration
Data Prep
Datasets
Data Profiling / Statistics
Transformations
Dataset Transform
Aggregate Transforms
Calculated Columns
SQL Transform
Python Transform
Create Hierarchies
Filter Data
SQL Code Snippets
Multiple Datasets Scripting SQL
Column Transforms
Column Metadata
Column type
Feature type
Aggregation
Data type
Special Types
Synonym
Rename Column
Filter Column
Delete Column
Variable Display Names
Other Functions
Metadata View
Dataset Information
Dataset Preview
Alter Pipeline Stage
Edit / Publish Datasets
Data Pipeline (Visual)
Alerts
Partitioning for JDBC Datasets
Export Dataset
Write-back capabilities
Data Fusion
Schedule Refresh
Business Views
Create Business View
Create Business View
Datasets Preview & List
Add datasets to Model
Joins
Column selection
Column configuration
Primary Date
Geo-tagging state/country/city
Save to Fast Query Engine
Publish
Business View
What is Data Model
BV Visual Representation (Preview)
BV Data Sample
Learnings (from Teach Me)
Custom Calculations (Report-level Calc)
Predictions on BV
BV Refresh
Export/ Download Business View
Share Business View
URL in Business View
Request Edit Access
Tellius Engine: Comparison of In-Memory vs. Live Mode
Projects (Organize Content)
Monitor Tellius
Embedding Tellius
Embedding
Settings
About Tellius
User Profile
Admin Settings
Manage Users
Team (Users)
Details & Role
Create a new user
Edit user details
Assigning the user data to another user
Restricting the dataset for a user
Deleting a user
Assign User Objects
User roles and permissions
Teammates (Groups)
Authentication & Authorization
Authentication
Authorization (Roles)
API Access (OAuth Access)
Audit Logs
Application & Advanced Settings
Data
Machine Learning
Genius Insights
Usage tracking & Support
CDN
Download Business View, Dataset, and Insights for Live BV
Customize Help
Impersonate
Data Size Estimation and Calculation
Miscellaneous Application Settings
Configuration for time/date-related results
Dataflow Access
Enable In-memory operations on Live sources
Language Support
Administration
Setup & Configuration
Installation Guide
AWS Marketplace
Autoscaling
Backup and Restore
Help & Support
FAQ
Data Preparation FAQs
Environment FAQs
Search FAQs
Vizpads FAQs
Data Caching
Security FAQs
Embedding FAQs
Insights FAQs
Tellius Product Roadmap
Help and Support System
Guided Tours
Product Videos
Articles & Docs
Provide Feedback
Connect with Tellius team
Support Process
Notifications
Tellius Kaiya
Say hello to Tellius Kaiya 👋
Automating the generation and validation of SQL/Python code
Kaiya Learnings
Automating the generation of metadata
Kaiya mode in Search
Chart and tab summaries
Getting Started Videos
Getting Started
Tellius Connect
Tellius Data Overview Video
Connecting to Flat Files Video
Connecting to Data Sources Video
Live Connections Video
Data Refresh and Scheduling Video
Tellius Prep
Getting Started with Tellius Prep Video
Transformations, Indicators, Signatures, Aggregations and Filters Video
SQL and Python Video
Working with Dates Video
Data Fusion Video
Business View Video
Business Mapping Video
Report Level Calculations Video
Writeback to DB
Natural Language Search
Getting Started with Search Video
How-To Search Video
Customizing Search Results Video
Search Interactions Video
Help Tellius Learn
Explore - Vizpads
Getting Started with Vizpads Video
Creating Vizpads Video
Creating and Configuring Visualizations Video
Viz-Level Interactions Video
Vizpad-Level Interactions Video
Auto Insights
Getting Started with Auto Insights Video
Discovery Insights Video
Segment Insights Video
Trend Insights Video
Comparison Insights Video
Iterate on Insights Video
Tellius Feed Video
Predict - ML Modeling
Getting Started with Predict Video
AutoML Configuration Video
AutoML Leaderboard Video
Point-n-Click Regression Video
Point-n-Click Classification Video
Point-n-Click Clustering Video
Point-n-Click Time Series Video
Point-n-Click PythonML Video
PredictAPI Video
Apply ML Model Video
ML Refresh and Schedule Video
Admin
Best Practices & FAQs
API Documentation
Vizpad APIs
User & user groups APIs
Machine Learning APIs
Fall 2023 (4.3)
Table of Contents
- All Categories
- API Documentation
- Vizpad APIs
- Vizpad-related APIs
Vizpad-related APIs
Updated by Ramya Priya
Here, you can find APIs for
- Creating a Vizpad (POST)
- Getting a list of all Vizpads (GET)
- Renaming a Vizpad
- Deleting a Vizpad (DELETE)
- Cloning a Vizpad
- Sharing a Vizpad with a user/user group
- Disassociating a Vizpad from a user/user group
- Getting the list of user/user groups a Vizpad is shared with
- Generating embedding URL for a Vizpad
For accessing the following APIs, JSON Web Token (JWT) needs to be generated using login API.
Create a Vizpad
The API can be used to create a new Vizpad.
Request
URL
https://<TelliusUrl>/vizpad
CURL
curl -X POST 'https://<TelliusUrl>/vizpad'
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer token' \
--data-binary '{"title":"name of the vizpad","thumbnail":"","sharingByLink":true,"sharedWith":[],"businessViewId":"businessView_id","tabs":[{"id":"id for the tab","name":"tab name","placements":[],"filters":{"timeFilters":[],"valueFilters":{"operator":"and","negate":false,"id":null,"args":[]}}}]}'
Method
POST
Headers
By default, only superUsers can access this view.
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Body
{
"title":"name of the vizpad",
"thumbnail":"",
"sharingByLink":true,
"sharedWith":[],
"businessViewId":"businessView_id",
"tabs":[{
"id":"id for the tab",
"name":"tab name",
"placements":[],
"filters":{
"timeFilters":[],
"valueFilters":{"operator":"and","negate":false,"id":null,"args":[]}
}
}]
}
Response
Success
Status Code: 200 OK
Body
A new Vizpad with the following properties will be created.
{
"updatedAt":"2020-08-27T10:52:33.422707",
"title":"name of the vizpad",
"tabs":[{
"placements":[],
"name":"Name of the tab",
"id":"tab id",
"filters":{
"valueFilters":{
"operator":"and",
"negate":false,
"args":[]},
"timeFilters":[]}}],
"sharingByLink":true,
"sharedWith":[],
"owner":{
"username":"username",
"lastName":"last name",
"id":"user-id",
"firstName":"firstName"},
"id":"id for the vizpad",
"elements":[],
"createdAt":"timestamp of when it was created",
"businessViewId":"business view id"
}
Get a list of Vizpads
A Vizpad is made up of one or more tabs, and each tab consists of multiple viz. The API can be used to get the list of Vizpads. We need to send the username and password to receive the JWT token from the API response:
Request
URL
https://<TelliusUrl>/vizpad?&includingShared=true&withSharings=true&limit=2&offset=0
CURL
curl -X POST 'https://<TelliusUrl>/vizpad'
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer token' \
--data-binary '{"title":"name of the vizpad","thumbnail":"","sharingByLink":true,"sharedWith":[],"businessViewId":"businessView_id","tabs":[{"id":"id for the tab","name":"tab name","placements":[],"filters":{"timeFilters":[],"valueFilters":{"operator":"and","negate":false,"id":null,"args":[]}}}]}'
Method
GET
Headers
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Response
Success
Status Code: 200 OK
Body
The list of existing Vizpads will be retrieved.
{
"vizPads":[
{
"vizPad":{
"vizItemsCount":4,
"updatedAt":"2020-05-29T06:05:06.553270",
"title":"Untitled 202005291133",
"timeRange":{
},
"thumbnail":"cebc379c-4528-4513-985d-96e3cba08f58",
"tabs":[
{
"placements":[
{
"vizTitle":"Untitled viz746",
"vizId":"9a2d6c29-4311-49c0-a7e1-4af6ce3faf87",
"sizeY":4,
"sizeX":4,
"row":0,
"col":0
},
{
"vizTitle":"Untitled viz64",
"vizId":"b02b5d54-b6b3-4e1d-bd72-e56ffa84d5db",
"sizeY":4,
"sizeX":4,
"row":0,
"col":4
},
{
"vizTitle":"Untitled viz839",
"vizId":"71ea78df-3431-4876-9b0b-7d103314cee4",
"sizeY":4,
"sizeX":4,
"row":0,
"col":8
},
{
"vizTitle":"Untitled viz659",
"vizId":"24d78e7f-2277-4095-9b79-1ad395d470e2",
"sizeY":4,
"sizeX":4,
"row":4,
"col":0
}
],
"name":"Tab 1",
"id":"b5c82d04-b6c9-473d-89eb-5bd1311cce36",
"filters":{
"valueFilters":{
"operator":"and",
"negate":false,
"args":[
]
},
"timeFilters":[
]
}
}
],
"sharingByLink":true,
"sharedWith":[
],
"settings":{
},
"placement":[
],
"owner":{
"username":"superUser",
"id":"2bcfb55d-d984-4e01-a5fb-bacd471bb5b4"
},
"id":"1d2fa8bf-e3f5-4eeb-8127-1c267b844cd5",
"gradientPaletteId":"2cc9e757-9aa0-41e4-a46a-71fef9b590b0",
"elements":[
],
"createdAt":"2020-05-29T06:03:59.672464",
"colorPaletteId":"7bd98706-4982-411c-aa1c-fd0f41f7a076",
"businessViewId":"bv_7c08af86-e865-43c3-8f78-b92a624d2d7b"
},
"sharings":[
],
"readOnly":false
},
{
"vizPad":{
"vizItemsCount":1,
"updatedAt":"2020-05-29T06:00:00.646384",
"title":"Untitled 202005291129",
"timeRange":{
},
"thumbnail":"b490d590-7ade-40ac-bd33-8b545abf110f",
"tabs":[
{
"placements":[
{
"vizTitle":"Untitled viz995",
"vizId":"0da50d20-3c7b-4638-a4bc-60f4f292b70b",
"sizeY":4,
"sizeX":4,
"row":0,
"col":0
}
],
"name":"Tab 1",
"id":"4e57fb43-a435-410f-ac99-fee1bd6c8412",
"filters":{
"valueFilters":{
"operator":"and",
"negate":false,
"args":[
]
},
"timeFilters":[
]
}
}
],
"sharingByLink":true,
"sharedWith":[
],
"settings":{
},
"placement":[
],
"owner":{
"username":"superUser",
"id":"2bcfb55d-d984-4e01-a5fb-bacd471bb5b4"
},
"id":"597d3f28-5f8a-40d8-9404-c031e21bae8e",
"gradientPaletteId":"2cc9e757-9aa0-41e4-a46a-71fef9b590b0",
"elements":[
],
"createdAt":"2020-05-29T05:59:38.302939",
"colorPaletteId":"8858c2b5-b714-4ca4-9522-bc2d6c3c9911",
"businessViewId":"bv_7c08af86-e865-43c3-8f78-b92a624d2d7b"
},
"sharings":[
],
"readOnly":false
}
],
"totalCount":8
}
Rename a Vizpad
The API can be used to rename any existing Vizpad.
Request
URL
Replace vizpad_id
with the ID of the Vizpad which needs to be renamed.
https://<telliusUrl>/vizpad/<vizpad_id>
CURL
curl 'https://<tellius-url>/vizpad/327e1130-75e4ef19d88b' \
-X 'PUT' \
-H 'Authorization: Bearer token' \
--data-binary '{"title":"new vizpad name"}'
Method
PUT
Headers
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Body
{
"title": "new vizpad name"
}
Response
Success
Status Code: 200 OK
Body
A new Vizpad with the following properties will be created.
{
"id": "327e1130-75e4ef19d88b",
"title": "new vizpad name"
}
Delete a Vizpad
The API can be used for deleting any existing Vizpad.
Request
URL
Replace vizpad_id
with the ID of the Vizpad which needs to be deleted.
https://<telliusUrl>/vizpad/<vizpad_id>
CURL
curl 'https://<TelliusUrl>/vizpad/<vizpad_id>' \
-X 'DELETE' \
-H 'Authorization: Bearer token' \
--data-binary '{}' \
Method
DELETE
Headers
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Response
Success
Status Code: 200 OK
Body
If the Vizpad is successfully deleted, the API will return a response with HTTP status code 200 and an empty response body.
Clone a Vizpad
The API can be used to create a duplicate of any existing Vizpad.
Request
URL
Replace vizpad_id
with the ID of the Vizpad which needs to be cloned.
https://<telliusUrl>/vizpad/clone/<vizpad_id>
CURL
curl -X 'POST'\
'https://<telliusUrl>/vizpad/clone/<vizpad_id>' \
-X 'POST' \
-H 'Authorization: Bearer token' \
--data-binary '{"title":"Name for the cloned vizpad"}'
Method
POST
Headers
By default, only superUsers can access this view.
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Body
{
"title": "Name for the cloned vizpad"
}
Response
Success
Status Code: 200 OK
Body
The response body returns the details of the newly cloned vizpad, including its ID, title, tabs, owner, and timestamp of creation.
{
"updatedAt": "timestamp",
"title": "newly cloned vizpad name",
"tabs": [
{
"placements": [],
"name": "tab name",
"id": "tab id",
"filters": {
"valueFilters": {
"operator": "and",
"negate": false,
"args": []
},
"timeFilters": []
}
}
],
"sharingByLink": true,
"sharedWith": [],
"owner": {
"username": "username",
"lastName": "lastName",
"id": "user_id",
"firstName": "firstName"
},
"id": "new_vizpad_id",
"elements": [],
"createdAt": "timestamp",
"businessViewId": "businessView_id"
}
Share a Vizpad with a user or user group
The API can be used to share an existing Vizpad with any user/ user group.
Request
URL
https://<TelliusUrl>/share
CURL
curl -X 'POST'\
'https://<telliusUrl>/share' \
-H 'Authorization: Bearer token' \
--data-binary '{"sharedWithId":"user id of the user to share with","objectId":"vizpad id" ,"objectKind":"vizPad","permission":"w[for write] or r [for view]","sharedWithKind":"user or group"}'
Method
POST
Headers
By default, only superUsers can access this view.
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Body
{
"sharedWithId": "user id of the user/group to share with",
"objectId": "vizpad id",
"objectKind": "vizPad",
"permission": "w [for write] or r [for view]",
"sharedWithKind": "user or group"
}
Response
Success
Status Code: 200 OK
Body
The response body returns the details of the sharing, including the sharing ID, the ID of the shared vizpad, the ID and name of the user or group it was shared with, and the level of permission granted.
{
"sharings": [
{
"updatedAt": "timestamp",
"sharedWithName": "user/group name",
"sharedWithKind": "user or group",
"sharedWithId": "shared with user/group id",
"permission": "w [for write] or r [for view]",
"owner": {
"username": "username",
"id": "user id of the owner"
},
"objectKind": "vizPad",
"objectId": "vizpad id",
"id": "object id",
"createdAt": "timestamp"
}
]
}
Dissociate a Vizpad from a user or user group
The API can be used to remove the sharing permissions of a Vizpad.
Request
URL
https://<TelliusUrl>/share/<share_id>
CURL
curl 'https://<telliusUrl>/share/<share_id>' \
-X 'DELETE' \
-H 'Authorization: Bearer token' \
--data-binary '{}'
Method
DELETE
Headers
By default, only superUsers can access this view.
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json
Response
Success
Status Code: 200 OK
Body
The response body will contain the details of the vizpad that was unshared, including its ID, the name of the user or user group it was shared with, the permission level (write or view), and the ID of the owner of the vizpad.
{
"sharings":[{
"updatedAt":"timestamp",
"sharedWithName":"user/group name",
"sharedWithKind":"user or group",
"sharedWithId":"shared with user/group id",
"permission":"w [for write] or r [for view]",
"owner":{
"username":"username",
"id":"user id of the owner"},
"objectKind":"vizPad",
"objectId":"vizpad id",
"id":"object id",
"createdAt":"timestamp"
}]
}
List users or user groups a Vizpad is shared with
The API retrieves the list of users/user groups with whom a specific Vizpad has been shared.
Request
URL
https://<telliusUrl>/share?includingShared=true&objectKind=vizPad&objectId=<vizpad_id>
CURL
curl -X 'GET'
'https://<TelliusUrl>/share?includingShared=true&objectKind=vizPad&objectId=<vizpad_id>' \
-H 'Connection: keep-alive' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer token'
Method
GET
Headers
By default, only superUsers can access this view.
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Connection: keep-alive
Content-Type: application/json
Response
Success
Status Code: 200 OK
Body
The response body will contain a list of shared objects for the specified vizpad, including details such as the name of the user or user group it was shared with, the permission level (read or write), and the ID of the owner of the vizpad. If there are no shared objects for the specified vizpad, the response body will be an empty array.
{
"sharings":[{
"updatedAt":"timestamp",
"sharedWithName":"userName",
"sharedWithKind":"user or group",
"sharedWithId":"share_with_id",
"permission":"r or w [depending on read or write permission]",
"owner":
{
"username":"username",
"id":"user_id"
},
"objectKind":"vizPad",
"objectId":"object_id",
"id":"share_id",
"createdAt":"timeStamp"}]
}
Get the list of Business Views
The API retrieves the list of Business Views.
Request
URL
https://<TELLIUS_URL>/businessViews?includeColumns=true&includingShared=true&withSharings=true
CURL
curl -X GET \
https://<TELLIUS_URL>//businessViews?includeColumns=true&includingShared=true&withSharings=true \
-H 'authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>' \
-H 'content-type: application/json' \
Method
GET
Headers
By default, only superUsers can access this view.
Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json
Response
Success
Status Code: 200 OK
Body
The response body will retrieve the list of Business Views.
{
"totalCount": <total number of business views>,
"businessViews": [
{
"sharings": [],
"readOnly": <read-only status of the business view>,
...
"businessView": {
"updatedAt": "<date and time of the last update of the business view>",
"searchTokens": [],
...
},
...
},
{
"sharings": [],
"readOnly": <read-only status of the business view>,
...
},
...
]
}
Generate embedding URL for Vizpad
A new embedding URL has to be created for every tab in a Vizpad. Embedding URL for a Vizpad can be generated in View mode & Edit mode.
URL format for view mode
https://<TelliusUrl>/dashboard/<VizpadId>/<TabId>?access=read&datasetId=<BusinessViewId>&jwt=<JWT token received from the API>
URL format for edit mode
https://<TelliusUrl>/dashboard/<VizpadId>/<TabId>?access=edit&datasetId=<BusinessViewId>&jwt=<JWT token received from the API>