Info |
---|
For complete documentation regarding the ASM API, refer to the core documentation at https://api-wpm.apicasystem.com/v3/Help. Supporting documentation will be referenced within this section. |
The ASM API allows developers to collect performance data programmatically or manage their account from an external service.The Synthetic Monitoring API uses a RESTful JSON implementation that allows you programmatically get and set data in Synthetic Monitoring.
...
Parameter | Content | Example |
---|---|---|
| Authentication ticket from API tool. | |
...
API Usage Example
The following is an example of how you can use the API to trigger a check run, wait for the result and then get the result once it is available.
Get the latest check results based on check ID.
https://api-wpm.apicasystem.com/v3/Help/Route/GET-checks-checkId-results_mostrecent_detail_level\
Save
timestamp_utc
Trigger a check run based on check ID:
https://api-wpm.apicasystem.com/v3/Help/Route/POST-checks-checkId-job\
Get the latest result by continuously getting the latest result by the check-ID until
timestamp_utc
has been changed.
https://api-wpm.apicasystem.com/v3/Help/Route/GET-checks-checkId-results_mostrecent_detail_level=1\
Note: use detail_level=1
Get and save
identifier
You can now get the detailed result for the check based on
identifier
.
a. Browser:
https://api-wpm.apicasystem.com/v3/Help. Supporting documentation will be referenced within this section./Route/POST-checks-browser-checkId-results-urldata\
b. ProxySniffer/ZebraTester:
https://api-wpm.apicasystem.com/v3/Help/Route/POST-checks-proxysniffer-checkId-results-urldata\