Get Metrics
|
|||||
|
|
||||
Get metrics data for scripts, such as number of executions and active users
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View Google Apps Script project's metrics
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
scriptId Required |
STRING |
Required field indicating the script to get metrics for |
metricsFilter.deploymentId |
STRING |
Optional field indicating a specific deployment to retrieve metrics from |
metricsGranularity |
ENUMERATION |
Required field indicating what granularity of metrics are returned |
= Parameter name
= Format
|
scriptId STRING Required Required field indicating the script to get metrics for |
|
metricsFilter.deploymentId STRING Optional field indicating a specific deployment to retrieve metrics from |
|
metricsGranularity ENUMERATION Required field indicating what granularity of metrics are returned |
Output
This building block provides 12 output parameters
| Name | Format | Description |
|---|---|---|
activeUsers[] |
OBJECT |
Metrics value that holds number of executions counted |
activeUsers[].endTime |
ANY |
Required field indicating the end time of the interval |
activeUsers[].startTime |
ANY |
Required field indicating the start time of the interval |
activeUsers[].value |
INTEGER |
Indicates the number of executions counted |
totalExecutions[] |
OBJECT |
Metrics value that holds number of executions counted |
totalExecutions[].endTime |
ANY |
Required field indicating the end time of the interval |
totalExecutions[].startTime |
ANY |
Required field indicating the start time of the interval |
totalExecutions[].value |
INTEGER |
Indicates the number of executions counted |
failedExecutions[] |
OBJECT |
Metrics value that holds number of executions counted |
failedExecutions[].endTime |
ANY |
Required field indicating the end time of the interval |
failedExecutions[].startTime |
ANY |
Required field indicating the start time of the interval |
failedExecutions[].value |
INTEGER |
Indicates the number of executions counted |
= Parameter name
= Format
|
activeUsers[] OBJECT Metrics value that holds number of executions counted |
|
activeUsers[].endTime ANY Required field indicating the end time of the interval |
|
activeUsers[].startTime ANY Required field indicating the start time of the interval |
|
activeUsers[].value INTEGER Indicates the number of executions counted |
|
totalExecutions[] OBJECT Metrics value that holds number of executions counted |
|
totalExecutions[].endTime ANY Required field indicating the end time of the interval |
|
totalExecutions[].startTime ANY Required field indicating the start time of the interval |
|
totalExecutions[].value INTEGER Indicates the number of executions counted |
|
failedExecutions[] OBJECT Metrics value that holds number of executions counted |
|
failedExecutions[].endTime ANY Required field indicating the end time of the interval |
|
failedExecutions[].startTime ANY Required field indicating the start time of the interval |
|
failedExecutions[].value INTEGER Indicates the number of executions counted |