Docs

Intelligent Data Insight

Visual Query

Visualization - Data Subscription Open API

Prerequisites

Before using the interfaces described in this document, make sure to understand the invocation methods. For details, see Invocation Method.

Retrieve subscription list

Used to retrieve the list of dashboard subscription configurations for which you have permission. Project administrators and system administrators can retrieve all subscriptions; dashboard administrators can retrieve all subscriptions for the dashboard; users with other permissions can retrieve subscriptions where they are the creator, recipient, or have permission based on their identity.

Request description

Request method: GET
Request description: {{domain}}/aeolus/api/open/v2/subscription/subscriptions

Request parameters

Parameter	Type	Required	Example value	Description
appId	int	Yes	1	Project ID. For how to obtain it, see How to Obtain Resource IDs
dashboardId	int	No	1	Dashboard ID. For how to obtain it, see How to Obtain Resource IDs
subscriber	string	No	"xiaoming"	The prefix of the recipient's email address, that is, the part before the `@` symbol in the email address. If the email address is `xiaoming@example.com`, then `subscriber` is `xiaoming`.
pageSize	int	No	20	The number of records per page. Default value: 20
pageNumber	int	No	1	Page number. Default value: 1

Response parameters

Parameter	Type	Example value	Description
data.pageNumber	int	20	Current page number
data.pageSize	int	1	Number of records displayed per page
data.results	array		Result list, containing specific subscription information
data.results.id	int	1000	Unique subscription ID
data.results.owner	string	“xiaoming”	Subscription owner
data.results.status	int	0	Subscription status: 0 - Active, 1 - Deleted, 2 - Paused
data.results.title	object		Subscription title information
data.results.title.offset	int	0	Date offset value, effective only when withDate is true
data.results.title.title	string	"datawind subscription"	Title name
data.results.title.withDate	boolean	true	Whether the title includes the date
data.results.content	object		Push content related settings
data.results.content.dashboardContentFormat	string	img	Dashboard push format, img: image, pdf: PDF file
data.results.content.dashboardContentVisible	boolean	true	Whether to display dashboard content
data.results.content.dashboardLinkVisible	boolean	true	Whether to display dashboard link
data.results.description	string	“description”	Description of the subscription
data.results.dashboard	object		Associated dashboard information
data.results.dashboard.id	int	144250	Dashboard ID, unique identifier of the dashboard
data.results.dashboard.name	string	"datawind dashboard"	Dashboard name
data.results.noticeType	int	0	Notification method for creation/modification, 0: push to recipients, 1: push to creator
data.results.pushTime	object		Push time related settings
data.results.pushTime.frequency	int	3	Push frequency, 0: daily, 3: weekly, 5: monthly
data.results.pushTime.offset	int	2	Dataset synchronization date offset, for example, 1 means the T-1 data partition. Effective only when untilDataReady is true
data.results.pushTime.time	array	["10:00"]	Push time list, format: HH:MM, for example: 10:00 means 10:00 AM
data.results.pushTime.timezone	string	“UTC-08:00”	Time zone, format: UTC-08:00
data.results.pushTime.untilDataReady	boolean	true	Whether to wait for dataset synchronization to complete before pushing
data.results.pushTime.weekdays	array	[1,2]	Push weekdays list, indicates which days of the week to push, [0,6] (Monday to Sunday)
data.results.pushType	string	lark	Push method, Feishu, Feishu group, email, email group, dingtalk, dingtalk group, webcom (WeCom), webex (webex)
data.results.subscribers	array		Recipient list
data.results.subscribers.agent	string	“agent”	The prefix of the permission reference person's email, that is, the part before the `@` symbol in the email. If the email is `agent@example.com`, then `subscriber` is `agent`. The permission reference person is the one whose permissions are used for the push content. For example, if a chart's corresponding dataset in the dashboard has row-level permissions set, selecting different permission reference persons may result in different data being generated and pushed.
data.results.subscribers.subscriber	string	”xiaoming“	The prefix of the recipient's email, that is, the part before the `@` symbol in the email. If the email is `xiaoming@example.com`, then `subscriber` is `xiaoming`.
data.results.urls	array		Related URL list
data.results.urls.title	string	"Dashboard sheet-01"	Title of the URL
data.results.urls.url	string	“https://www.example.com“	Specific URL address
data.results.remark	object		Remark related information
data.results.remark.content	string	"Subscription note"	Remark content
data.results.remark.manageLinkVisible	boolean	true	Whether to display the subscription management entry address in the push information
data.results.remark.screenshotTimeVisible	boolean	true	Whether to display the screenshot time in the push message
data.results.config	object		Subscription configuration information
data.results.config.autoRetry	boolean	false	Whether to retry automatically
data.results.config.autoSyncSheets	boolean	false	Whether the subscription scope automatically synchronizes dashboard configuration.
data.results.config.language	string	auto	Language, auto (automatic), zh_CN (Chinese), en_US (English)
data.results.config.manageUrl	string	““https://www.example.com“”	Subscription management link
data.results.config.noPushIfAbnormal	boolean	false	Whether to skip push if chart is abnormal
data.total	int	1	Total number of results

