Skip to main content
API docs by Redocly

TraceTest (0.2.1)

Download OpenAPI specification:Download

OpenAPI definition for TraceTest endpoint and resources

resource-api

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" "status" "last_run"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

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

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

get TestSuite

get TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

Responses

Response samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

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

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "TestSuite",
  • "spec": {
    }
}

delete a TestSuite

delete a TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

Responses

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" "status" "last_run"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Create new test

Create new test action

Request Body schema: application/json
type
string
Value: "Test"

Represents the type of this resource. It should always be set as 'Test'.

object (Test)

Responses

Request samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

Upsert new test

Upsert new test action

Request Body schema: application/json
type
string
Value: "Test"

Represents the type of this resource. It should always be set as 'Test'.

object (Test)

Responses

Request samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

get test

get test

path Parameters
testId
required
string

id of the test

Responses

Response samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

update test

update test action

path Parameters
testId
required
string

id of the test

Request Body schema: application/json
type
string
Value: "Test"

Represents the type of this resource. It should always be set as 'Test'.

object (Test)

Responses

Request samples

Content type
application/json
{
  • "type": "Test",
  • "spec": {
    }
}

delete a test

delete a test

path Parameters
testId
required
string

id of the test

Responses

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

Content type
{
  • "count": 0,
  • "items": [
    ]
}

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

Content type
{
  • "type": "Config",
  • "spec": {
    }
}

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

Content type
{
  • "type": "Config",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Config",
  • "spec": {
    }
}

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

Content type
{
  • "count": 0,
  • "items": [
    ]
}

Create Polling Profile

Create Polling Profile configuration

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

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Upsert new polling profile

Upsert new polling profile

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

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

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

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

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

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "PollingProfile",
  • "spec": {
    }
}

Delete Polling Profile

Delete a polling profile used on Tracetest.

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

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

Content type
{
  • "count": 0,
  • "items": [
    ]
}

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

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

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

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

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

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Demo",
  • "spec": {
    }
}

Delete a Demonstration setting

Delete 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

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

Content type
{
  • "count": 0,
  • "items": [
    ]
}

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

Content type
application/json
{
  • "type": "DataStore",
  • "spec": {
    }
}

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: "jaeger" "opensearch" "tempo" "signalfx" "otlp" "elasticapm" "newrelic" "lightstep" "datadog" "awsxray" "honeycomb" "azureappinsights" "signoz" "dynatrace" "sumologic" "instana" "dash0"
default
boolean
object (GRPCClientSettings)
object (BaseClient)
object (ElasticSearch)
object (ElasticSearch)
object (SignalFX)
object (AwsXRay)
object (AzureAppInsights)
object (SumoLogic)
createdAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "jaeger",
  • "default": true,
  • "jaeger": {
    },
  • "tempo": {
    },
  • "opensearch": {
    },
  • "elasticapm": {
    },
  • "signalfx": {
    },
  • "awsxray": {
    },
  • "azureappinsights": {
    },
  • "sumologic": {
    },
  • "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

Content type
{
  • "count": 0,
  • "items": [
    ]
}

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

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

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

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

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

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "VariableSet",
  • "spec": {
    }
}

Delete a variable set

Delete a variable set from Tracetest

path Parameters
variableSetId
required
string

ID of a VariableSet used on Tracetest to inject values into tests and TestSuites

Responses

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

Content type
{
  • "items": [
    ]
}

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

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Get a specific Linter

Get one Linter by its id

path Parameters
linterId
required
string

ID of an Linter

Responses

Response samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

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

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Response samples

Content type
{
  • "type": "Linter",
  • "spec": {
    }
}

Delete an Linter

Delete an Linter from Tracetest

path Parameters
linterId
required
string

ID of an Linter

Responses

List monitors

List the monitors

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Upsert a Monitor

Upsert a Monitor used on Tracetest

Request Body schema: application/json
type
string
Value: "Monitor"

Represents the type of this resource. It should always be set as 'Monitor'.

object (Monitor)

Responses

Request samples

Content type
application/json
{
  • "type": "Monitor",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Monitor",
  • "spec": {
    }
}

Create a Monitor

Create a Monitor used on Tracetest

Request Body schema: application/json
type
string
Value: "Monitor"

