Get aggregate collection data

get

https://{hostname}/concerto/services/rest/Results/v1/{resultId}/collection

Queries collection related metrics (such as pages or transactions) from a result with grouping/aggregation by location, time in seconds or minutes, network profile, element type, or element name. Use this to determine page load time or transactions per second (tps) or get the 90th percentile for a transaction.

Path Params

resultId

integer

required

Uniquely identifies each result.

Query Params

groupBy

string

enum

Defaults to elementType

Enum One or more groups to aggregate metrics by. Multiple groups are specified in two ways 1) groupBy=location&groupBy=elementType or 2) groupBy=location,elementType.

errorsOnly

boolean

Defaults to false

When enabled, returns only elements that had an error.

test-range-start

integer

Start of the range of element start times to query for. The range is specified as the number of seconds since the effective start of the test.

test-range-end

integer

End of the range of element start times to query for. The range is specified as the number of seconds since the effective end of the test.

annotation-start

string

Name of the annotation that defines the start of the range to query for. If a range type annotation then this may also specify the range end. The system generates Annotations automatically for ramping and the steady state phases of a test. It is also possible to create user created annotations.

annotation-end

string

Name of the annotation that defines the end of the range to query for.

location

string

Location filter. Specify multiple locations as follows location=Amazon%20EC2%20Mumbai&location=Amazon%20EC2%20US%20East.

networkProfile

string

NetworkProfile filter. Multiple profiles are specified as follows networkProfile=XXXX&networkProfile=YYYYY.

elementType

string

enum

Enum Element type filter, either clip, transaction, group, page, or burst.

Allowed:

includeFailed

boolean

Defaults to false

Determines whether to include collections that failed.

includeStopped

boolean

Defaults to false

Determines whether to include collections that stopped prior to normal completion.

percentile

array of integers

One or more percentile values to return. Defaults to 50th percentile. Multiple percentiles are specified as percentile=50&percentile=85.

percentile

Headers

X-Auth-Token

string

required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

Responses

400

Bad request. The URL or JSON request object is invalid.

401

Unauthorized. The security token is missing or invalid. See Get started for help initially running the API.

404

Not found. The requested object doesn't exist.

200Successful operation. Returns metrics aggregated by the specified groupings.