topic Possible values of third-party synthetic API POST parameter called "testSetup" in Synthetic Monitoring

Possible values of third-party synthetic API POST parameter called "testSetup"

36Krazyfists — Thu, 18 Dec 2025 11:22:39 GMT

So, there's a parameter of the 3rdPartySyntheticMonitor object for the Third-party synthetic API called "testSetup". The description says that it is "The information on monitor setup, for example browser". I'm assuming that this field is used to enter in the monitor type, so BROWSER, HTTP, and the new MULTI_PROTOCOL type, but I'm not sure since there aren't any actual listings of what items are valid in here.

Third-party synthetic API - POST third-party monitors to Dynatrace - Dynatrace Docs

I don't see anywhere else to tell the Dynatrace API whether this is a simple HTTP synthetic, Browser Click-path, or maybe a TCP/ICMP/DNS synthetic.

Re: Third-party synthetic API POST parameter called "testSetup". What are the possible values?

HannahM — Tue, 29 Oct 2024 15:04:28 GMT

Third-party Synthetic monitors are a separate monitor type to Dynatrace Synthetic monitor types. If you are working with Dynatrace Synthetic monitors, such as Browser clickpath or ICMP you would not use the third-party API. The Third-party Synthetic API enables you to push third-party synthetic data to Dynatrace and to show it in the Synthetic page, along with also providing metrics and alerting for it.

Re: Third-party synthetic API POST parameter called "testSetup". What are the possible values?

36Krazyfists — Tue, 29 Oct 2024 17:01:53 GMT

Yes, I'm aware of the difference between a 3rd Party Synthetic Monitor and a Dynatrace Synthetic Monitor. That's the point of my question, when sending 3rd party monitors via the 3rdPartySynthetics API, the 3rdPartySyntheticMonitor object has a field called testSetup, but there's no documentation around what values that field is looking for.

Re: Third-party synthetic API POST parameter called "testSetup". What are the possible values?

HannahM — Tue, 29 Oct 2024 17:29:19 GMT

It can be anything you like. The limitation is that it is a string and <=100 characters.

Re: Third-party synthetic API POST parameter called "testSetup". What are the possible values?

36Krazyfists — Tue, 29 Oct 2024 20:05:11 GMT

So you're saying it's just a free-form field that I can put anything I want in? It doesn't have a specific purpose?

Re: Third-party synthetic API POST parameter called "testSetup". What are the possible values?

HannahM — Wed, 30 Oct 2024 15:18:42 GMT

Yes, it's for you to add extra info regarding the test setup. That's why it's optional. There are no set values or recommendations.

Re: Third-party synthetic API POST parameter called "testSetup". What are the possible values?

36Krazyfists — Wed, 30 Oct 2024 17:46:43 GMT

Perfect, that's the info I was looking for. Thanks!