Glossary
This section covers the various terms that are used throughout the APIs discussed.
Account ID
This is the unique identifier of an account. It is used in the following APIs:
- Account Engine Utilization Report
- Account User List
- Add User to Account
- Create a Private Location
- Create a Workspace
- List Account Invitations
- List Private Locations
- List Schedule History
- List Schedules
- Projects List
- Terminate Masters in Account
- Update Account User
- Workspaces List
It is found through the BlazeMeter URL, using the following example:
https://a.blazemeter.com/app/#/accounts/{account ID}...
The number that comes after accounts
in the example above is the Account ID.
Collection ID
This is the unique identifier of a multi test. It is used in the following APIs:
- Add Tests to Multi-Test
- Create a Schedule
- Delete Data Files
- Delete a Multi-Test
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Edit Tests in Multi-Test
- List Data Files
- List Masters
- List Schedule History
- List Schedules
- Multi-Test Details
- Start a Multi-Test
- Update a Multi-Test
- Upload or Update Data Files
It is found in the response of the following APIs:
- Create a Multi-Test
- Create a Schedule
- List Masters
- List Multi-Tests
- Master Details
- Schedule Details
- Update Schedule
For another method for finding this value, visit this article.
concurrency
The Taurus Term used to describe the number of concurrent users to run the test with. It is used in the following APIs:
It is found in the response of the following APIs:
- Add Tests to Multi-Test
- Create a Workspace
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Duplicate a Test
- List Masters
- List Multi-Tests
- List Tests
- Master Details
- Multi-Test Details
- Start a Multi-Test
- Start a Test
- Summary Statistics
- Test Details
- Update a Master
- Update a Multi-Test
- Update a Test
- Upload or Update Asset Files
executor
The Taurus Term used to describe the execution type for a test (i.e. JMeter, Selenium, Gatling, etc.). It is used in the following APIs:
It is found in the response of the following APIs:
- Add Tests to Multi-Test
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Duplicate a Test
- List Masters
- List Multi-Tests
- List Tests
- Master Details
- Multi-Test Details
- Start a Multi-Test
- Start a Test
- Test Details
- Update a Master
- Update a Multi-Test
- Update a Test
- Upload or Update Asset Files
Folder ID
This is the unique identifier of the shared folder. It is used in the following APIs:
- Create a Test
- Delete Shared Folder File
- Delete a Shared Folder
- List Shared Folder Files
- Shared Folder Details
- Update a Shared Folder
- Update a Test
- Upload or Update Files to Shared Folder
It is found in the response of the following APIs:
- Create a Shared Folder
- Delete a Test in Multi-Test
- Edit Tests in Multi-Test
- Multi-Test Details
- List Multi-Tests
- List Shared Folders
- List Tests
- Test Details
- Update a Multi-Test
- Update a Test
Harbor ID
This is the unique identifier of the private location. It is used in the following APIs:
- Add a Workspace to Private Location
- Agent Details
- Delete a Private Location
- Delete a Workspace in Private Location
- Delete an Agent
- Generate Docker Command
- List Agents
- List Private Locations
- Private Location Details
- Private Location Image Versions
- Update a Private Location
- Update an Agent
It is found in the response of the following APIs:
For another method of finding this value, visit this article.
hold-for
The Taurus Term to describe the length of time the test will run at the full concurrency settings. It is used in the following APIs:
It is found in the response of the following APIs:
- Add Tests to Multi-Test
- Create a Workspace
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Duplicate a Test
- List Masters
- List Multi-Tests
- List Tests
- Master Details
- Multi-Test Details
- Start a Multi-Test
- Start a Test
- Summary Statistics
- Test Details
- Update a Master
- Update a Multi-Test
- Update a Test
- Upload or Update Asset Files
Label ID
This is the unique identifier of a label in a master
(or test report). It is used in the following APIs:
It is found in the response of the following APIs:
- Error Statistics
- List Masters
- Master Details
- Request Statistics
- Thresholds Statistics
- Update a Master
Location ID
This is the unique identifier for a cloud location or a private location. See the Performance Locations section for more details. It is used in the following APIs:
- Create a Test
- Edit Tests in Multi-Test
- Error Statistics
- List Masters
- Request Statistics
- Retrieve Logs
- Thresholds Statistics
- Time-Series Data
- Summary Statistics
- Update a Test
It is found in the response of the following APIs:
- Add Tests to Multi-Test
- Edit Tests in Multi-Test
- Master Details
- List Masters
- List Multi-Tests
- List Tests
- Start a Multi-Test
- Start a Test
- Track Status of a Test
- Update a Multi-Test
- Update a Test
- Upload or Update Asset Files
For another method for finding this value, visit this article.
Master ID
This is the unique identifier that identifies a test run. It is used in the following APIs:
- Add a Public Token
- Delete a Public Token
- Error Statistics
- Inject Custom Time Series Data
- Master Details
- Request Statistics
- Start a Multi-Test
- Start a Test
- Stop a Test Run
- Summary Statistics
- Thresholds Statistics
- Time-Series Data
- Track Status of a Test Run
- Update a Master
It is found in the response of the following APIs:
- List Masters
- List Schedule History
- Start a Multi-Test
- Start a Test
- Terminate Masters in Account
- Terminate Masters in Projects
- Terminate Masters in Workspace
For another method for finding this value, visit this article.
Profile ID
This is the unique identifier that identifies an APM integration.
Project ID
This is the unique identifier that identifies a given project. It is used in the following APIs:
- Add Tests to Multi-Test
- Create a Multi-Test
- Create a Test
- Delete a Project
- List Masters
- List Multi-Tests
- List Schedule History
- List Schedules
- List Tests
- List Schedule History
- Project Details
- Terminate Masters in Projects
- Update a Project
- Update a Test
It is found in the response of the following APIs:
- Create a Project
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Duplicate a Test
- Edit Tests in Multi-Test
- Master Details
- Multi-Test Details
- Projects List
- Start a Multi-Test
- Start a Test
- Test Details
- Update a Multi-Test
For another method for finding this value, visit Get the Project ID.
ramp-up
The Taurus Term to describe the time it takes to ramp up to the full concurrency set. It is used in the following APIs:
It is found in the response of the following APIs:
- Add Tests to Multi-Test
- Create a Workspace
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Duplicate a Test
- List Masters
- List Multi-Tests
- List Tests
- Master Details
- Multi-Test Details
- Start a Multi-Test
- Start a Test
- Summary Statistics
- Test Details
- Update a Master
- Update a Multi-Test
- Update a Test
- Upload or Update Asset Files
Scenario ID
This is the unique identifier that identifies a scenario in a test run. It is used in the following APIs:
It is found in the response of the following APIs:
For another method for finding this value, visit Get the Scenario ID.
Schedule ID
This is the unique identifier that identifies a scheduled test run. It is used in the following APIs:
It is found in the response of the following APIs:
Session ID
This is the unique identifier that identifies a session in a test run. It is used in the following APIs:
It is found in the response of the following APIs:
- List Masters
- Master Details
- Start a Multi-Test
- Start a Test
- Stop a Test
- Stop All Masters of a Test
- Terminate a Test
- Track Status of a Test
For another method for finding this value, visit this article.
Ship ID
This is the unique identifier of an agent within a private location. It is used in the following APIs:
- Agent Details
- Delete an Agent
- Generate Docker Command
- Private Location Image Versions
- Update an Agent
It is found in the response of the following APIs
For another method of finding this value, visit this article.
steps
The Taurus Term for describing the number of steps the rampup will use (i.e. setting this to 3 will make the ramp up increase 3 times during the ramp up period). It is used in the following APIs:
It is found in the response of the following APIs:
- Add Tests to Multi-Test
- Create a Workspace
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Duplicate a Test
- List Masters
- List Multi-Tests
- List Tests
- Master Details
- Multi-Test Details
- Start a Multi-Test
- Start a Test
- Summary Statistics
- Test Details
- Update a Master
- Update a Multi-Test
- Update a Test
- Upload or Update Asset Files
Tag ID
This is the unique identifier of a tag. It is used in the following APIs:
It is found in the response of the following APIs:
Test ID
This is the unique identifier that identifies a test. It is used in the following APIs:
- Add Tests to Multi-Test
- Create a Schedule
- Delete Asset File
- Delete a Test
- Duplicate a Test
- List Masters
- List Schedule History
- List Schedules
- List Test Files
- Start a Test
- Test Details
- Update a Test
- Upload or Update Asset Files
It is found in the response of the following APIs:
- Create a Test
- Delete a Test in Multi-Test
- Duplicate a Multi-Test
- Edit Tests in Multi-Test
- List Multi-Tests
- List Tests
- Master Details
- Multi-Test Details
- Start a Multi-Test
- Thresholds Statistics
- Update Schedule
- Update a Master
- Update a Multi-Test
For another method for finding this value, visit this article.
User ID
This is the unique identifier that identifies a user. It is used in the following APIs:
It is found in the response of the following APIs:
Workspace ID
This is the unique identifier that identifies a workspace. It is used in the following APIs:
- Active Masters in Workspace
- Add User to Account
- Add User to Workspace
- Add a Workspace to Private Location
- Create a Private Location
- Create a Project
- Create a Shared Folder
- Delete a Workspace in Private Location
- List Masters
- List Multi-Tests
- List Private Locations
- List Schedule History
- List Schedules
- List Shared Folders
- List Tests
- Projects List
- Terminate Masters in Workspace
- Update Workspace User
- Update a Project
- Workspace Details
- Workspace User List
It is found in the response of the following APIs:
- Account Engine Utilization Report
- Create a Workspace
- List Shared Folder Files
- Project Details
- Shared Folder Details
- Workspaces List
For another method for finding this value, visit Get the Project ID.