TraceTest (0.2.1)
Download OpenAPI specification:Download
OpenAPI definition for TraceTest endpoint and resources
Get testsuites
get testsuites
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
query | string query to search resources |
sortBy | string Enum: "created" "name" "last_run" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "TestSuite",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "url": "string",
- "method": "GET",
- "headers": [
- {
- "key": null,
- "value": null
}
], - "body": "string",
- "auth": {
- "type": "apiKey",
- "apiKey": {
- "key": null,
- "value": null,
- "in": null
}, - "basic": {
- "username": null,
- "password": null
}, - "bearer": {
- "token": null
}
}, - "sslVerification": false
}, - "grpc": {
- "protobufFile": "string",
- "address": "string",
- "service": "string",
- "method": "string",
- "metadata": [
- {
- "key": null,
- "value": null
}
], - "auth": {
- "type": "apiKey",
- "apiKey": {
- "key": null,
- "value": null,
- "in": null
}, - "basic": {
- "username": null,
- "password": null
}, - "bearer": {
- "token": null
}
}, - "request": "string"
}, - "traceid": {
- "id": "string"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": null,
- "password": null
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": null,
- "value": null
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- null
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "summary": {
- "runs": 0,
- "lastRun": {
- "time": "2019-08-24T14:15:22Z",
- "passes": 0,
- "fails": 0,
- "analyzerScore": 0
}
}
}
}
]
}
Create new TestSuite
Create new TestSuite
Request Body schema:
type | string Value: "TestSuite" Represents the type of this resource. It should always be set as 'TestSuite'. |
object (TestSuite) |
Responses
Request samples
- Payload
{- "type": "TestSuite",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- null
], - "pseudoClass": {
- "name": null,
- "argument": null
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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
- 201
{- "type": "TestSuite",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- null
], - "pseudoClass": {
- "name": null,
- "argument": null
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "summary": {
- "runs": 0,
- "lastRun": {
- "time": "2019-08-24T14:15:22Z",
- "passes": 0,
- "fails": 0,
- "analyzerScore": 0
}
}
}
}
Response samples
- 200
{- "type": "TestSuite",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- null
], - "pseudoClass": {
- "name": null,
- "argument": null
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "summary": {
- "runs": 0,
- "lastRun": {
- "time": "2019-08-24T14:15:22Z",
- "passes": 0,
- "fails": 0,
- "analyzerScore": 0
}
}
}
}
update TestSuite
update TestSuite action
path Parameters
testSuiteId required | string id of the TestSuite |
Request Body schema:
type | string Value: "TestSuite" Represents the type of this resource. It should always be set as 'TestSuite'. |
object (TestSuite) |
Responses
Request samples
- Payload
{- "type": "TestSuite",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- null
], - "pseudoClass": {
- "name": null,
- "argument": null
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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
- 200
{- "type": "TestSuite",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- null
], - "pseudoClass": {
- "name": null,
- "argument": null
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "summary": {
- "runs": 0,
- "lastRun": {
- "time": "2019-08-24T14:15:22Z",
- "passes": 0,
- "fails": 0,
- "analyzerScore": 0
}
}
}
}
Get tests
get tests
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
query | string query to search resources |
sortBy | string Enum: "created" "name" "last_run" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "Test",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- null
], - "pseudoClass": {
- "name": null,
- "argument": null
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 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) | |
skipTraceCollection | boolean If true, the test will not collect a trace |
Array of objects (TestSpec) specification of assertions that are going to be made | |
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
{- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- {
- "property": "string",
- "operator": "string",
- "value": "string"
}
], - "pseudoClass": {
- "name": "string",
- "argument": 0
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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
- 200
{- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- {
- "property": "string",
- "operator": "string",
- "value": "string"
}
], - "pseudoClass": {
- "name": "string",
- "argument": 0
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
Response samples
- 200
{- "type": "Test",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- {
- "property": "string",
- "operator": "string",
- "value": "string"
}
], - "pseudoClass": {
- "name": "string",
- "argument": 0
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
}
update test
update test action
path Parameters
testId required | string id of the test |
Request Body schema: application/json
name | string |
description | string |
version | integer version number of the test |
createdAt | string <date-time> |
object (Trigger) | |
skipTraceCollection | boolean If true, the test will not collect a trace |
Array of objects (TestSpec) specification of assertions that are going to be made | |
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
{- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- {
- "property": "string",
- "operator": "string",
- "value": "string"
}
], - "pseudoClass": {
- "name": "string",
- "argument": 0
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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": { }
}
List Tracetest configuration
List Tracetest configuration
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
sortBy | string Enum: "type" "enabled" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "Config",
- "spec": {
- "id": "current",
- "name": "Config",
- "analyticsEnabled": true
}
}
]
}
Get Tracetest configuration
Get Tracetest configuration
path Parameters
configId required | string ID of the configuration resource used on Tracetest. It should be set as 'current' |
Responses
Response samples
- 200
{- "type": "Config",
- "spec": {
- "id": "current",
- "name": "Config",
- "analyticsEnabled": true
}
}
Update Tracetest configuration
Update Tracetest configuration
path Parameters
configId required | string ID of the configuration resource used on Tracetest. It should be set as 'current' |
Request Body schema:
type | string Value: "Config" Represents the type of this resource. It should always be set as 'Config'. |
object Represents the set of configuration common options for Tracetest. |
Responses
Request samples
- Payload
{- "type": "Config",
- "spec": {
- "id": "current",
- "name": "Config",
- "analyticsEnabled": true
}
}
Response samples
- 200
{- "type": "Config",
- "spec": {
- "id": "current",
- "name": "Config",
- "analyticsEnabled": true
}
}
List Polling Profile Configuration
List Polling Profile configuration
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
sortBy | string Enum: "type" "enabled" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "PollingProfile",
- "spec": {
- "id": "string",
- "name": "string",
- "default": true,
- "strategy": "periodic",
- "periodic": {
- "retryDelay": "string",
- "timeout": "string"
}
}
}
]
}
Get Polling Profile
Get a polling profile used on Tracetest to configure how to fetch traces in a test.
path Parameters
pollingProfileId required | string ID of a polling profile used on Tracetest to configure how to fetch traces in a test. It should be set as 'current' |
Responses
Response samples
- 200
{- "type": "PollingProfile",
- "spec": {
- "id": "string",
- "name": "string",
- "default": true,
- "strategy": "periodic",
- "periodic": {
- "retryDelay": "string",
- "timeout": "string"
}
}
}
Update a Polling Profile
Update a polling profile used on Tracetest to configure how to fetch traces in a test.
path Parameters
pollingProfileId required | string ID of a polling profile used on Tracetest to configure how to fetch traces in a test. It should be set as 'current' |
Request Body schema:
type | string Value: "PollingProfile" Represents the type of this resource. It should always be set as 'PollingProfile'. |
object Represents the attributes of a Polling Profile. |
Responses
Request samples
- Payload
{- "type": "PollingProfile",
- "spec": {
- "id": "string",
- "name": "string",
- "default": true,
- "strategy": "periodic",
- "periodic": {
- "retryDelay": "string",
- "timeout": "string"
}
}
}
Response samples
- 200
{- "type": "PollingProfile",
- "spec": {
- "id": "string",
- "name": "string",
- "default": true,
- "strategy": "periodic",
- "periodic": {
- "retryDelay": "string",
- "timeout": "string"
}
}
}
List Demonstrations
List demonstrations used on Tracetest as quick start examples.
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
sortBy | string Enum: "type" "enabled" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "Demo",
- "spec": {
- "id": "string",
- "type": "otelstore",
- "name": "string",
- "enabled": true,
- "pokeshop": {
- "httpEndpoint": "string",
- "grpcEndpoint": "string",
- "kafkaBroker": "string"
}, - "opentelemetryStore": {
- "frontendEndpoint": "string",
- "productCatalogEndpoint": "string",
- "cartEndpoint": "string",
- "checkoutEndpoint": "string"
}
}
}
]
}
Create a Demonstration setting
Create a demonstration used on Tracetest as quick start examples.
Request Body schema:
type | string Value: "Demo" Represents the type of this resource. It should always be set as 'Demo'. |
object Represents the attributes of a Demonstration API. |
Responses
Request samples
- Payload
{- "type": "Demo",
- "spec": {
- "id": "string",
- "type": "otelstore",
- "name": "string",
- "enabled": true,
- "pokeshop": {
- "httpEndpoint": "string",
- "grpcEndpoint": "string",
- "kafkaBroker": "string"
}, - "opentelemetryStore": {
- "frontendEndpoint": "string",
- "productCatalogEndpoint": "string",
- "cartEndpoint": "string",
- "checkoutEndpoint": "string"
}
}
}
Response samples
- 201
{- "type": "Demo",
- "spec": {
- "id": "string",
- "type": "otelstore",
- "name": "string",
- "enabled": true,
- "pokeshop": {
- "httpEndpoint": "string",
- "grpcEndpoint": "string",
- "kafkaBroker": "string"
}, - "opentelemetryStore": {
- "frontendEndpoint": "string",
- "productCatalogEndpoint": "string",
- "cartEndpoint": "string",
- "checkoutEndpoint": "string"
}
}
}
Get Demonstration setting
Get a demonstration used on Tracetest as quick start examples.
path Parameters
demoId required | string ID of a demonstration used on Tracetest as quick start examples |
Responses
Response samples
- 200
{- "type": "Demo",
- "spec": {
- "id": "string",
- "type": "otelstore",
- "name": "string",
- "enabled": true,
- "pokeshop": {
- "httpEndpoint": "string",
- "grpcEndpoint": "string",
- "kafkaBroker": "string"
}, - "opentelemetryStore": {
- "frontendEndpoint": "string",
- "productCatalogEndpoint": "string",
- "cartEndpoint": "string",
- "checkoutEndpoint": "string"
}
}
}
Update a Demonstration setting
Update a demonstration used on Tracetest as quick start examples.
path Parameters
demoId required | string ID of a demonstration used on Tracetest as quick start examples |
Request Body schema:
type | string Value: "Demo" Represents the type of this resource. It should always be set as 'Demo'. |
object Represents the attributes of a Demonstration API. |
Responses
Request samples
- Payload
{- "type": "Demo",
- "spec": {
- "id": "string",
- "type": "otelstore",
- "name": "string",
- "enabled": true,
- "pokeshop": {
- "httpEndpoint": "string",
- "grpcEndpoint": "string",
- "kafkaBroker": "string"
}, - "opentelemetryStore": {
- "frontendEndpoint": "string",
- "productCatalogEndpoint": "string",
- "cartEndpoint": "string",
- "checkoutEndpoint": "string"
}
}
}
Response samples
- 200
{- "type": "Demo",
- "spec": {
- "id": "string",
- "type": "otelstore",
- "name": "string",
- "enabled": true,
- "pokeshop": {
- "httpEndpoint": "string",
- "grpcEndpoint": "string",
- "kafkaBroker": "string"
}, - "opentelemetryStore": {
- "frontendEndpoint": "string",
- "productCatalogEndpoint": "string",
- "cartEndpoint": "string",
- "checkoutEndpoint": "string"
}
}
}
List Data Store
List Data Store
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
sortBy | string Enum: "type" "enabled" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "DataStore",
- "spec": {
- "id": "string",
- "name": "string",
- "type": "agent",
- "default": 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",
- "useDefaultAuth": true
}, - "azureappinsights": {
- "useAzureActiveDirectoryAuth": true,
- "accessToken": "string",
- "connectionType": "direct",
- "resourceArmId": "string"
}, - "createdAt": "2019-08-24T14:15:22Z"
}
}
]
}
Get a Data Store
Get a Data Store
path Parameters
dataStoreId required | string ID of a datastore used on Tracetest to configure how to fetch traces in a test |
Responses
Response samples
- 200
{- "type": "DataStore",
- "spec": {
- "id": "string",
- "name": "string",
- "type": "agent",
- "default": 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",
- "useDefaultAuth": true
}, - "azureappinsights": {
- "useAzureActiveDirectoryAuth": true,
- "accessToken": "string",
- "connectionType": "direct",
- "resourceArmId": "string"
}, - "createdAt": "2019-08-24T14:15:22Z"
}
}
Update a Data Store
Update a Data Store
path Parameters
dataStoreId required | string ID of a datastore used on Tracetest to configure how to fetch traces in a test |
Request Body schema: application/json
name required | string |
type required | string (SupportedDataStores) Enum: "agent" "jaeger" "opensearch" "tempo" "signalfx" "otlp" "elasticapm" "newrelic" "lightstep" "datadog" "awsxray" "honeycomb" "azureappinsights" "signoz" "dynatrace" |
default | boolean |
object (GRPCClientSettings) | |
object (BaseClient) | |
object (ElasticSearch) | |
object (ElasticSearch) | |
object (SignalFX) | |
object (AwsXRay) | |
object (AzureAppInsights) | |
createdAt | string <date-time> |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "agent",
- "default": 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",
- "useDefaultAuth": true
}, - "azureappinsights": {
- "useAzureActiveDirectoryAuth": true,
- "accessToken": "string",
- "connectionType": "direct",
- "resourceArmId": "string"
}, - "createdAt": "2019-08-24T14:15:22Z"
}
List VariableSets
List VariableSets available in Tracetest.
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
sortBy | string Enum: "type" "enabled" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "count": 0,
- "items": [
- {
- "type": "VariableSet",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}
}
]
}
Create a VariableSet
Create a VariableSet that can be used by tests and test suites
Request Body schema:
type | string Value: "VariableSet" Represents the type of this resource. It should always be set as 'VariableSet'. |
object (VariableSet) |
Responses
Request samples
- Payload
{- "type": "VariableSet",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}
}
Response samples
- 201
{- "type": "VariableSet",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}
}
Get a specific VariableSet
Get one VariableSet by its id
path Parameters
variableSetId required | string ID of a VariableSet used on Tracetest to inject values into tests and TestSuites |
Responses
Response samples
- 200
{- "type": "VariableSet",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}
}
Update a VariableSet
Update a VariableSet used on Tracetest
path Parameters
variableSetId required | string ID of a VariableSet used on Tracetest to inject values into tests and TestSuites |
Request Body schema:
type | string Value: "VariableSet" Represents the type of this resource. It should always be set as 'VariableSet'. |
object (VariableSet) |
Responses
Request samples
- Payload
{- "type": "VariableSet",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}
}
Response samples
- 200
{- "type": "VariableSet",
- "spec": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}
}
List Linters
List Linters available in Tracetest.
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
sortBy | string Enum: "type" "enabled" indicates the sort field for the resources |
sortDirection | string Enum: "asc" "desc" indicates the sort direction for the resources |
Responses
Response samples
- 200
{- "items": [
- {
- "type": "Linter",
- "spec": {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimumScore": 0,
- "plugins": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "enabled": true,
- "rules": [
- {
- "id": "string",
- "weight": 0,
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "tips": [
- "string"
], - "errorLevel": "error"
}
]
}
]
}
}
]
}
Create an Linter
Create an Linter that can be used by tests and Linters
Request Body schema:
type | string Value: "Linter" |
object |
Responses
Request samples
- Payload
{- "type": "Linter",
- "spec": {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimumScore": 0,
- "plugins": [
- {
- "id": "string",
- "enabled": true,
- "rules": [
- {
- "id": "string",
- "weight": 0,
- "errorLevel": "error"
}
]
}
]
}
}
Response samples
- 201
{- "type": "Linter",
- "spec": {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimumScore": 0,
- "plugins": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "enabled": true,
- "rules": [
- {
- "id": "string",
- "weight": 0,
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "tips": [
- "string"
], - "errorLevel": "error"
}
]
}
]
}
}
Get a specific Linter
Get one Linter by its id
path Parameters
LinterId required | string ID of an Linter |
Responses
Response samples
- 200
{- "type": "Linter",
- "spec": {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimumScore": 0,
- "plugins": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "enabled": true,
- "rules": [
- {
- "id": "string",
- "weight": 0,
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "tips": [
- "string"
], - "errorLevel": "error"
}
]
}
]
}
}
Update a Linter
Update a Linter used on Tracetest
path Parameters
LinterId required | string ID of an Linter |
Request Body schema:
type | string Value: "Linter" |
object |
Responses
Request samples
- Payload
{- "type": "Linter",
- "spec": {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimumScore": 0,
- "plugins": [
- {
- "id": "string",
- "enabled": true,
- "rules": [
- {
- "id": "string",
- "weight": 0,
- "errorLevel": "error"
}
]
}
]
}
}
Response samples
- 200
{- "type": "Linter",
- "spec": {
- "id": "string",
- "name": "string",
- "enabled": true,
- "minimumScore": 0,
- "plugins": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "enabled": true,
- "rules": [
- {
- "id": "string",
- "weight": 0,
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "tips": [
- "string"
], - "errorLevel": "error"
}
]
}
]
}
}
get a TestSuite specific version
get a TestSuite specific version
path Parameters
testSuiteId required | string id of the TestSuite |
version required | integer version of the test |
Responses
Response samples
- 200
{- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "steps": [
- "string"
], - "fullSteps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "trigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "skipTraceCollection": true,
- "specs": [
- {
- "name": "string",
- "selector": "string",
- "selectorParsed": {
- "query": "string",
- "structure": [
- {
- "filters": [
- {
- "property": null,
- "operator": null,
- "value": null
}
], - "pseudoClass": {
- "name": "string",
- "argument": 0
}, - "childSelector": { }
}
]
}, - "assertions": [
- "string"
]
}
], - "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,
- "analyzerScore": 0
}
}
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "summary": {
- "runs": 0,
- "lastRun": {
- "time": "2019-08-24T14:15:22Z",
- "passes": 0,
- "fails": 0,
- "analyzerScore": 0
}
}
}
run TestSuite
run a particular TestSuite
path Parameters
testSuiteId required | string id of the TestSuite |
Request Body schema: application/json
object or null | |
variableSetId | string |
Array of objects (VariableSetValue) | |
requiredGates | Array of strings or null (SupportedGates) Enum: "analyzer-score" "analyzer-rules" "test-specs" |
Responses
Request samples
- Payload
{- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "variableSetId": "string",
- "variables": [
- {
- "key": "string",
- "value": "string"
}
], - "requiredGates": [
- "analyzer-score"
]
}
Response samples
- 200
{- "id": 0,
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "state": "CREATED",
- "steps": [
- {
- "id": 0,
- "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",
- "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "resolvedTrigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "triggerResult": {
- "type": "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"
}, - "kafka": {
- "partition": "string",
- "offset": "string"
}, - "error": {
- "connectionError": true,
- "runningOnContainer": true,
- "targetsLocalhost": true,
- "message": "string"
}
}
}, - "trace": {
- "traceId": "string",
- "tree": {
- "id": "string",
- "parentId": "string",
- "name": "string",
- "kind": "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",
- "kind": "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",
- "kind": "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
}
]
}
]
}
]
}, - "linter": {
- "minimumScore": 0,
- "passed": true,
- "score": 0,
- "plugins": [
- {
- "name": "string",
- "description": "string",
- "passed": true,
- "score": 0,
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "passed": true,
- "weight": 0,
- "tips": [
- "string"
], - "results": [
- {
- "spanId": null,
- "errors": [ ],
- "passed": null,
- "severity": null
}
], - "level": "error"
}
]
}
]
}, - "outputs": [
- {
- "name": "string",
- "spanId": "string",
- "value": "string",
- "error": "string"
}
], - "requiredGatesResult": {
- "required": [
- "analyzer-score"
], - "failed": [
- "analyzer-score"
], - "passed": true
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "testSuiteId": "string",
- "testSuiteRunId": 0
}
], - "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "pass": 0,
- "fail": 0,
- "allStepsRequiredGatesPassed": true
}
Get all runs from a particular TestSuite
Get all runs from a particular TestSuite
path Parameters
testSuiteId required | string id of the TestSuite |
query Parameters
take | integer Default: 20 indicates how many resources can be returned by each page |
skip | integer Default: 0 indicates how many resources will be skipped when paginating |
Responses
Response samples
- 200
[- {
- "id": 0,
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "state": "CREATED",
- "steps": [
- {
- "id": 0,
- "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",
- "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "resolvedTrigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "triggerResult": {
- "type": "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"
}, - "kafka": {
- "partition": "string",
- "offset": "string"
}, - "error": {
- "connectionError": true,
- "runningOnContainer": true,
- "targetsLocalhost": true,
- "message": "string"
}
}
}, - "trace": {
- "traceId": "string",
- "tree": {
- "id": "string",
- "parentId": "string",
- "name": "string",
- "kind": "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",
- "kind": "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",
- "kind": "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
}
]
}
]
}
]
}, - "linter": {
- "minimumScore": 0,
- "passed": true,
- "score": 0,
- "plugins": [
- {
- "name": "string",
- "description": "string",
- "passed": true,
- "score": 0,
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "passed": true,
- "weight": 0,
- "tips": [
- null
], - "results": [
- null
], - "level": "error"
}
]
}
]
}, - "outputs": [
- {
- "name": "string",
- "spanId": "string",
- "value": "string",
- "error": "string"
}
], - "requiredGatesResult": {
- "required": [
- "analyzer-score"
], - "failed": [
- "analyzer-score"
], - "passed": true
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "testSuiteId": "string",
- "testSuiteRunId": 0
}
], - "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "pass": 0,
- "fail": 0,
- "allStepsRequiredGatesPassed": true
}
]
Get a specific run from a particular TestSuite
Get a specific run from a particular TestSuite
path Parameters
testSuiteId required | string id of the TestSuite |
runId required | integer id of the run |
Responses
Response samples
- 200
{- "id": 0,
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "state": "CREATED",
- "steps": [
- {
- "id": 0,
- "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",
- "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "resolvedTrigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "triggerResult": {
- "type": "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"
}, - "kafka": {
- "partition": "string",
- "offset": "string"
}, - "error": {
- "connectionError": true,
- "runningOnContainer": true,
- "targetsLocalhost": true,
- "message": "string"
}
}
}, - "trace": {
- "traceId": "string",
- "tree": {
- "id": "string",
- "parentId": "string",
- "name": "string",
- "kind": "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",
- "kind": "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",
- "kind": "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
}
]
}
]
}
]
}, - "linter": {
- "minimumScore": 0,
- "passed": true,
- "score": 0,
- "plugins": [
- {
- "name": "string",
- "description": "string",
- "passed": true,
- "score": 0,
- "rules": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "errorDescription": "string",
- "passed": true,
- "weight": 0,
- "tips": [
- "string"
], - "results": [
- {
- "spanId": null,
- "errors": [ ],
- "passed": null,
- "severity": null
}
], - "level": "error"
}
]
}
]
}, - "outputs": [
- {
- "name": "string",
- "spanId": "string",
- "value": "string",
- "error": "string"
}
], - "requiredGatesResult": {
- "required": [
- "analyzer-score"
], - "failed": [
- "analyzer-score"
], - "passed": true
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "testSuiteId": "string",
- "testSuiteRunId": 0
}
], - "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "pass": 0,
- "fail": 0,
- "allStepsRequiredGatesPassed": true
}
run test
run a particular test
path Parameters
testId required | string id of the test |
Request Body schema: application/json
object or null | |
variableSetId | string |
Array of objects (VariableSetValue) | |
requiredGates | Array of strings or null (SupportedGates) Enum: "analyzer-score" "analyzer-rules" "test-specs" |
Responses
Request samples
- Payload
{- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "variableSetId": "string",
- "variables": [
- {
- "key": "string",
- "value": "string"
}
], - "requiredGates": [
- "analyzer-score"
]
}
Response samples
- 200
- 422
{- "id": 0,
- "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",
- "variableSet": {
- "id": "string",
- "name": "string",
- "description": "string",
- "values": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "resolvedTrigger": {
- "type": "http",
- "httpRequest": {
- "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"
}
}, - "sslVerification": false
}, - "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"
}, - "kafka": {
- "brokerUrls": [
- "string"
], - "topic": "string",
- "authentication": {
- "type": "plain",
- "plain": {
- "username": "string",
- "password": "string"
}
}, - "sslVerification": false,
- "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "messageKey": "string",
- "messageValue": "string"
}
}, - "triggerResult": {
- "type": "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"
}, - "kafka": {
- "partition": "string",
- "offset": "string"
}, - "error": {
- "connectionError": true,
- "runningOnContainer": true,
- "targetsLocalhost": true,
- "message": "string"
}
}
}, - "trace": {
- "traceId": "string",
- "tree": {
- "id": "string",
- "parentId": "string",
- "name": "string",
- "kind": "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",
- "kind": "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",
- "kind": "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
}
]
}
]
}
]
},