Response example

{
    "code":"aeolus/ok",
    "data":{
        "pageNumber":20,
        "pageSize":1,
        "results":[
            {
                "id":1000,
                "owner":"***********",
                "status":0,
                "title":{
                    "offset":1,
                    "title":"datawind订阅",
                    "withDate":true
                },
                "content":{
                    "dashboardContentFormat":"img",
                    "dashboardContentVisible":true,
                    "dashboardLinkVisible":false
                },
                "description":"description",
                "dashboard":{
                    "id":144250,
                    "name":"datawind仪表盘"
                },
                "noticeType":0,
                "pushTime":{
                    "frequency":3,
                    "offset":2,
                    "time":[
                        "10:00"
                    ],
                    "timezone":"UTC+08:00",
                    "untilDataReady":true,
                    "weekdays":[
                        1,
                        2
                    ]
                },
                "pushType":"lark",
                "subscribers":[
                    {
                        "agent":"***********",
                        "subscriber":"***********"
                    }
                ],
                "urls":[
                    {
                        "title":"仪表盘sheet-01",
                        "url":"仪表盘URL"
                    }
                ],
                "remark":{
                    "content":"订阅说明",
                    "manageLinkVisible":true,
                    "screenshotTimeVisible":true
                },
                "config":{
                    "autoRetry":false,
                    "autoSyncSheets":false,
                    "language":"auto",
                    "manageUrl":"订阅管理URL",
                    "noPushIfAbnormal":false
                }
            }
        ],
        "total":1
    },
    "msg":"成功"
}

Create subscription

Used to create a dashboard subscription configuration.

warning

Only subscriptions for dashboards with the corresponding permissions can be created.

Request description

Request method: POST
Request description: {{domain}} /aeolus/api/open/v2/subscription/subscriptions

Request parameters

Parameter	Type	Required	Example value	Description
config	object	No		Subscription configuration information
config.autoRetry	boolean	No	true	Whether to retry on failure. The default value is false.
config.autoSyncSheets	boolean	No	false	Whether to automatically synchronize the dashboard configuration for the subscription scope. The default value is true when urls is empty; otherwise, the default value is false. When autoSyncSheets is true, the urls parameter is ignored.
config.language	string	No	"auto"	Language. Optional values: auto (automatic), zh_CN (Chinese), en_US (English).
config.manageUrl	string	No	"“https://www.example.com“"	Subscription management link. If not provided, it is set to the DataWind project center subscription management page address.
config.noPushIfAbnormal	boolean	No	true	Whether to not push when the chart is abnormal. The default value is false.
content	object	Yes		Push content configuration
content.dashboardContentFormat	string	No	"img"	Dashboard push format. img: image, pdf: PDF file. The default value is img.
content.dashboardContentVisible	boolean	No	true	Whether to display dashboard content. The default value is true.
content.dashboardLinkVisible	boolean	No	true	Whether to display the dashboard link. The default value is true.
appId	int	Yes	1	Project ID. For the acquisition method, see How to Obtain Resource IDs
dashboardId	int	Yes	1	Dashboard ID, representing the subscribed dashboard ID. Effective when urls is empty or not provided, indicating subscription to all sheets of the dashboard. For the acquisition method, see How to Obtain Resource IDs
pushTime	object	Yes		Push time
pushTime.frequency	int	Yes	3	Push frequency. 0: daily, 3: weekly, 5: monthly.
pushTime.offset	int	No	2	Dataset synchronization date offset. For example, 1 means the T-1 data partition. Only effective when untilDataReady is true. The default value is 1.
pushTime.weekdays	array[int]	No	[1,2]	List of push weekdays, indicating which days of the week to push. Required and only effective when the push frequency is weekly. Optional values: [0,6] (Monday to Sunday).
pushTime.days	array[int]	No		List of push dates. Required and only effective when the push frequency is monthly. Optional values: [1,31].
pushTime.time	array[string]	Yes	["10:00"]	List of push times. Format: HH:MM. For example, 10:00 means 10:00 AM.
pushTime.timezone	string	Yes	"UTC-08:00"	Time zone. Format: UTC-08:00.
pushTime.untilDataReady	boolean	No	true	Whether to wait until dataset synchronization is complete before pushing. The default value is false.
pushType	string	Yes	"lark"	Push method. Optional values: Feishu (飞书), Feishu_group (飞书群), email (email), email_group (email group), dingtalk (钉钉), dingtalk_group (钉钉群), webcom (WeCom), webex (webex).
remark	object	No		Remark information
remark.content	string	No	"Subscription description"	Remark content
remark.manageLinkVisible	bool	No	true	Whether to display the subscription management link in the push message. The default value is true.
remark.screenshotTimeVisible	bool	No	true	Whether to display the screenshot time in the push message. The default value is true.
subscribers	array[object]	Yes		Recipient list
subscribers.agent	string	Yes	“agent”	The user whose permissions are used: the email prefix, that is, the part before the `@` symbol in the email address. If the email address is `agent@example.com`, then the `subscriber` is `agent`. The user whose permissions are used is the person whose permissions are applied to the push content. For example, when the dataset corresponding to a chart in the dashboard has row-level permissions configured, selecting different permission reference users may result in different data being generated and pushed.
subscribers.subscriber	string	Yes	”xiaoming“	The prefix of the recipient's email address, that is, the part before the `@` symbol in the email address. If the email address is `xiaoming@example.com`, then `subscriber` is `xiaoming`.
title	object	Yes		Title information
title.offset	int	No	0	Date offset value, effective when withDate is true. The default value is 0.
title.title	string	Yes	"DataWind Subscription"	Title name
title.withDate	bool	No	true	Whether the title includes the date. The default value is false.
urls	array[object]	Yes		List of subscribed sheets
urls.url	string	Yes	"“https://www.example.com“"	Subscription sheet address. For acquisition method, see Get subscription list.

