Method: legacyPlaybooks.legacyGetPlaybookStatsMap

Full name: projects.locations.instances.legacyPlaybooks.legacyGetPlaybookStatsMap

legacyPlaybooks.legacyGetPlaybookStatsMap returns statistic data related to the workflow (such as number of runs, distribution by time, etc.).

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the playbook stats map for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "fromUnixTimeMs": string,
  "toUnixTimeMs": string,
  "originalWorkflowIdentifier": string
}
Fields
fromUnixTimeMs

string (int64 format)

Optional. The start time for the stats in unix time ms.
toUnixTimeMs

string (int64 format)

Optional. The end time for the stats in unix time ms.
originalWorkflowIdentifier

string

Required. The original workflow identifier.

Response body

LegacyPlaybookGetPlaybookStatsMapResponse is a response for getting playbook stats map.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "steps": {
    string: {
      object (SearchEverythingPlaybookStepRunStats)
    },
    ...
  },
  "flows": {
    string: {
      object (SearchEverythingPlaybookFlowRunStats)
    },
    ...
  }
}
Fields
steps

map (key: string, value: object (SearchEverythingPlaybookStepRunStats))

Optional. The steps stats.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
flows

map (key: string, value: object (SearchEverythingPlaybookFlowRunStats))

Optional. The flows stats.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SearchEverythingPlaybookStepRunStats

SearchEverythingPlaybookStepRunStats represents the stats for a step run.

JSON representation 
{
  "successfulRuns": integer,
  "faultedRuns": integer,
  "totalRuns": integer
}
Fields
successfulRuns

integer

Required. The number of successful runs.
faultedRuns

integer

Required. The number of faulted runs.
totalRuns

integer

Required. The total number of runs.

SearchEverythingPlaybookFlowRunStats

SearchEverythingPlaybookFlowRunStats represents the stats for a flow run.

JSON representation 
{
  "faultedRuns": integer,
  "totalRuns": integer,
  "branchRuns": {
    string: integer,
    ...
  }
}
Fields
faultedRuns

integer

Required. The number of faulted runs.
totalRuns

integer

Required. The total number of runs.
branchRuns

map (key: string, value: integer)

Optional. The number of runs for each branch.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.