Documentation for the routes in Loadtest Portal API.
Support: support@apica.io
+1 (310) 776-7540
+46 (8) 400 273 27
Method | Route | Description |
---|---|---|
POST | /selfservicejobs/preset | Start a new self service job by a preset name. |
GET | /selfservicejobs/{selfServiceJobId} | Retrieve the status of a self service job by its ID. |
GET | /selfservicejobs/{selfServiceJobId}/summary | Retrieve a range of summary statistics of a completed job. |
GET | /selfservicejobs/filter?mostRecent={mostRecent} | Return the most recent load test jobs for the customer that the authenticated user belongs to. Only active jobs are returned. Jobs that have been deleted are ignored by the function. |
GET | /selfservicejobs/filter?fromUtc={fromUtc} | Returns the jobs that have been inserted after the specified from date. Only active jobs are returned. Jobs that have been deleted are ignored by the function. |
GET | /selfservicejobs/filter?fromUtc={fromUtc}&toUtc={toUtc} | Returns the jobs that have been inserted in the specified date interval. Only active jobs are returned. Jobs that have been deleted are ignored by the function. |
Method | Route | Description |
---|---|---|
GET | /selfservicepresets/{presetName} | Check the existence of a preset by its name |
GET | /selfservicepresets?presetName={presetName} | Check the existence of a preset by its name |
Method | Route | Description |
---|---|---|
POST | /selfservicefiles | Save a new self service file in the customer's repository. |
GET | /selfservicefiles | Get all self service files of a customer |
GET | /selfservicefiles?selfServiceFileId={selfServiceFileId} | Get a single self service file and its contents. |
GET | /selfservicefiles?selfServiceFileName={selfServiceFileName} | Check the existence of a self service file by name |
Method | Route | Description |
---|---|---|
GET | /selfservicefilegroups | Get the file groups and all files within each group |
GET | /scenariofilegroups | Get the file groups and all scenario files (.class or .zip) within each group |
Method | Route | Description |
---|---|---|
POST | /scenarios/conversion/selenium | Convert a selenium file to an executable load test file |
Method | Route | Description |
---|---|---|
POST | /serversideagents | Insert a new server side monitoring agent. |
Method | Route | Description |
---|---|---|
GET | /testresultdata/jobstatus/{jobId} | Returns the loadtest job status report |
GET | /testresultdata/{testResultId}/summary | Returns the loadtest result summary report |
GET | /testresultdata/{testResultId}/activeusers | Returns the loadtest result active users trend |
GET | /testresultdata/{testResultId}/pages/list | Returns the page list of loadtest result |
GET | /testresultdata/{testResultId}/page/{pageId}/data | Returns the page data of loadtest result |
GET | /testresultdata/{testResultId}/transactions/list | Returns the transaction list of loadtest result |
GET | /testresultdata/{testResultId}/transaction/{transactionId}/data | Returns data of test result transaction |
Method | Route | Description |
---|---|---|
GET | /scenario/status/{runId} | Returns the scenario run status report |
POST | /scenario/abort/{runId} | Tries to abort all scenario jobs |
POST | /scenario/run | Tries to run scenario |
GET | /scenario/result/{runId}/summary | Returns the scenario run summary |
GET | /scenario/result/{runId}/transactionmetrics | Returns the scenario run transaction metrics |
GET | /scenario/result/{runId}/pagemetrics | Returns the scenario run page metrics |
GET | /scenario/result/{runId}/httphits | Returns the scenario run http hits trend |
GET | /scenario/result/{runId}/activeusers | Returns the scenario run active users trend |