API concepts

Here are some terms and concepts that will help you understand how to use this API:

  • Actions . Used to refer to HTTP messages, JavaScript, Delay, and database actions.

  • Burst. Anything in a burst container plays back multi-threaded. Because a burst plays asynchronously the order of operations is not guaranteed.

  • Cloud servers. A server created by a cloud provider, such as AWS, Azure, Google Compute Engine, etc.

  • Collections. A collection is a grouping of test elements such as HTTP messages, delays, scripts, and other collections. Collections have organizational use and have their own metrics. Examples of collections include transactions, pages, and bursts.

  • Compositions. A Test Composition is a multi-track interface where test clips can be placed at different times and tracks to create complex testing scenarios. This interface is similar to music and movie digital creation tools. Test Compositions are created by dragging and dropping Test Clips directly onto a timeline or in a sequence based on when they should execute.

  • Grids. A set of cloud servers. A grid can contain cloud servers from multiple providers and locations. They dictate how retries are performed.

  • Objects. A CloudTest repository object such as composition, grid, or user.

  • Results. The metrics gathered from a composition when it is played. Can be referred to as test results.

  • Results database. The database that contains test results.

  • Seed data. A set of data used to set property values in a composition.

  • Servers. The servers that make up the CloudTest infrastructure. Servers can have specific designations such as load generator, results database server, or main server.

  • Tasks. A task is a background process started by an API operation.

  • Tenant. A segregated area within a CloudTest environment. Objects exist within a tenant and tenants are generally not aware of each other. This means that if you are looking for an object, you have to look in the right tenant to find it.

  • Test environment. The main server and the primary results database server.

  • Token. Use a token to authenticate login credentials.

  • Collection data. Collection related metrics (pages, transactions, clips) from a result. Use Get aggregate collection data to get metrics such as page load time, transactions per second (tps), or specific percentile for a transaction.

  • Action data. Action related metrics (HTTP messages, database actions, etc.) from a result. Use Get aggregate action data to get metrics such as the number of HTTP 404 errors, the average response time, or the number of assets containing the largest number of bytes.