TraceTest (0.2.1)

Download OpenAPI specification:Download

OpenAPI definition for TraceTest endpoint and resources

api

Execute a definition

Request Body schema: text/json

	object (RunInformation)
content	string

Responses

Request samples

Payload

Content type

text/json

{"runInformation": {"metadata": {"property1": "string",
"property2": "string"
},
"environmentId": "string",
"variables": [{"key": "string",
"value": "string"
}
]
},
"content": "string"
}

Response samples

Content type

application/json

{"id": "string",
"runId": "string",
"type": "string",
"url": "string"
}

Upsert a definition

Request Body schema: text/json

	object (RunInformation)
content	string

Responses

Request samples

Payload

Content type

text/json

{"runInformation": {"metadata": {"property1": "string",
"property2": "string"
},
"environmentId": "string",
"variables": [{"key": "string",
"value": "string"
}
]
},
"content": "string"
}

Response samples

Content type

application/json

{"id": "string",
"type": "string"
}

Get transactions

get transactions

query Parameters

take	integer Default: 20 indicates how many transactions can be returned by each page
skip	integer Default: 0 indicates how many transactions will be skipped when paginating
query	string query to search transactions, based on transaction name and description
sortBy	string Enum: "created" "name" "last_run" indicates the sort field for the transactions
sortDirection	string Enum: "asc" "desc" indicates the sort direction for the transactions

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"steps": [{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}
]

Create new transaction

Request Body schema: application/json

name	string
description	string
version	integer version number of the test
	Array of objects (Test)
createdAt	string <date-time>
	object (TestSummary)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": 0,