Request example

{
    "config": {
        "autoRetry": true,
        "autoSyncSheets": false,
        "language": "auto",
        "manageUrl": "订阅管理URL",
        "noPushIfAbnormal": true
    },
    "content": {
        "dashboardContentFormat": "img",
        "dashboardContentVisible": true,
        "dashboardLinkVisible": false
    },
    "appId": 555371,
    "dashboardId": *******,
    "description": "description",
    "noticeType": 0,
    "pushTime": {
        "frequency": 3,
        "offset": 2,
        "weekdays": [
            1,
            2
        ],
        "time": [
            "10:00"
        ],
        "timezone": "UTC-08:00",
        "untilDataReady": true
    },
    "pushType": "lark",
    "remark": {
        "content": "",
        "manageLinkVisible": true,
        "screenshotTimeVisible": true
    },
    "subscribers": [
        {
            "agent": "***********",
            "subscriber": "***********"
        }
    ],
    "title": {
        "offset": 1,
        "title": "DataWind订阅",
        "withDate": true
    },
    "urls": [
        {
            "url": "仪表盘链接URL"
        }
    ]
}

Response parameters

Parameter	Type	Example value	Description
code	string	“aeolus/ok”	Return code. Refer to Error codes
data	object		Data content
data.subscriptionId	int	1000	Created subscription ID
msg	string	"Success"	Prompt message

Response example

{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 1000
    },
    "msg": "成功"
}

Update subscription

Used to modify an existing dashboard subscription.

warning

Only subscriptions for which you have permission can be modified. Project administrators and system administrators can modify any subscription. Dashboard administrators can modify subscriptions for the corresponding dashboard. Subscription owners can modify subscriptions they have created.

Request description

Request method: PATCH
Request description: {{domain}}/aeolus/api/open/v2/subscription/subscriptions

Request parameters

