Links
Comment on page
🧩

Reporting API

For more details, please refer to the Reporting feature.
To use the Reporting API, it's necessary to generate an access token.
A comprehensive toolkit, with practical usage examples, is accessible on GitHub.
This toolkit comes pre-installed as a default component within the on-premises platform, located at /datasentinel/soft/datasentinel_toolkit.

Reports

post
https://<<platform-server>>/ds-api
/activity/session-history-report
Session History
post
https://<<platform-server>>/ds-api
/activity/top-queries-report
Top Queries
post
https://<<platform-server>>/ds-api
/activity/table-report
Top Tables
post
https://<<platform-server>>/ds-api
/activity/instance-report
Instance
post
https://<<platform-server>>/ds-api
/activity/server-report
Server
post
https://<<platform-server>>/ds-api
/activity/query-report
Query Details
post
https://<<platform-server>>/ds-api
/activity/data-size-report
Data Size
post
https://<<platform-server>>/ds-api
/activity/full-report
Full Report

Email Reports

To enable direct email transmission of reports, you should include the following parameters:
  • report_type: "email"
  • subject: [Optional] Default: "[Datasentinel] <<Report Type>> report"
    • The subject line for the email.
  • recipients: An array of email addresses.
    • You can specify multiple email addresses here.