"steps": [{"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": { }
}
],
"createdAt": "2019-08-24T14:15:22Z",
"summary": { }
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"steps": [{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}

get transaction

path Parameters

transactionId

required

string

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"steps": [{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}

update transaction

update transaction action

path Parameters

transactionId

required

string

Request Body schema: application/json

name	string
description	string
version	integer version number of the test
	Array of objects (Test)
createdAt	string <date-time>
	object (TestSummary)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": 0,
"steps": [{"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": { }
}
],
"createdAt": "2019-08-24T14:15:22Z",
"summary": { }
}

delete a transaction

path Parameters

transactionId

required

string

Responses

get a transaction specific version

path Parameters

transactionId required	string
version required	integer

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"steps": [{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}

Get the transaction definition as an YAML file

Get the transaction as an YAML file

path Parameters

transactionId required	string
version required	integer

Responses

run transaction

run a particular transaction

path Parameters

transactionId

required

string

Request Body schema: application/json

	object or null
environmentId	string
	Array of objects (EnvironmentValue)

Responses

Request samples

Payload

Content type

application/json

{"metadata": {"property1": "string",
"property2": "string"
},
"environmentId": "string",
"variables": [{"key": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"state": "CREATED",
"steps": [{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
],
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"metadata": {"property1": "string",
"property2": "string"
},
"pass": 0,
"fail": 0
}

Get all runs from a particular transaction

path Parameters

transactionId

required

string

query Parameters

take	integer Default: 20 indicates how many results can be returned by each page
skip	integer Default: 0 indicates how many results will be skipped when paginating

Responses

Response samples

Content type

application/json

[{"id": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"state": "CREATED",
"steps": [{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
],
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"metadata": {"property1": "string",
"property2": "string"
},
"pass": 0,
"fail": 0
}
]

Get a specific run from a particular transaction

path Parameters

transactionId required	string
runId required	integer

Responses

Response samples

Content type

application/json

{"id": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"state": "CREATED",
"steps": [{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
],
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"metadata": {"property1": "string",
"property2": "string"
},
"pass": 0,
"fail": 0
}

Delete a specific run from a particular transaction

path Parameters

transactionId required	string
runId required	integer

Responses

Get tests

get tests

query Parameters

take	integer Default: 20 indicates how many tests can be returned by each page
skip	integer Default: 0 indicates how many tests will be skipped when paginating
query	string query to search tests, based on test name and description
sortBy	string Enum: "created" "name" "last_run" indicates the sort field for the tests
sortDirection	string Enum: "asc" "desc" indicates the sort direction for the tests

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}
]

Create new test

Create new test action

Request Body schema: application/json

name	string
description	string
version	integer version number of the test
createdAt	string <date-time>
	object (Trigger)
	object (TestSpecs)
	Array of objects (TestOutput) define test outputs, in a key/value format. The value is processed as an expression
	object (TestSummary)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": { }
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}

get test

path Parameters

testId

required

string

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}

update test

update test action

path Parameters

testId

required

string

Request Body schema: application/json

name	string
description	string
version	integer version number of the test
createdAt	string <date-time>
	object (Trigger)
	object (TestSpecs)
	Array of objects (TestOutput) define test outputs, in a key/value format. The value is processed as an expression
	object (TestSummary)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": { }
}

delete a test

path Parameters

testId

required

string

Responses

run test

run a particular test

path Parameters

testId

required

string

Request Body schema: application/json

	object or null
environmentId	string
	Array of objects (EnvironmentValue)

Responses

Request samples

Payload

Content type

application/json

{"metadata": {"property1": "string",
"property2": "string"
},
"environmentId": "string",
"variables": [{"key": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}

get the runs for a test

get the runs from a particular test

path Parameters

testId

required

string

query Parameters

take	integer Default: 20 indicates how many results can be returned by each page
skip	integer Default: 0 indicates how many results will be skipped when paginating

Responses

Response samples

Content type

application/json

[{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
]

retrieve spans that will be selected by selector

get the spans ids that would be selected by a specific selector query

path Parameters

testId required	string
runId required	string

query Parameters

query

string

Responses

Response samples

Content type

application/json

{"selector": {"query": "string",
"structure": [{"filters": [{"property": "string",
"operator": "string",
"value": "string"
}
],
"pseudoClass": {"name": "string",
"argument": 0
},
"childSelector": { }
}
]
},
"spanIds": ["string"
]
}

run given assertions against the traces from the given run without persisting anything

use this method to test a definition against an actual trace without creating a new version or persisting anything

path Parameters

testId required	string
runId required	string

Request Body schema: application/json

Array of objects

Array

name	string or null
	object (Selector)
assertions	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
}

Response samples

Content type

application/json

{"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
}

rerun a test run

path Parameters

testId required	string
runId required	string

Responses

Response samples

Content type

application/json

{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}

get test run results in JUnit xml format

path Parameters

testId required	string
runId required	string

Responses

export test and test run information

export test and test run information for debugging

path Parameters

testId required	string
runId required	string

Responses

Response samples

Content type

application/json

{"test": {"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
},
"run": {"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
}

import test and test run information

import test and test run information for debugging

Request Body schema: application/json

required	object (Test)
required	object (TestRun)

Responses

Request samples

Payload

Content type

application/json

{"test": {"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": { }
},
"run": {"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
}

Response samples

Content type

application/json

{"test": {"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
},
"run": {"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}
}

get test Run

get a particular test Run

path Parameters

testId required	string
runId required	string

Responses

Response samples

Content type

application/json

{"id": "string",
"traceId": "string",
"spanId": "string",
"testVersion": 0,
"state": "CREATED",
"lastErrorState": "string",
"executionTime": 0,
"triggerTime": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceTriggeredAt": "2019-08-24T14:15:22Z",
"serviceTriggerCompletedAt": "2019-08-24T14:15:22Z",
"obtainedTraceAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"environment": {"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
},
"triggerResult": {"triggerType": "http",
"triggerResult": {"http": {"status": "string",
"statusCode": 0,
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"grpc": {"statusCode": 0,
"metadata": [{"key": "string",
"value": "string"
}
],
"body": "string"
},
"traceid": {"id": "string"
}
}
},
"trace": {"traceId": "string",
"tree": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"flat": {"property1": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
},
"property2": {"id": "string",
"parentId": "string",
"name": "string",
"startTime": 1656701595277,
"endTime": 1656701595800,
"attributes": {"span.name": "POST /create",
"tracetest.span.type": "http",
"tracetest.span.duration": "2000"
},
"children": [{ }
]
}
}
},
"result": {"allPassed": true,
"results": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"results": [{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
},
{"assertion": {"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
},
"allPassed": true,
"spanResults": [{"spanId": "123",
"observedValue": "test",
"passed": true
}
]
}
]
}
]
},
"outputs": [{"name": "string",
"spanId": "string",
"value": "string"
}
],
"metadata": {"property1": "string",
"property2": "string"
},
"transactionId": "string",
"transactionRunId": "string"
}

delete a test run

path Parameters

testId required	string
runId required	string

Responses

Get definition for a test

Gets definition for a test

path Parameters

testId

required

string

Responses

Response samples

Content type

application/json

[{"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
}
]

get a test specific version

path Parameters

testId required	string
version required	integer

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"serviceUnderTest": {"triggerType": "http",
"triggerSettings": {"http": {"url": "string",
"method": "GET",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"protobufFile": "string",
"address": "string",
"service": "string",
"method": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
},
"request": "string"
},
"traceid": {"id": "string"
}
}
},
"specs": {"specs": [{"selector": {"query": "span[tracetest.span.type=\"http\"]",
"structure": [{"filters": [{"property": "tracetest.span.type",
"operator": "=",
"value": "http"
}
]
}
]
},
"assertions": [{"attribute": "tracetest.span.duration",
"comparator": "<",
"expected": "2000"
},
{"attribute": "http.status_code",
"comparator": "=",
"expected": "200"
}
]
}
]
},
"outputs": [{"name": "USER_ID",
"selector": "span[name=\"user_signup\" result=\"success\"]",
"value": "attr:myapp.signup.user_id"
},
{"name": "PROFILE_URL",
"selector": "span[tracetest.span.type=\"general\" name=\"Tracetest trigger\"]",
"value": "${attr:tracetest.response.body | json_path '.user.profileUrl' }"
}
],
"summary": {"runs": 0,
"lastRun": {"time": "2019-08-24T14:15:22Z",
"passes": 0,
"fails": 0
}
}
}

Get the test definition as an YAML file

path Parameters

testId required	string
version required	integer

Responses

Get Environments

query Parameters

take	integer Default: 20 indicates how many environments can be returned by each page
skip	integer Default: 0 indicates how many environments will be skipped when paginating
query	string query to search environments, based on environments name and description
sortBy	string Enum: "created" "name" indicates the sort field for the environments
sortDirection	string Enum: "asc" "desc" indicates the sort direction for the environments

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
}
]