Parameter	Type	Required	Example value	Description
id	int	Yes	1000	Subscription ID. For acquisition method, see Get subscription list.
status	int	No	0	Status: 0 for normal, 2 for paused
config	object	No		Subscription configuration information
config.autoRetry	boolean	No	true	Whether to retry on failure. The default value is false.
config.autoSyncSheets	boolean	No	false	Whether the subscription scope automatically synchronizes dashboard configuration. The default value is true when urls is empty; otherwise, the default value is false. When autoSyncSheets is true, the urls parameter is ignored.
config.language	string	No	"auto"	Language. Optional values: auto (automatic), zh_CN (Chinese), en_US (English)
config.manageUrl	string	No	"“https://www.example.com“"	Subscription management link. If not provided, it is set to the DataWind project center subscription management page address.
config.noPushIfAbnormal	boolean	No	true	Whether to skip push when the chart is abnormal. The default value is false.
content	object	Yes		Push content configuration
content.dashboardContentFormat	string	No	"img"	Dashboard push format: img for image, pdf for PDF file. The default value is img.
content.dashboardContentVisible	boolean	No	true	Whether to display dashboard content. The default is true.
content.dashboardLinkVisible	boolean	No	true	Whether to display the dashboard link. The default value is true.
appId	int	Yes	1	Project ID. For acquisition method, see How to Obtain Resource IDs
dashboardId	int	Yes	1	Dashboard ID, indicating the subscribed dashboard ID. Effective when urls is empty or not provided, indicating subscription to all sheets of the dashboard. For acquisition method, see How to Obtain Resource IDs
description	string	No	“description”	Subscription description
noticeType	int	No	1	Notification method for creation/modification: 0 for pushing to recipient, 1 for pushing to creator
pushTime	object	Yes		Push time. Modifying individual fields of pushTime is not supported.
pushTime.frequency	int	Yes	3	Push frequency, 0: daily, 3: weekly, 5: monthly
pushTime.offset	int	No	2	Dataset synchronization date offset. For example, 1 indicates the T-1 data partition. Only effective when untilDataReady is true. The default value is 1.
pushTime.weekdays	array[int]	No	[1,2]	List of push weekdays, indicating which days of the week to push. Required and only effective when the push frequency is weekly. Optional values: [0,6] (Monday to Sunday).
pushTime.days	array[int]	No		List of push dates. Required and only effective when the push frequency is monthly. Optional values: [1,31]
pushTime.time	array[string]	Yes	["10:00"]	List of push times, format: HH:MM. For example, 10:00 means 10:00 AM.
pushTime.timezone	string	Yes	"UTC-08:00"	Time zone, format: UTC-08:00
pushTime.untilDataReady	boolean	No	true	Whether to wait for dataset synchronization to complete before pushing. The default value is false.
pushType	string	Yes	"lark"	Push method. Optional values: Feishu (飞书), lark_group (飞书群), email (邮件), email_group (邮件组), dingtalk (钉钉), dingtalk_group (钉钉群), webcom (企业微信), webex (webex)
remark	object	No		Remark information
remark.content	string	No	"Subscription description"	Remark content
remark.manageLinkVisible	bool	No	true	Whether to display the subscription management entry address in the push message. The default value is true.
remark.screenshotTimeVisible	bool	No	true	Whether to display the screenshot time in the push message. The default value is true.
subscribers	array[object]	Yes		Recipient list
subscribers.agent	string	Yes	“agent”	The prefix of the permission reference person's email address, that is, the part before the `@` symbol in the email address. If the email address is `agent@example.com`, then `subscriber` is `agent`. The permission reference person is whose permissions determine the content of the push. For example, if a chart's corresponding dataset in the dashboard has row-level permissions set, selecting different permission reference persons may result in different data being generated and pushed.
subscribers.subscriber	string	Yes	”xiaoming“	The prefix of the recipient's email address, that is, the part before the `@` symbol in the email address. If the email address is `xiaoming@example.com`, then `subscriber` is `xiaoming`.
title	object	Yes		Title information
title.offset	int	No	0	Date offset value. Only effective when withDate is true. The default value is 0.
title.title	string	Yes	"DataWind Subscription"	Title name
title.withDate	bool	No	true	Whether the title includes the date. The default value is false.
urls	array[object]	Yes		Subscription sheet list
urls.url	string	Yes	"“https://www.example.com“"	Subscription sheet address. For how to obtain, see Get subscription list

Request example

{
    "id": 1000,
    "status": 0,
    "config": {
        "autoRetry": true,
        "autoSyncSheets": false,
        "language": "auto",
        "manageUrl": "订阅管理URL",
        "noPushIfAbnormal": true
    },
    "content": {
        "dashboardContentFormat": "img",
        "dashboardContentVisible": true,
        "dashboardLinkVisible": false
    },
    "appId":{appId},
    "dashboardId": ******,
    "description": "description",
    "noticeType": 0,
    "pushTime": {
        "frequency": 3,
        "offset": 2,
        "weekdays": [
            1,
            2
        ],
        "time": [
            "10:00"
        ],
        "timezone": "UTC-08:00",
        "untilDataReady": true
    },
    "pushType": "lark",
    "remark": {
        "content": "",
        "manageLinkVisible": true,
        "screenshotTimeVisible": true
    },
    "subscribers": [
        {
            "agent": "***********",
            "subscriber": "***********"
        }
    ],
    "title": {
        "offset": 1,
        "title": "DataWind订阅",
        "withDate": true
    },
    "urls": [
        {
            "url": "仪表盘URL"
        }
    ]
}

