API to publish and access results from developer tools.
- REST Resource: v1beta3.projects
- REST Resource: v1beta3.projects.histories
- REST Resource: v1beta3.projects.histories.executions
- REST Resource: v1beta3.projects.histories.executions.clusters
- REST Resource: v1beta3.projects.histories.executions.environments
- REST Resource: v1beta3.projects.histories.executions.steps
- REST Resource: v1beta3.projects.histories.executions.steps.perfMetricsSummary
- REST Resource: v1beta3.projects.histories.executions.steps.perfSampleSeries
- REST Resource: v1beta3.projects.histories.executions.steps.perfSampleSeries.samples
- REST Resource: v1beta3.projects.histories.executions.steps.testCases
- REST Resource: v1beta3.projects.histories.executions.steps.thumbnails
Service: toolresults.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://toolresults.googleapis.com
REST Resource: v1beta3.projects
Methods | |
---|---|
getSettings |
GET /toolresults/v1beta3/projects/{projectId}/settings Gets the Tool Results settings for a project. |
initializeSettings |
POST /toolresults/v1beta3/projects/{projectId}:initializeSettings Creates resources for settings which have not yet been set. |
REST Resource: v1beta3.projects.histories
Methods | |
---|---|
create |
POST /toolresults/v1beta3/projects/{projectId}/histories Creates a History. |
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId} Gets a History. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories Lists Histories for a given Project. |
REST Resource: v1beta3.projects.histories.executions
Methods | |
---|---|
create |
POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions Creates an Execution. |
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId} Gets an Execution. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions Lists Executions for a given History. |
patch |
PATCH /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId} Updates an existing Execution with the supplied partial entity. |
REST Resource: v1beta3.projects.histories.executions.clusters
Methods | |
---|---|
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId} Retrieves a single screenshot cluster by its ID |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. |
REST Resource: v1beta3.projects.histories.executions.environments
Methods | |
---|---|
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId} Gets an Environment. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments Lists Environments for a given Execution. |
REST Resource: v1beta3.projects.histories.executions.steps
Methods | |
---|---|
accessibilityClusters |
GET /toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters Lists accessibility clusters for a given Step May return any of the following canonical error codes:
|
create |
POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps Creates a Step. |
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId} Gets a Step. |
getPerfMetricsSummary |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary Retrieves a PerfMetricsSummary. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps Lists Steps for a given Execution. |
patch |
PATCH /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId} Updates an existing Step with the supplied partial entity. |
publishXunitXmlFiles |
POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles Publish xml files to an existing Step. |
REST Resource: v1beta3.projects.histories.executions.steps.perfMetricsSummary
Methods | |
---|---|
create |
POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary Creates a PerfMetricsSummary resource. |
REST Resource: v1beta3.projects.histories.executions.steps.perfSampleSeries
Methods | |
---|---|
create |
POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries Creates a PerfSampleSeries. |
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId} Gets a PerfSampleSeries. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries Lists PerfSampleSeries for a given Step. |
REST Resource: v1beta3.projects.histories.executions.steps.perfSampleSeries.samples
Methods | |
---|---|
batchCreate |
POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist |
REST Resource: v1beta3.projects.histories.executions.steps.testCases
Methods | |
---|---|
get |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId} Gets details of a Test Case for a Step. |
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases Lists Test Cases attached to a Step. |
REST Resource: v1beta3.projects.histories.executions.steps.thumbnails
Methods | |
---|---|
list |
GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails Lists thumbnails of images attached to a step. |