Represents the type of this resource. It should always be set as 'Monitor'.

object (Monitor)

Responses

Request samples

Content type
application/json
{
  • "type": "Monitor",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Monitor",
  • "spec": {
    }
}

Get a Monitor

Get a Monitor

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

Responses

Response samples

Content type
application/json
{
  • "type": "Monitor",
  • "spec": {
    }
}

Update a Monitor

Update a Monitor

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

Request Body schema: application/json
type
string
Value: "Monitor"

Represents the type of this resource. It should always be set as 'Monitor'.

object (Monitor)

Responses

Request samples

Content type
application/json
{
  • "type": "Monitor",
  • "spec": {
    }
}

Delete a Monitor

Delete a Monitor

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

Responses

api

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

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "steps": [
    ],
  • "fullSteps": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "summary": {
    }
}

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
runGroupId
string
Array of objects (VariableSetValue)
requiredGates
Array of strings or null (SupportedGates)
Enum: "analyzer-score" "analyzer-rules" "test-specs"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "variableSetId": "string",
  • "runGroupId": "string",
  • "variables": [
    ],
  • "requiredGates": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "runGroupId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "state": "CREATED",
  • "steps": [
    ],
  • "variableSet": {
    },
  • "metadata": {
    },
  • "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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "runGroupId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "state": "CREATED",
  • "steps": [
    ],
  • "variableSet": {
    },
  • "metadata": {
    },
  • "pass": 0,
  • "fail": 0,
  • "allStepsRequiredGatesPassed": true
}

Delete a specific run from a particular TestSuite

Delete a specific run from a particular TestSuite

path Parameters
testSuiteId
required
string

id of the TestSuite

runId
required
integer

id of the run

Responses

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
runGroupId
string
Array of objects (VariableSetValue)
requiredGates
Array of strings or null (SupportedGates)
Enum: "analyzer-score" "analyzer-rules" "test-specs"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "variableSetId": "string",
  • "runGroupId": "string",
  • "variables": [
    ],
  • "requiredGates": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "traceId": "string",
  • "spanId": "string",
  • "testVersion": 0,
  • "runGroupId": "string",
  • "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": {
    },
  • "resolvedTrigger": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "linter": {
    },
  • "outputs": [
    ],
  • "requiredGatesResult": {
    },
  • "metadata": {
    },
  • "testSuiteId": "string",
  • "testSuiteRunId": 0
}

get the runs for a test

get the runs from a particular test

path Parameters
testId
required
string

id of the test

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

Content type
application/json
[
  • {
    }
]

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

id of the test

runId
required
integer

id of the run

query Parameters
query
string

query to search resources

Responses

Response samples

Content type
application/json
{
  • "selector": {
    },
  • "spanIds": [
    ]
}

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

id of the test

runId
required
integer

id of the run

Request Body schema: application/json
Array of objects (TestSpec)
Array
name
string
selector
string
object (Selector)
assertions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "specs": [
    ]
}

Response samples

Content type
application/json
{
  • "allPassed": true,
  • "results": [
    ]
}

rerun a test run

rerun a test run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "traceId": "string",
  • "spanId": "string",
  • "testVersion": 0,
  • "runGroupId": "string",
  • "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": {
    },
  • "resolvedTrigger": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "linter": {
    },
  • "outputs": [
    ],
  • "requiredGatesResult": {
    },
  • "metadata": {
    },
  • "testSuiteId": "string",
  • "testSuiteRunId": 0
}

get test run results in JUnit xml format

get test run results in JUnit xml format

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

export test and test run information

export test and test run information for debugging

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

Response samples

Content type
application/json
{
  • "test": {
    },
  • "run": {
    }
}

get spans fileter by query

get spans fileter by query

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Request Body schema: application/json
query
string

query to filter spans, can be either a full text search or a Span Query Language query

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "spansIds": [
    ]
}

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

Content type
application/json
{
  • "test": {
    },
  • "run": {
    }
}

Response samples

Content type
application/json
{
  • "test": {
    },
  • "run": {
    }
}

get test Run

