Cloud Tool Results API
API to publish and access results from developer tools.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API to publish and access results from developer tools.
Endpoints 29
projects
- GETGets the Tool Results settings for a project
/toolresults/v1beta3/projects/:projectId/settingsGets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to… - POSTCreates resources for settings which have not yet been set
/toolresults/v1beta3/projects/:projectId:initializeSettingsCreates resources for settings which have not yet been set. Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the…
projects.histories
- GETLists Histories for a given Project
/toolresults/v1beta3/projects/:projectId/histories?filterByName=string&pageSize=0&pageToken=stringLists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history… - POSTCreates a History
/toolresults/v1beta3/projects/:projectId/histories?requestId=stringCreates a History. The returned History will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not… - GETGets a History
/toolresults/v1beta3/projects/:projectId/histories/:historyIdGets a History. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT…
projects.histories.executions
- GETLists Executions for a given History
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions?pageSize=0&pageToken=stringLists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the… - POSTCreates an Execution
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions?requestId=stringCreates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is… - GETGets an Execution
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionIdGets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project -… - PATCHUpdates an existing Execution with the supplied partial entity
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId?requestId=stringUpdates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is…
projects.histories.executions.clusters
- GETRetrieves a single screenshot cluster by its ID
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/clusters/:clusterIdRetrieves a single screenshot cluster by its ID - GETLists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/clustersLists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is…
projects.histories.executions.environments
- GETGets an Environment
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/environments/:environmentIdGets an Environment. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project -… - GETLists Environments for a given Execution
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/environments?pageSize=0&pageToken=stringLists Environments for a given Execution. The Environments are sorted by display name. May return any of the following canonical error codes: -…
projects.histories.executions.steps
- GETLists accessibility clusters for a given Step May return any of the following canonical error codes: -…
/toolresults/v1beta3/:name:accessibilityClusters?locale=stringLists accessibility clusters for a given Step May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to… - GETLists Steps for a given Execution
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps?pageSize=0&pageToken=stringLists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same… - POSTCreates a Step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps?requestId=stringCreates a Step. The returned Step will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not… - GETGets a Step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepIdGets a Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT -… - PATCHUpdates an existing Step with the supplied partial entity
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId?requestId=stringUpdates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not… - GETRetrieves a PerfMetricsSummary
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfMetricsSummaryRetrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist - POSTPublish xml files to an existing Step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId:publishXunitXmlFilesPublish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write…
projects.histories.executions.steps.perfMetricsSummary
- POSTCreates a PerfMetricsSummary resource
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfMetricsSummaryCreates a PerfMetricsSummary resource. Returns the existing one if it has already been created. May return any of the following error code(s): - NOT_FOUND -…
projects.histories.executions.steps.perfSampleSeries
- GETLists PerfSampleSeries for a given Step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfSampleSeries?filter=perfMetricTypeUnspecifiedLists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none… - POSTCreates a PerfSampleSeries
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfSampleSeriesCreates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND… - GETGets a PerfSampleSeries
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfSampleSeries/:sampleSeriesIdGets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist
projects.histories.executions.steps.perfSampleSeries.samples
- POSTCreates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this…
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfSampleSeries/:sampleSeriesId/samples:batchCreateCreates 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… - GETLists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The…
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/perfSampleSeries/:sampleSeriesId/samples?pageSize=0&pageToken=stringLists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and…
projects.histories.executions.steps.testCases
- GETGets details of a Test Case for a Step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/testCases/:testCaseIdGets details of a Test Case for a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes: -… - GETLists Test Cases attached to a Step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/testCases?pageSize=0&pageToken=stringLists Test Cases attached to a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes: -…
projects.histories.executions.steps.thumbnails
- GETLists thumbnails of images attached to a step
/toolresults/v1beta3/projects/:projectId/histories/:historyId/executions/:executionId/steps/:stepId/thumbnails?pageSize=0&pageToken=stringLists thumbnails of images attached to a step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to…
API details
- Base URL
https://toolresults.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 29 operations on 22 pathsGET 19POST 8PATCH 2
- Main resources
- projects.histories.executions.steps 7projects.histories.executions 4projects.histories 3projects.histories.executions.steps.perfSampleSeries 3projects 2projects.histories.executions.clusters 2projects.histories.executions.environments 2projects.histories.executions.steps.perfSampleSeries.samples 2projects.histories.executions.steps.testCases 2projects.histories.executions.steps.perfMetricsSummary 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1beta3 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Tool Results API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Tool Results API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the Tool Results settings for a project” (GET /toolresults/v1beta3/projects/:projectId/settings), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Tool Results API?
API to publish and access results from developer tools. It is listed under Developer tools and has 29 endpoints.
Who publishes the Cloud Tool Results API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Tool Results API?
Requests go to https://toolresults.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Tool Results API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Cloud Tool Results API have?
29 operations on 22 paths (19 GET, 8 POST, 2 PATCH). The largest groups are projects.histories.executions.steps, projects.histories.executions, projects.histories, projects.histories.executions.steps.perfSampleSeries.
Is forking the Cloud Tool Results API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.