Testkube Control Plane ../insights operations

• getGet environment execution duration stats
• getGet time series insights
• getGet environment execution count stats
• getGet environment workflow summaries

API docs by Redocly

Testkube Pro API (cloud-api/1.10.38)

Download OpenAPI specification:Download

E-mail: testkube@kubeshop.io License: COMMERICAL

API for Testkube Pro

Get environment execution duration stats

Get environment execution duration stats

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

query Parameters

startDate	string <date-time> Example: startDate=2006-01-02T15:04:05Z startDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
endDate	string <date-time> Example: endDate=2006-01-02T15:04:05Z endDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
groupBy	string group by field

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/insights/executions

Response samples

• 200
• 400
• 401
• 403

Content type

application/json

{

• "count": {

  • "total": 0,
  • "values": [

    • null

    ]

  },
• "duration": {

  • "total": 0,
  • "values": [

    • null

    ]

  }

}

Get time series insights

Get time series insights

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

query Parameters

startDate	string <date-time> Example: startDate=2006-01-02T15:04:05Z startDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
endDate	string <date-time> Example: endDate=2006-01-02T15:04:05Z endDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
measure required	string Example: measure=execution-count The y-axis to measure within the time series.
aggregate required	string Example: aggregate=sum The aggregation to perform on the time series bucket.
segment	string Example: segment=status Creates a breakdown for each time series metric for the given segment property.
selector	string Example: selector=kubernetes.io/app=demo Only workflow executions with given status are included in this time series chart.
status	string Example: status=failed Only workflow executions with given status are included in this time series chart.
workflow	string Example: workflow=my-workflow The workflow for which the time series should be created.

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/insights/series

Response samples

• 200
• 400
• 401
• 403

Content type

application/json

[

• {

  • "ts": 0,
  • "value": 0,
  • "segments": [

    • {

      • "label": "string",
      • "value": 0

      }

    ]

  }

]

Get environment execution count stats

Get environment execution count stats

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

query Parameters

startDate	string <date-time> Example: startDate=2006-01-02T15:04:05Z startDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
endDate	string <date-time> Example: endDate=2006-01-02T15:04:05Z endDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
workflow	string Example: workflow=my-workflow The workflow for which the time series should be created.

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/insights/stats

Response samples

• 200
• 400
• 401
• 403

Content type

application/json

{

• "ratioStats": {

  • "total": 0.1,
  • "values": [

    • null

    ]

  },
• "totalStats": {

  • "total": 0,
  • "values": [

    • null

    ]

  },
• "failedStats": {

  • "total": 0,
  • "values": [

    • null

    ]

  }

}

Get environment workflow summaries

Get environment workflow summaries

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

query Parameters

startDate	string <date-time> Example: startDate=2006-01-02T15:04:05Z startDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"
endDate	string <date-time> Example: endDate=2006-01-02T15:04:05Z endDate for filtering in RFC3339 format, i.e. "2006-01-02T15:04:05Z"

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/insights/workflows

Response samples

• 200
• 400
• 401
• 403

Content type

application/json

[

• {

  • "name": "string",
  • "totalExecutionCount": 0,
  • "failedExecutionCount": 0,
  • "averageDuration": 0,
  • "lastRunAt": "2019-08-24T14:15:22Z",
  • "labels": {

    • "app": [

      • "backend"

      ],
    • "env": [

      • "prod"

      ]

    }

  }

]