get a particular test Run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "traceId": "string",
  • "spanId": "string",
  • "testVersion": 0,
  • "runGroupId": "string",
  • "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": {
    },
  • "resolvedTrigger": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "linter": {
    },
  • "outputs": [
    ],
  • "requiredGatesResult": {
    },
  • "metadata": {
    },
  • "testSuiteId": "string",
  • "testSuiteRunId": 0
}

delete a test run

delete a test run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

update a test run

update a test run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Request Body schema: application/json
testVersion
integer

Test version used when running this test run

runGroupId
string
state
string
Enum: "CREATED" "EXECUTING" "AWAITING_TRACE" "AWAITING_TEST_RESULTS" "ANALYZING_TRACE" "ANALYZING_ERROR" "FINISHED" "STOPPED" "TRIGGER_FAILED" "TRACE_FAILED" "FAILED" "ASSERTION_FAILED"

Current execution state

lastErrorState
string

Details of the cause for the last FAILED state

executionTime
integer

time in seconds it took for the test to complete, either success or fail. If the test is still running, it will show the time up to the time of the request

triggerTime
integer

time in milliseconds it took for the triggering testSuite to complete, either success or fail. If the test is still running, it will show the time up to the time of the request

createdAt
string <date-time>
serviceTriggeredAt
string <date-time>
serviceTriggerCompletedAt
string <date-time>
obtainedTraceAt
string <date-time>
completedAt
string <date-time>
object (VariableSet)
object (Trigger)
object (TriggerResult)
object (Trace)
object (AssertionResults)
object (LinterResult)
Array of objects
object (RequiredGatesResult)
object
testSuiteId
string
testSuiteRunId
integer

Responses

Request samples

Content type
application/json
{
  • "testVersion": 0,
  • "runGroupId": "string",
  • "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": {
    },
  • "resolvedTrigger": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "linter": {
    },
  • "outputs": [
    ],
  • "requiredGatesResult": {
    },
  • "metadata": {
    },
  • "testSuiteId": "string",
  • "testSuiteRunId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "traceId": "string",
  • "spanId": "string",
  • "testVersion": 0,
  • "runGroupId": "string",
  • "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": {
    },
  • "resolvedTrigger": {
    },
  • "triggerResult": {
    },
  • "trace": {
    },
  • "result": {
    },
  • "linter": {
    },
  • "outputs": [
    ],
  • "requiredGatesResult": {
    },
  • "metadata": {
    },
  • "testSuiteId": "string",
  • "testSuiteRunId": 0
}

Get definition for a test

Gets definition for a test

path Parameters
testId
required
string

id of the test

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a test specific version

get a test specific version

path Parameters
testId
required
string

id of the test

version
required
integer

version of the test

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "trigger": {
    },
  • "skipTraceCollection": true,
  • "pollingProfile": "string",
  • "specs": [
    ],
  • "outputs": [
    ],
  • "summary": {
    }
}

stops the execution of a test run

stops the execution of a test run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

skips the trace collection of a test run

skips the trace collection of a test run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

get events from a test run

get events from a test run

path Parameters
testId
required
string

id of the test

runId
required
integer

id of the run

Responses

Response samples

Content type
application/json
[
  • {
    }
]

resolves an expression and returns the result string

resolves an expression and returns the result string

Request Body schema: application/json
expression
string
object (ResolveContext)

Responses

Request samples

Content type
application/json
{
  • "expression": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "resolvedValues": [
    ]
}

Get resources

get resources

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" "status" "last_run"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tests the config data store/exporter connection

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" "honeycomb" "azureappinsights" "signoz" "dynatrace" "sumologic" "instana" "dash0"
default
boolean
object (GRPCClientSettings)
object (BaseClient)
object (ElasticSearch)
object (ElasticSearch)
object (SignalFX)
object (AwsXRay)
object (AzureAppInsights)
object (SumoLogic)
createdAt
string <date-time>

Responses

Request samples

Content type
text/json
{
  • "name": "string",
  • "type": "jaeger",
  • "default": true,
  • "jaeger": {
    },
  • "tempo": {
    },
  • "opensearch": {
    },
  • "elasticapm": {
    },
  • "signalfx": {
    },
  • "awsxray": {
    },
  • "azureappinsights": {
    },
  • "sumologic": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "successful": true,
  • "steps": [
    ]
}

get information about the OTLP connection

get information about the OTLP connection

Responses

Response samples