Response parameters

Parameter	Type	Example value	Description
code	string	“aeolus/ok”	Return code. See Error codes
data	object		Data content
data.subscriptionId	int	1000	Created subscription ID
msg	string	"Success"	Prompt message

Response example

{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 1000
    },
    "msg": "成功"
}

Delete subscription

Used to batch delete dashboard subscriptions for which you have permission.

warning

Only subscriptions for which you have permission can be deleted. Project administrators and system administrators can delete any subscription. Dashboard administrators can delete subscriptions for the corresponding dashboard. Subscription owners can delete subscriptions they created.

Request description

Request method: DELETE
Request description: {{domain}} /aeolus/api/open/v2/subscription/subscriptions

Request parameters

Parameter	Type	Required	Example value	Description
appId	int	Required	1	Project ID. For how to obtain, see How to Obtain Resource IDs
subscriptions	array[int]	Required	「1000, 1002」	List of subscription IDs to be deleted. For how to obtain, see Get subscription list

Response parameters

Name	Type	Example value	Description
code	string	“aeolus/ok”	Return code. For reference, see Error codes
data	object		Data content
data.deletedSubscriptions	array[int]	「1000, 1002」	List of successfully deleted subscriptions
data.totalCount	int	1	Total number of deleted subscriptions
msg	string	"Success"	Prompt message

Response example

{
    "code": "aeolus/ok",
    "data": {
        "deletedSubscriptions": [
            10827
        ],
        "totalCount": 1
    },
    "msg": "成功"
}

Unsubscribe

Unsubscribe a specified user's subscription. You can also unsubscribe all subscriptions by dashboard ID or unsubscribe a specific subscription by subscription ID.

warning

Only subscriptions with edit or delete permissions can be unsubscribed.

Request description

Request method: DELETE
Request description: {{domain}} /aeolus/api/open/v2/subscription/unsubscribe

Request parameters

Parameter	Type	Required	Example value	Description
appId	int	Required	1	Project ID. For how to obtain, see How to Obtain Resource IDs
subscriptions	array[int]	Required	「1000, 1002」	List of subscription IDs to be unsubscribed. For how to obtain, see Get subscription list
subscriber	string	Required	”xiaoming“	The prefix of the recipient's email address, that is, the part before the `@` symbol in the email address. If the email address is `xiaoming@example.com`, then `subscriber` is `xiaoming`.
dashboardId	int	Optional	1	ID of the dashboard whose subscriptions are to be unsubscribed. All subscriptions of this dashboard will be unsubscribed. For how to obtain, see How to Obtain Resource IDs

Response parameters

Parameter	Type	Example	Description
code	string	“aeolus/ok”	Return code. For reference, see Error codes
data	object		Data content
totalCount	int	5	Number of deleted subscriptions
unsubscribedSubscriptions	array[int]	「1000, 1002」	List of successfully unsubscribed subscriptions
msg	string	"Success"	Prompt message

Response example

{
    "code": "aeolus/ok",
    "data": {
        "totalCount": 5,
        "unsubscribedSubscriptions": [
            10825
        ]
    },
    "msg": "成功"
}

Error codes

Error code	Error message	Note
aeolus/ok	Success	Request succeeded
aeolus/validation/validationFailed	API parameter validation failed. Parameters do not meet the validation rules.	Request parameter error
aeolus/user/unauthorized	User unauthorized	User does not have permission for the relevant resources (dashboard, subscription)

Last updated: 2026.07.06 17:03:29

Intelligent Data Insight

Request description #

Request parameters #

Response parameters #

Response example #

Request description #

Request parameters #

Request example #

Response parameters #

Response example #

Request description #

Request parameters #

Request example #

Response parameters #

Response example #

Request description #

Request parameters #

Response parameters #

Response example #

Request description #

Request parameters #

Response parameters #

Response example #

Error codes #

Request description

Request parameters

Response parameters

Response example

Request description

Request parameters

Request example

Response parameters

Response example

Request description

Request parameters

Request example

Response parameters

Response example

Request description

Request parameters

Response parameters

Response example

Request description

Request parameters

Response parameters

Response example

Error codes