Create new environment

Create new environment action

Request Body schema: application/json

name	string
description	string
	Array of objects (EnvironmentValue)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
}

get environment

path Parameters

environmentId

required

string

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
}

update environment

update environment action

path Parameters

environmentId

required

string

Request Body schema: application/json

name	string
description	string
	Array of objects (EnvironmentValue)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"values": [{"key": "string",
"value": "string"
}
]
}

delete a environment

path Parameters

environmentId

required

string

Responses

Get the environment definition as an YAML file

Get the environment as an YAML file

path Parameters

environmentId

required

string

Responses

resolves an expression and returns the result string

Request Body schema: application/json

expression	string
	object (ResolveContext)

Responses

Request samples

Payload

Content type

application/json

{"expression": "string",
"context": {"testId": "string",
"runId": "string",
"spanId": "string",
"selector": "string",
"environmentId": "string"
}
}

Response samples

Content type

application/json

{"resolvedValues": ["string"
]
}

Get resources

get resources

query Parameters

take	integer Default: 20 indicates how many transactions can be returned by each page
skip	integer Default: 0 indicates how many transactions will be skipped when paginating
query	string query to search transactions, based on transaction name and description
sortBy	string Enum: "created" "name" "last_run" indicates the sort field for the transactions
sortDirection	string Enum: "asc" "desc" indicates the sort direction for the transactions

Responses

Response samples

Content type

application/json

[{"type": "string",
"item": null
}
]

Tests the config data store/exporter connection

Request Body schema: text/json

name required	string
type required	string (SupportedDataStores) Enum: "jaeger" "openSearch" "tempo" "signalFx" "otlp" "elasticApm" "newRelic" "lightstep" "datadog" "awsxray"
isDefault	boolean
	object (GRPCClientSettings)
	object (BaseClient)
	object (ElasticSearch)
	object (ElasticSearch)
	object (SignalFX)
	object (AwsXRay)
createdAt	string <date-time>

Responses

Request samples

Payload

Content type

text/json