Content type
application/json
{
  • "spanCount": 0,
  • "lastSpanTimestamp": null
}

reset the OTLP connection span count

reset the OTLP connection span count

Responses

Get the version of the API

Get the version of the API

path Parameters
fileExtension
required
string

Responses

Response samples

Content type
application/json
{
  • "version": "1.0.0",
  • "type": "oss",
  • "uiEndpoint": "string",
  • "agentEndpoint": "string",
  • "apiEndpoint": "string"
}

Get a specific wizard

Get the configured Wizard, showing the state of each step.

Responses

Response samples

Content type
application/json
{
  • "steps": [
    ]
}

Update a Wizard

Update a Wizard used on Tracetest

Request Body schema: application/json
Array of objects (WizardStep)
Array
id
string
Enum: "tracing_backend" "create_test" "agent"
state
string
Enum: "inProgress" "completed" "pending"
completedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "steps": [
    ]
}

Response samples

Content type
application/json
{
  • "steps": [
    ]
}

Get all run groups

Get all the run groups in the system

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

status
string

query to search resources by status

sortBy
string
Enum: "created" "name" "status" "last_run"

indicates the sort field for the resources

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create a RunGroup

Create a RunGroup used on Tracetest

Request Body schema: application/json
id
required
string
object
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "summary": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "status": "created",
  • "summary": {
    },
  • "metadata": {
    }
}

Get a run group

Get a run groups in the system

path Parameters
runGroupId
required
string

ID of an RunGroup

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "status": "created",
  • "summary": {
    },
  • "metadata": {
    }
}

Get a Monitor with Version

Get a Monitor with Version

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

version
required
integer

version of the test

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": 0,
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "tests": [
    ],
  • "testSuites": [
    ],
  • "fullTests": [
    ],
  • "fullTestSuites": [
    ],
  • "variableSetId": "string",
  • "tokenId": "string",
  • "schedule": {
    },
  • "alerts": [
    ],
  • "summary": {
    }
}

run Monitor

run a particular Monitor

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

Request Body schema: application/json
object or null
runGroupId
string
runType
string
Enum: "SCHEDULED" "MANUAL"
Array of objects (VariableSetValue)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "runGroupId": "string",
  • "runType": "SCHEDULED",
  • "variables": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "monitorId": "string",
  • "monitorVersion": 0,
  • "runGroupId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "executionType": "MANUAL",
  • "lastError": "string",
  • "state": "CREATED",
  • "variableSet": {
    },
  • "metadata": {
    },
  • "testRunsCount": 0,
  • "testSuiteRunsCount": 0,
  • "testRuns": [
    ],
  • "testSuiteRuns": [
    ],
  • "alerts": [
    ]
}

Get a Monitor runs

Get a Monitor runs

path Parameters
monitorId
required
string

ID of a monitor used on 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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Get a specific run from a particular Monitor

Get a specific run from a particular Monitor

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

runId
required
integer

id of the run

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "monitorId": "string",
  • "monitorVersion": 0,
  • "runGroupId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "executionType": "MANUAL",
  • "lastError": "string",
  • "state": "CREATED",
  • "variableSet": {
    },
  • "metadata": {
    },
  • "testRunsCount": 0,
  • "testSuiteRunsCount": 0,
  • "testRuns": [
    ],
  • "testSuiteRuns": [
    ],
  • "alerts": [
    ]
}

Delete a Monitor

Delete a Monitor

path Parameters
monitorId
required
string

ID of a monitor used on Tracetest

runId
required
integer

id of the run

Responses

Tests the alert trigger

Tests the alert trigger

Request Body schema: text/json
id
string
type
string
Value: "webhook"
object (Webhook)
events
Array of strings
Items Value: "FAILED"

Responses

Request samples

Content type
text/json
{
  • "id": "string",
  • "type": "webhook",
  • "webhook": {
    },
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "alertId": "string",
  • "id": "string",
  • "webhook": {
    },
  • "type": "webhook"
}

Lists all invites

Lists pending invites

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

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Creates a pending invite

Creates pending email invite

Request Body schema: application/json
required

invite resource details body

type
string
Value: "Invite"
object (Invite)

Responses

Request samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Upserts a pending invite

Upserts invite

Request Body schema: application/json
required

