Platform
-
Interactive DashboardsCreate interactive BI dashboards with dynamic visuals.
-
End-User BI ReportsCreate and deploy enterprise BI reports for use in any vertical.
-
Wyn AlertsSet up always-on threshold notifications and alerts.
-
Localization SupportChange titles, labels, text explanations, and more.
-
Wyn ArchitectureA lightweight server offers flexible deployment.
Featured from Blog
-
Wyn Enterprise 7.1 is ReleasedThis release emphasizes Wyn document embedding and enhanced analytical express... -
Choosing an Embedded BI Solution for SaaS ProvidersAdding BI features to your applications will improve your products, better serve your customers, and more. But where to start? In this guide, we discuss the many options.
Resource Library
-
Visual GalleryInteractive sample dashboards and reports.
-
BlogExplore Wyn, BI trends, and more.
-
WebinarsDiscover live and on-demand webinars.
-
Customer SuccessVisualize operational efficiency and streamline manufacturing processes.
-
Knowledge BaseGet quick answers with articles and guides.
-
VideosVideo tutorials, trends and best practices.
-
WhitepapersDetailed reports on the latest trends in BI.
New Guide
-
Choosing an Embedded BI Solution for SaaS ProvidersAdding BI features to your applications will impr... -
- v1
-
v2
- Admin
- ChatAnalysis
- ChatTokenUsage
- Common
- Custom-Themes
- Dashboard
- DashboardFilterView
- DataModel
- Dataset
- Datasource
- Documents
- DownloadSmartDocument
- Draft
- Identity
- Identity-Organization
- Identity-Role
- Identity-Token
- Identity-User
- K8s
- Language-Packages
- Languages
- Notebook
- QueueMonitor
- Reporting-CachingSettings
- Reporting-ExportTemplates
- Reporting-RenderResults
- Reporting-Reports
- Reporting-UserFunctions
- Scene
- Scheduler
- Shared-Resources
- SmartDocuments
- Tags
- overview
Dataset
Dataset
[POST] /api/v2/data/datasets/{id}/export
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | dataset document id. For example: 4d4dc304-8ae5-16e4-c790-a8b87a7246b2 |
Export dataset document.
Request Body
Description: dataset export model
Type: application/json
Responses
[200] Success
binary
Type: [application/octet-stream]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[PUT] /api/v2/data/datasets/cached-datasets/batch-refresh
Batch refresh dataset data.
Request Body
Description: batch refresh model
Type: application/json
BatchRefreshDatasetRequestModel
Responses
[200] Success
BatchRefreshDatasetTaskResultModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/data/datasets/{id}/download
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | document id. For example: 15fd3940-e83c-19d7-246d-81b2ccb7e195 |
Download a dataset document.
Responses
[200] Success
binary
Type: [application/octet-stream]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[GET] /api/v2/data/datasets/{id}/definition
Parameters
| Name | In | Type | Description | Default |
|---|---|---|---|---|
| idRequired | path | string | dataset document id. For example: b305fb39-c9b0-4aa6-a462-b69733d991c3 | |
| useView | query | boolean | Whether to use view mode when querying dataset definition. Default is true. | true |
Get dataset definition by id.
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/data/datasets/empty
Create an empty dataset.
Request Body
Description: The request model for creating empty dataset.
Type: application/json
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/data/datasets/cached-datasets/list
Get all cached dataset
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/data/datasets/cached-datasets/cache-infos
Parameters
| Name | In | Type | Description | Default |
|---|---|---|---|---|
| pageSize | query | integer | The number of data displayed per page. -1 means all data. | -1 |
| pageNumber | query | integer | Current page number.Start from 1. | 1 |
| orderBy | query | string | Indicates which column the data is sorted by. | "" |
| search | query | string | Name filter. | "" |
| invalid | query | boolean | Whether to display only invalid data. | false |
Get all cached dataset
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[POST] /api/v2/data/datasets/push-datasets/{id}/append-data
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | Dataset id. For example: 96f08381-f07c-3b0f-5f43-e84491b1616b |
| pushDataToken | query | string | Push data token |
Add Push Dataset data by id.
Request Body
Description: Insert data model
Type: application/json
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[POST] /api/v2/data/datasets/push-datasets/{id}/clear-data
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | Dataset id. For example: 96f08381-f07c-3b0f-5f43-e84491b1616b |
| pushDataToken | query | string | Push data token |
Delete Push Dataset data by datasetId according to conditions.
Request Body
Description: Clear data model
Type: application/json
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[POST] /api/v2/data/datasets/streaming-datasets/{id}/append-data
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | Dataset id. For example: 006fa63d-2b21-0433-5785-9c8751dba0b4 |
| pushDataToken | query | string | Push data token |
Add Streaming DataSet Data by id.
Request Body
Description: Insert data model
Type: application/json
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[GET] /api/v2/data/datasets/{id}/query
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | dataset id |
| query | query | string | query |
| queryType | query | string | query type |
| format | query | string | format |
| UnknownTypeHandle | query | string | unknown type handle |
| MissParameterHandle | query | string | miss parameter handle |
| RowLimit | query | string | row limit |
Query dataset.
Responses
[200] Success
binary
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/data/datasets/{id}/query
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | dataset id |
Query dataset.
Request Body
Description: query request
Type: application/json
Responses
[200] Success
binary
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
Models
Ƭ DatasetPluginErrorV2
Dataset plugin error model
| Name | Type | Description |
|---|---|---|
| codeNullable | string | Error code |
| messageNullable | string | Error message |
| contextNullable | string | Error context |
| innerError | DatasetPluginErrorV2 | |
| extendedResultNullable | any | Extended result |
Ƭ DatasetExportModel
Represent a dataset export model.
| Name | Type | Description | Example |
|---|---|---|---|
| parametersRequired | Array<DatasetParameterItem> |
Get or set dataset export parameters. | |
| advancedSettingRequired | ExportAdvancedSetting | ||
| fileTypeNullable | string | Get or set dataset export file type. | "json" |
Ƭ DatasetParameterItem
Represent a dataset Parameter item.
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | Get or set dataset export parameter name. | "age" |
| valueNullable | Array |
Get or set dataset export parameter value. | [18,21] |
Ƭ ExportAdvancedSetting
Represent a dataset export advanced setting.
| Name | Type | Description | Example |
|---|---|---|---|
| encodingNullable | string | Get or set csv file encoding. | "utf-8" |
| noHeader | Boolean | Get or set whether csv file has header. | true |
| columnsDelimiterNullable | string | Get or set csv file columns delimiter. | "," |
| rowsDelimiterNullable | string | Get or set csv file rows delimiter. | ";" |
| formatted | Boolean | Get or set whether json file is formated. | true |
| quotePropertyNames | Boolean | Get or set json file quote property names. | true |
| limit | int32 | Get or set file limit size. | 100 |
Ƭ BatchRefreshDatasetTaskResultModel
Represent a result model of batch refresh task.
| Name | Type | Description |
|---|---|---|
| datasetIdNullable | string | Get or set dataset document id. |
| success | Boolean | Get or set result of batch refresh task. |
| errorCodeNullable | string | Get or set error code when the task fails. |
| errorMessageNullable | string | Get or set error message when the task fails. |
| taskIdNullable | string | Get or set batch refresh task id. |
Ƭ BatchRefreshDatasetRequestModel
Represent a batch refresh model.
| Name | Type | Description | Example |
|---|---|---|---|
| refreshDataSetIdsRequired | Array<string> |
Get or set refresh data set ids. | ["789ACE15-1C11-DFD0-312D-AA32EBA0AB67","51FC17FF-D490-42E1-D419-E7BBC83CCF53"] |
| cotSearchEntryInfosNullable | Array<SearchEntryInfo> |
Get or set COT search entry infos. |
Ƭ SearchEntryInfo
Represent a COT search entry info.
| Name | Type | Description | Example |
|---|---|---|---|
| tenantIdNullable | string | Get or set tenant id. | "D2DA4850-FBD0-7022-E471-E3AEDAA140E3" |
| datasetIdNullable | string | Get or set dataset id. | "E2DD8243-8CD3-39F7-8FAE-E23E6AE0ECF2" |
Ƭ DatasetDefinitionV2
| Name | Type | Description |
|---|---|---|
| parametersNullable | Array<QueryParameterViewModelV2> |
The parameter of dataset. |
| fieldsNullable | Array<FieldViewModelV2> |
The field of dataset. |
Ƭ QueryParameterViewModelV2
| Name | Type | Description | Example |
|---|---|---|---|
| nameRequired | string | The name of parameter. | "parameterName" |
| parameterTypeRequired | string | The type of parameter. Optional range: User Input, Constant, User Context, Organization Context. | "User Input" |
| parameterValueNullable | string | The value of parameter. If the ParameterType is User Context or Organization Context, the ParameterValue can not be empty, the value must come from User Context or Organization Context. | "email" |
| parameterDefaultValueNullable | string | The default value of parameter. If the ParameterType is User Input or Constant, the ParameterDefaultValue can not be empty. The ParameterDefaultValue must match the DataType. | "0" |
| dataTypeRequired | string | The data type of oarameter. Optional range: Integer, Float, String, DateTime, Date, Boolean, Guid | "String" |
| multivalueRequired | Boolean | Whether the parameter value is multivalue: true - parameter value is multivalue; false - parameter value is not multivalue. | false |
| isHiddenNullable | Boolean | Whether to hide the parameter. Currently, it only works for report. |
Ƭ FieldViewModelV2
| Name | Type | Description | Example |
|---|---|---|---|
| tableRequired | string | The table of this field. | "[dbo].[Products](6ec5c8c5-8948-464e-95d9-2ea22ca979f7)" |
| columnRequired | string | Field name. | "ProductID" |
| aliasNullable | string | Field alias. | "ProductIDAlias" |
| descriptionNullable | string | The description of this field. | "description" |
| dataTypeRequired | string | Data type of field. Optional range: Number, String, DateTime, Date, Boolean, Guid. | "String" |
| dataVizAIHintNullable | string | The data visualization artificial intelligence hint of this field. Optional range: None, Currency, ImageURL, ImageBinary, GeoLatitude, GeoLongitude, GeoCountry, GeoRegion, GeoProvince, GeoCity, GeoDistrict. | "GeoLatitude" |
| formatNullable | string | The format of field. Optional range: g, N, '\('0.00, 0.00 '€', '£'0.00, '¥'0.00, d, D, t, T, P, E.<br />g - General; N - Number; '\)'0.00 - Currency USD; 0.00 '€' - Currency EUR; '£'0.00 - Currency GBP; '¥'0.00 - Currency JPY; d - ShortDate; D - LongDate; t - ShortTime; T - LongTime; P - Percentage; E - Scientific. | "P" |
| fieldTypeRequired | string | Field type of field. Optional range: Normal, Category, Calculated, SqlExpression, Aggregation, GroupBy, GroupBySqlExpression, AggregationSqlExpression, measure, calculatedColumn. | "Normal" |
| aggregationNullable | string | The aggregation of this field. | "Sum" |
| rawTypeNullable | string | The row type of this field. If the FieldType is SqlExpression, the RawType is the result data type of sql expression. | "Int32" |
| msDescriptionNullable | string | The description in data source of this field. | "description" |
| clrTypeNullable | string | ||
| isContainTimeZoneNullable | Boolean | Whether contain time zone: true - contain time zone; false - not contain time zone. | false |
Ƭ EmptyDatasetResponseModel
Response of create empty dataset.
| Name | Type | Description |
|---|---|---|
| idNullable | string | The id of created empty dataset. |
Ƭ EmptyDatasetRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| nameRequired | string | Dataset name | |
| indexedRequired | Boolean | Whether the dataset is a cached dataset: true - the dataset is cached dataset; false - the dataset is direct dataset. | true |
Ƭ DatasetCachesResultModel
Represent a result model of getting dataset cache.
| Name | Type | Description |
|---|---|---|
| lastErrorDataNullable | string | Dataset cache last refresh error data. |
| datasetIdNullable | string | Dataset document id. |
| titleNullable | string | Dataset document title. |
| displayNameNullable | string | Dataset cache display name. |
| creatorNameNullable | string | Dataset document creator name. |
| tenantIdNullable | string | Tenant id. |
| rowCount | int64 | Dataset cache data row count. |
| operationNullable | string | Datset cache operation. |
| lastUpdatedNullable | ISO DateTime Sting | Dataset cache last update time. |
Ƭ DatasetCachesListResultModel
Represent a result model of getting dataset cache.
| Name | Type | Description |
|---|---|---|
| datasetQueryInfosNullable | Array<DatasetCacheListQueryInfo> |
Dataset query info list. |
| pagination | PaginationInfo |
Ƭ DatasetCacheListQueryInfo
Represent dataset query info list.
| Name | Type | Description |
|---|---|---|
| datasetIdNullable | string | Dataset document id. |
| titleNullable | string | Dataset document title. |
| displayNameNullable | string | Dataset cache display name. |
| creatorNameNullable | string | Dataset document creator name. |
| tenantIdNullable | string | Tenant id. |
| rowCount | int64 | Dataset cache data row count. |
| operationNullable | string | Datset cache operation. |
| lastUpdatedNullable | ISO DateTime Sting | Dataset cache last update time. |
| lastErrorDataNullable | string | Dataset cache last refresh error data. |
Ƭ PaginationInfo
Represent pagination info.
| Name | Type | Description |
|---|---|---|
| pageSize | int32 | Data count per page. |
| pageNumber | int32 | Current page number. |
| total | int32 | Total data count. |
Ƭ InsertPushDataModel
Add Push Dataset Data
| Name | Type | Description | Example |
|---|---|---|---|
| columnsRequired | Array<string> |
Push Dataset data columns | ["id","name"] |
| rowsRequired | Array<array> |
Push Dataset data rows | [[0,"Lisa"],[1,"Bob"]] |
| overwriteRequired | Boolean | Whether to fully overwrite the old data | true |
Ƭ ClearPushDataModel
Clear Push Dataset data
| Name | Type | Description | Example |
|---|---|---|---|
| columnNameNullable | string | Push Dataset data column name | "name" |
| valueNullable | any | Push Dataset data column value | "Lisa" |
| optionNullable | string | The option used for where clause. It supports >, <, = | "=" |
Ƭ InsertStreamingDataModel
Add Push Dataset Data
| Name | Type | Description | Example |
|---|---|---|---|
| columnsRequired | Array<string> |
Streaming Dataset data columns | ["id","name"] |
| rowsRequired | Array<array> |
Streaming Dataset data rows | [[0,"Lisa"],[1,"Bob"]] |
| overwriteRequired | Boolean | Whether to fully overwrite the old data | true |
Ƭ QueryDataSetRequestBody
Query data set request body
| Name | Type | Description |
|---|---|---|
| datasetParametersNullable | string | Datasource parameters |
| queryNullable | string | Query |
| queryTypeNullable | string | QueryType |
| formatNullable | string | Format |
| options | Options |
Ƭ Options
| Name | Type | Description |
|---|---|---|
| unknownTypeHandleNullable | string | Unknown type handle |
| missParameterHandleNullable | string | Miss parameter handle |
| rowLimitNullable | string | Row limit |