Cloud Tool Results API . projects . histories . executions . clusters

get(projectId, historyId, executionId, clusterId)

Retrieves a single screenshot cluster by its ID

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, An Execution id.

Required. (required)
  clusterId: string, A Cluster id

Required. (required)

Returns:
  An object of the form:

    {
    "keyScreen": { # 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
      "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
      "model": "A String", # Model of the device that the screenshot was taken on. Required.
      "version": "A String", # OS version of the device that the screenshot was taken on. Required.
      "fileReference": "A String", # File reference of the png file. Required.
    },
    "screens": [ # Full list of screens.
      {
        "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
        "model": "A String", # Model of the device that the screenshot was taken on. Required.
        "version": "A String", # OS version of the device that the screenshot was taken on. Required.
        "fileReference": "A String", # File reference of the png file. Required.
      },
    ],
    "clusterId": "A String", # A unique identifier for the cluster.
    "activity": "A String", # A string that describes the activity of every screen in the cluster.
  }

list(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.

Args:
  projectId: string, A Project id.

Required. (required)
  historyId: string, A History id.

Required. (required)
  executionId: string, An Execution id.

Required. (required)

Returns:
  An object of the form:

    {
    "clusters": [ # The set of clusters associated with an execution Always set
      {
        "keyScreen": { # 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
          "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
          "model": "A String", # Model of the device that the screenshot was taken on. Required.
          "version": "A String", # OS version of the device that the screenshot was taken on. Required.
          "fileReference": "A String", # File reference of the png file. Required.
        },
        "screens": [ # Full list of screens.
          {
            "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
            "model": "A String", # Model of the device that the screenshot was taken on. Required.
            "version": "A String", # OS version of the device that the screenshot was taken on. Required.
            "fileReference": "A String", # File reference of the png file. Required.
          },
        ],
        "clusterId": "A String", # A unique identifier for the cluster.
        "activity": "A String", # A string that describes the activity of every screen in the cluster.
      },
    ],
  }