invite resource details body

type
string
Value: "Invite"
object (Invite)

Responses

Request samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Get invite

get invite

path Parameters
inviteID
required
string

ID for invite

Responses

Response samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Updates a pending invite

Updates pending email invite

path Parameters
inviteID
required
string

ID for invite

Request Body schema: application/json
required

invite resource details body

type
string
Value: "Invite"
object (Invite)

Responses

Request samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Delete pending invite

delete pending invite

path Parameters
inviteID
required
string

ID for invite

Responses

Response samples

Content type
application/json
{
  • "type": "Invite",
  • "spec": {
    }
}

Lists all tokens

Lists tokens

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

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Creates a new token

Creates a new token

Request Body schema: application/json
required

invite details body

id
required
string
name
required
string

token name

isRevoked
boolean
role
required
string (Role)
Enum: "owners" "members" "admins" "billers" "engineers" "runners" "agent"
userID
string
duration
integer

token duration in minutes

issuedAt
string <date-time>
expiresAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "my-token",
  • "isRevoked": true,
  • "role": "owners",
  • "userID": "string",
  • "duration": 3600,
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "my-token",
  • "isRevoked": true,
  • "role": "owners",
  • "userID": "string",
  • "duration": 3600,
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Upserts a new token

Upserts a new token

Request Body schema: application/json
required

invite details body

id
required
string
name
required
string

token name

isRevoked
boolean
role
required
string (Role)
Enum: "owners" "members" "admins" "billers" "engineers" "runners" "agent"
userID
string
duration
integer

token duration in minutes

issuedAt
string <date-time>
expiresAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "my-token",
  • "isRevoked": true,
  • "role": "owners",
  • "userID": "string",
  • "duration": 3600,
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "my-token",
  • "isRevoked": true,
  • "role": "owners",
  • "userID": "string",
  • "duration": 3600,
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete token for environment

delete token

path Parameters
tokenID
required
string

ID for token

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "my-token",
  • "isRevoked": true,
  • "role": "owners",
  • "userID": "string",
  • "duration": 3600,
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update token for environment

update token

path Parameters
tokenID
required
string

ID for token

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "my-token",
  • "isRevoked": true,
  • "role": "owners",
  • "userID": "string",
  • "duration": 3600,
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List environments

List environments from an organization

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

sortDirection
string
Enum: "asc" "desc"

indicates the sort direction for the resources

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Create new environment

Create test environment

Request Body schema: application/json
required

environment resource details body

type
string
Value: "Environment"
object (Environment)

Responses

Request samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labels": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isLocal": false,
  • "userID": "string",
  • "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
  • "agentApiKey": "string",
  • "resources": "string"
}

Upsert new environment

Upsert test environment

Request Body schema: application/json
required

environment resource details body

type
string
Value: "Environment"
object (Environment)

Responses

Request samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Get environment by ID

Get test environment by ID from CRD in kubernetes cluster

path Parameters
environmentID
required
string

ID for environment

Responses

Response samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Update environment

Update environment with given request body

path Parameters
environmentID
required
string

ID for environment

Request Body schema: application/json
required

environment resource details body

type
string
Value: "Environment"
object (Environment)

Responses

Request samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Delete test environment

Deletes a test environment

path Parameters
environmentID
required
string

ID for environment

Responses

Response samples

Content type
application/json
{
  • "type": "Environment",
  • "spec": {
    }
}

Introspect the GraphQL schema

Introspect the GraphQL schema

Request Body schema: text/json
url
string
Array of objects (HTTPHeader)
object (HTTPAuth)
object (GraphqlBody)
sslVerification
boolean
Default: false
schema
string

Responses

Request samples

Content type
text/json
{
  • "url": "string",
  • "headers": [
    ],
  • "auth": {
    },
  • "body": {
    },
  • "sslVerification": false,
  • "schema": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "statusCode": 0,
  • "headers": [
    ],
  • "body": "string"
}

Get list of traces from agent

Get list of traces from agent

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

Content type
application/json
{
  • "traces": [
    ],
  • "error": "string"
}

Get a specific trace

Get a specific trace

path Parameters
traceId
required
string

ID of a Trace

Responses

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "tree": {
    },
  • "flat": {
    }
}