Eggplant Web Performance Analyzer API Paths
The API paths and methods for working with Eggplant Web Performance Analyzer are listed in the following table. Use the links in the table to go to the pages for the individual URLs. The pages provide descriptions and examples for the URLs and methods.
Text shown in italic type in the table below and on the individual method pages indicates values that must be replaced with information from your environment.
| Title | Path | HTTP Method | Description |
|---|---|---|---|
| Jobs | |||
| Get All Jobs | /jobs | GET | Returns a list of all jobs in your account |
| Get One Job | /jobs/id | GET | Returns a single job object |
| Get Jobs from Related Job Templates | /jobs?jobTemplate=template_sref | GET | Returns an array of job objects |
| Test Runs | |||
| Get One Test Run | /testRuns/id | GET | Returns a test run object |
| Get All Test Runs for a Job | /testRuns?job=job_sref | GET | Returns an array of test run objects |
| Get Test Runs from Related Job Templates | /testRuns?jobTemplate=job_template_sref | GET | Returns an array of test run objects |
| Screenshots | |||
| Discovery | /capturedImages?testRun=test_run_sref | GET | Returns an array of objects detailing available images captures during a given test run |
| Get the Image | /images/hash | GET | |
| Objects | |||
| Get All Objects for a Test Run | /objects?testRun=test_run_sref | GET | Returns an array of objects |
| Get One Object | /objects/id | GET | Returns a single object |
| HTTP Headers | |||
| Get Headers | /headers?object=object_sref | GET | Returns request and response headers |
| Job Templates | |||
| Get All Job Templates | /jobTemplates | GET | Returns an array of job template objects |
| Get One Job Template | /jobTemplates/id | GET | Returns a single job template object |
| Discovery | |||
| Get Browser List | /browsers | GET | Returns details about the browsers in Eggplant Web Performance Analyzer |
| Get Network Speeds | /networkSpeeds | GET | Returns details about network speeds for various actions |
| Get Device Profiles | /deviceProfiles | GET | Returns details about devices simulated in Eggplant Web Performance Analyzer |
| Get Crawl Exclude Types | /crawlExcludes | GET | Returns the types of excludes that can be used in crawls |
| New Tests and Templates | |||
| Run a New Job | /jobs | POST | Returns the URI of the job that was created |
| Create a New Job Template | /jobTemplates | POST | Returns the sref of the job template that was created |
Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2022 Eggplant