topic Re: Create New Dashboards via API in Dynatrace API

Create New Dashboards via API

r_weber — Tue, 25 Jun 2024 11:49:42 GMT

I'm missing an API to create/share new Dashboards (non-classic).
Is this really missing or is it just not documented?

Dashboards are one of the most essential assets still. So I can't believe there is no API for that?

Re: Create New Dashboards via API

Dant3 — Tue, 25 Jun 2024 13:31:50 GMT

If I recall correctly the Dashboards are using the Document Service, so the share document are actually there.

I think an improvement in Dashboard API or Documentation actually worth it, since I cross with it when working with the Doc Service for another reason.

Re: Create New Dashboards via API

Julius_Loman — Wed, 26 Jun 2024 13:26:53 GMT

It's carefully hidden. But it's there as a document service.

@r_weber btw. it's also possible to use Monaco with it, just it's still hidden under a feature flag. Also if you run into strange HTTP codes such as 409, your documents are deleted but not permanently deleted. You need to delete them permanently or restore them

Re: Create New Dashboards via API

r_weber — Wed, 26 Jun 2024 11:34:49 GMT

Jesus! WHY???

Re: Create New Dashboards via API

zietho — Wed, 26 Jun 2024 17:08:56 GMT

Acknowledge that we can improve the visibility!

Where would you expect it to show up?
(it might seem like a naive question at this point, but I intentionally try not to bias here and ask an open-ended question).

Re: Create New Dashboards via API

Julius_Loman — Thu, 27 Jun 2024 06:30:18 GMT

@zietho first of all please add it to the docs.dynatrace.com in the API section. There is no single mention of the API URL in docs or developer.dynatrace.com.

Also please improve the API doc and include all response codes at least. I was desperately looking at response status codes and the API response did not have any text description either.

Re: Create New Dashboards via API

r_weber — Wed, 26 Jun 2024 18:24:49 GMT

I think developer.dynatrace.com is ok if someone wants to build apps with NodeJS/Typescript. But honestly that's not what I'd go to look for in the first place.
If I'm used to play/test with Postman or any custom code (python, ...) then I'd expect a swagger or proper API documentation (here) and please re-introduce the easily accessible swagger link directly from the new Dynatrace UI! 😉
And a plus: maybe even provide a postman collection and keep it up-to-date 😉

Re: Create New Dashboards via API

zietho — Wed, 26 Jun 2024 19:11:15 GMT

Thank you for the swift and thorough reply!

you can find the swagger under: https://[dturl]/platform/swagger-ui/index.html?urls.primaryName=Document Service
I already triggered the doc update internally.
Regarding the direct link, I will also forward that feedback

regards

Thomas

Re: Create New Dashboards via API

r_weber — Thu, 27 Jun 2024 07:45:51 GMT

Thanks Thomas!
That link is golden!

Re: Create New Dashboards via API

paolo_fumanelli — Wed, 29 Jan 2025 13:24:20 GMT

Hi @r_weber did you manage then to upload a dashboard via api? I'm stuck at binarizing the dashboard json in javascript, can you help? Thanks

Re: Create New Dashboards via API

andreas_kothmei — Thu, 30 Jan 2025 14:23:23 GMT

Hi @paolo_fumanelli, you can do something like this to create a Blob from your dashboard json (at least in TypeScript):

export function jsonToBlob(json: unknown): Blob { return new Blob([JSON.stringify(json)], { type: 'application/json' }); }

Re: Create New Dashboards via API

paolo_fumanelli — Fri, 31 Jan 2025 08:47:51 GMT

Thank you! It worked perfectly