clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	firebase.toolresults.clusters

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
activity	string	A string that describes the activity of every screen in the cluster.
clusterId	string	A unique identifier for the cluster. @OutputOnly
keyScreen	object	A singular screen that represents the cluster as a whole. This screen will act as the "cover" of the entire cluster. When users look at the clusters, only the key screen from each cluster will be shown. Which screen is the key screen is determined by the ClusteringAlgorithm (id: Screen)
screens	array	Full list of screens.

list

Successful response

Name	Datatype	Description
clusters	array	The set of clusters associated with an execution Always set

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectId, historyId, executionId, clusterId		Retrieves a single screenshot cluster by its ID
list	select	projectId, historyId, executionId		Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clusterId	string
executionId	string
historyId	string
projectId	string

SELECT examples

get

Retrieves a single screenshot cluster by its ID

SELECT
activity,
clusterId,
keyScreen,
screens
FROM firebase.toolresults.clusters
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required
AND clusterId = '{{ clusterId }}' -- required;

list

Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.

SELECT
clusters
FROM firebase.toolresults.clusters
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required;