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
Reporting-Reports
Reporting-Reports
[POST] /api/v2/reporting/reports/{reportId}/export/{exportSettingsTemplateId}
Parameters
| Name | In | Type | Description | Default |
|---|---|---|---|---|
| reportIdRequired | path | string | Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e | |
| exportSettingsTemplateIdRequired | path | string | Export template id. For example: eb6d614f-e595-4de6-8c51-c54c6b07c295 | |
| download | query | boolean | Indicates whether the result should be returned as a downloadable file. | false |
Exports the report using export template.
Request Body
Description: Report export request model.
Type: application/json
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[403] Forbidden
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/reporting/reports/{reportId}/render-info
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| reportIdRequired | path | string | Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e |
Renders report info.
Request Body
Description: Report render info request model.
Type: application/json
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[403] Forbidden
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/reporting/reports/{reportId}/render-parameters-values
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| reportIdRequired | path | string | Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e |
Renders report parameters values.
Request Body
Description: Report render parameters values request model.
Type: application/json
ReportRenderParametersValuesRequest
Responses
[200] Success
ReportRenderParametersValuesResponse
Type: [application/json]
[400] Bad Request
Type: [application/json]
[403] Forbidden
Type: [application/json]
[404] Not Found
Type: [application/json]
[GET] /api/v2/reporting/reports/{reportId}/download
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| reportIdRequired | path | string | Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e |
Downloads the report.
Responses
[200] Success
binary
Type: [application/octet-stream]
[400] Bad Request
Type: [application/json]
[403] Forbidden
Type: [application/json]
[404] Not Found
Type: [application/json]
[GET] /api/v2/reporting/reports/{reportId}/embedded/download
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| reportIdRequired | path | string | Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e |
Downloads the report with embedded data.
Responses
[200] Success
binary
Type: [application/octet-stream]
[400] Bad Request
Type: [application/json]
[403] Forbidden
Type: [application/json]
[404] Not Found
Type: [application/json]
Models
Ƭ ReportExportResponse
Report export response model.
| Name | Type | Description |
|---|---|---|
| resultUrlNullable | string | Result URL. |
| resultIdNullable | string | Result id. |
| verificationUrlNullable | string | Verification URL. |
| renderingSkipped | Boolean | Whether the rendering was skipped. |
Ƭ ReportingPluginError
Reporting plugin error
| Name | Type | Description |
|---|---|---|
| codeNullable | string | error code |
| messageNullable | string | error message |
| contextNullable | string | error context |
Ƭ ReportExportRequest
Report export request model.
| Name | Type | Description | Default | Example |
|---|---|---|---|---|
| notificationSettingsNullable | Array<NotificationSettings> |
Notification settings. | ||
| settingsNullable | string | Settings for rendering extensions. | {"Title":"Overriden title"} |
|
| overrideExportTemplateSettings | Boolean | Whether to override export template settings. The default value is false. | false |
false |
| interactiveActionsNullable | Array<string> |
Interactive actions. | ["rpt1/TextBox10/4/toggle","rpt1/TextBox10/5/toggle"] |
|
| skipEmptyReport | Boolean | Skip rendering of empty reports. The default value is false. | false |
false |
| maxExecLimit | int32 | Internal. Max execution time. | 0 |
|
| parametersNullable | Array |
Specified parameter values. | {"StringParameter":["StringValue"],"Integer":[1],"Boolean":[false],"Date":["2000-01-01T00:00:00.000"]} |
|
| cacheRefreshIsRequired | Boolean | Refresh cached report. The default value is false. | false |
false |
| allowedClaimsNullable | string | List of allowed claims. | "full_name,phone_number" |
|
| userFunctionsNullable | any | List of User functions. | {"CSharp":"","VisualBasic":""} |
|
| timeZoneIdNullable | string | Identifier of a time zone used for exporting a report | "Asia/Tokyo" |
Ƭ NotificationSettings
Notification settings model.
| Name | Type | Description |
|---|---|---|
| channel | NotificationChannel | |
| onSuccessNullable | Array<string> |
List of contact names for notification of a successful operation. |
| onFailureNullable | Array<string> |
List of contact names for notification of an unsuccessful operation. |
Ƭ NotificationChannel
Enum:
API
Ƭ ReportRenderInfoResponse
Report render info response model.
| Name | Type | Description |
|---|---|---|
| isFPL | Boolean | Whether a Fixed Page Layout is used in the report. |
| isSemantic | Boolean | Whether the report has semantic data sets. |
| parametersNullable | Array<ParameterPayload> |
Report parameters list. |
| displayTypeNullable | string | Report display type. |
| sizeTypeNullable | string | Report size type. |
| nameNullable | string | Report name. |
| parametersViewNullable | string | Parameters view. |
| initialIdNullable | string | Initial id. |
| referencesNullable | Array<DocumentReference> |
Report references. |
| topParameterPanelHeightNullable | int32 | Top parameter panel height. |
| timeZoneIdNullable | string | Report Time Zone Id |
| metaNullable | string | Report meta information. |
Ƭ ParameterPayload
| Name | Type |
|---|---|
| nameNullable | string |
| promptNullable | string |
| dataTypeNullable | string |
| selectAllValueNullable | any |
| allowBlank | Boolean |
| nullable | Boolean |
| multiValue | Boolean |
| enableEmptyArray | Boolean |
| multiline | Boolean |
| hidden | Boolean |
| usedInQueryNullable | string |
| dependsOnNullable | Array<string> |
| dateOnly | Boolean |
| displayFormatNullable | string |
| validValues | ParameterValidValueCollection |
| defaultValue | ParameterDefaultValueCollection |
Ƭ DocumentReference
| Name | Type |
|---|---|
| resourceNameNullable | string |
| resourceDocTypeNullable | string |
| documentIdNullable | string |
| documentRev | int32 |
| contentUrlNullable | string |
Ƭ ParameterValidValueCollection
| Name | Type |
|---|---|
| dataSet | ParameterValidValueDatasetReference |
| valuesNullable | Array<ParameterValidValueDescriptor> |
Ƭ ParameterDefaultValueCollection
| Name | Type |
|---|---|
| dataSet | ParameterValidValueDatasetReference |
| valuesNullable | Array |
Ƭ ParameterValidValueDatasetReference
| Name | Type |
|---|---|
| dataSetNameNullable | string |
| labelFieldNullable | string |
| valueFieldNullable | string |
Ƭ ParameterValidValueDescriptor
| Name | Type |
|---|---|
| labelNullable | string |
| valueNullable | any |
Ƭ ReportRenderInfoRequest
Report render info request model.
| Name | Type | Description | Example |
|---|---|---|---|
| skipParameterValues | Boolean | Whether to skip processing parameter values. Default value is true. | true |
Ƭ ReportRenderParametersValuesRequest
Report render parameter values request model.
| Name | Type | Description | Example |
|---|---|---|---|
| valuesNullable | Array |
Specified parameter values. | {"BooleanParameter":[false],"StringMultiValueParameter":["value1","value2"]} |
| requestRequired | QueryFields | Names of the parameters we need to retrieve the values, validValues for. | {"Parameter1":null} |
| allowedClaimsNullable | string | List of allowed claims. | "full_name,phone_number" |