{"name": "string",
"type": "jaeger",
"isDefault": true,
"jaeger": {"endpoint": "string",
"readBufferSize": 0,
"writeBufferSize": 0,
"waitForReady": true,
"headers": {"property1": "string",
"property2": "string"
},
"balancerName": "string",
"compression": "gzip",
"tls": {"insecure": true,
"insecureSkipVerify": true,
"serverName": "string",
"settings": {"cAFile": "string",
"certFile": "string",
"keyFile": "string",
"minVersion": "string",
"maxVersion": "string"
}
},
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"tempo": {"type": "http",
"http": {"url": "string",
"headers": {"property1": "string",
"property2": "string"
},
"tls": {"insecure": true,
"insecureSkipVerify": true,
"serverName": "string",
"settings": {"cAFile": "string",
"certFile": "string",
"keyFile": "string",
"minVersion": "string",
"maxVersion": "string"
}
},
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"endpoint": "string",
"readBufferSize": 0,
"writeBufferSize": 0,
"waitForReady": true,
"headers": {"property1": "string",
"property2": "string"
},
"balancerName": "string",
"compression": "gzip",
"tls": {"insecure": true,
"insecureSkipVerify": true,
"serverName": "string",
"settings": {"cAFile": "string",
"certFile": "string",
"keyFile": "string",
"minVersion": "string",
"maxVersion": "string"
}
},
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
}
},
"openSearch": {"addresses": ["string"
],
"username": "string",
"password": "string",
"index": "string",
"certificate": "string",
"insecureSkipVerify": true
},
"elasticApm": {"addresses": ["string"
],
"username": "string",
"password": "string",
"index": "string",
"certificate": "string",
"insecureSkipVerify": true
},
"signalFx": {"realm": "string",
"token": "string"
},
"awsxray": {"region": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"successful": true,
"steps": [{"portCheck": {"passed": true,
"status": "passed",
"message": "string",
"error": "string"
},
"connectivity": {"passed": true,
"status": "passed",
"message": "string",
"error": "string"
},
"authentication": {"passed": true,
"status": "passed",
"message": "string",
"error": "string"
},
"fetchTraces": {"passed": true,
"status": "passed",
"message": "string",
"error": "string"
}
}
]
}

Get all Data Stores

query Parameters

take	integer Default: 20 indicates how many data stores can be returned by each page
skip	integer Default: 0 indicates how many data stores will be skipped when paginating
query	string query to search data stores, based on data store name
sortBy	string Enum: "created" "name" indicates the sort field for the data stores
sortDirection	string Enum: "asc" "desc" indicates the sort direction for the data stores

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"type": "jaeger",
"isDefault": true,
"jaeger": {"endpoint": "string",
"readBufferSize": 0,
"writeBufferSize": 0,
"waitForReady": true,
"headers": {"property1": "string",
"property2": "string"
},
"balancerName": "string",
"compression": "gzip",
"tls": {"insecure": true,
"insecureSkipVerify": true,
"serverName": "string",
"settings": {"cAFile": "string",
"certFile": "string",
"keyFile": "string",
"minVersion": "string",
"maxVersion": "string"
}
},
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"tempo": {"type": "http",
"http": {"url": "string",
"headers": {"property1": "string",
"property2": "string"
},
"tls": {"insecure": true,
"insecureSkipVerify": true,
"serverName": "string",
"settings": {"cAFile": "string",
"certFile": "string",
"keyFile": "string",
"minVersion": "string",
"maxVersion": "string"
}
},
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
},
"grpc": {"endpoint": "string",
"readBufferSize": 0,
"writeBufferSize": 0,
"waitForReady": true,
"headers": {"property1": "string",
"property2": "string"
},
"balancerName": "string",
"compression": "gzip",
"tls": {"insecure": true,
"insecureSkipVerify": true,
"serverName": "string",
"settings": {"cAFile": "string",
"certFile": "string",
"keyFile": "string",
"minVersion": "string",
"maxVersion": "string"
}
},
"auth": {"type": "apiKey",
"apiKey": {"key": "string",
"value": "string",
"in": "query"
},
"basic": {"username": "string",
"password": "string"
},
"bearer": {"token": "string"
}
}
}
},
"openSearch": {"addresses": ["string"
],
"username": "string",
"password": "string",
"index": "string",
"certificate": "string",
"insecureSkipVerify": true
},
"elasticApm": {"addresses": ["string"
],
"username": "string",
"password": "string",
"index": "string",
"certificate": "string",
"insecureSkipVerify": true
},
"signalFx": {"realm": "string",
"token": "string"
},
"awsxray": {"region": "string",
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}
]

Create a new Data Store

Request Body schema: application/json

name required	string
type required	string (SupportedDataStores) Enum: "jaeger"