Knowledge Base Article

Creating Widget Via Rest API

Question: How can I find a reference to create a widget via Rest Api?
Solution: If you run a GET call on that endpoint (/dashboards/{dashboardId}/widgets), you can see how that property is stored in the JSON. Here's one example with the dim field:
Generally, it's [Schema.Table.Field], plus adding (Calendar) before the closing bracket for datetime fields (as in the above example).
Three other tips for your process:
1. Check out our JAQL API reference here.
2. Your best bet to learn this is to create a new dashboard with a single widget, export it to .dash, and view the .dash file in a text editor
3. You can use Postman to build and test API calls. Using the software, you can export your call to a language of your choice, including C#
Updated 02-09-2024
No CommentsBe the first to comment