Method: projects.getMetrics

    • This page describes how to get metrics data for scripts, such as number of executions and active users.

    • Metrics data is retrieved using a GET request to the provided URL, specifying the script ID in the path parameters.

    • Query parameters allow for specifying the granularity of metrics and applying filters.

    • The response body contains usage stats, including the number of active users, total executions, and failed executions, represented as a JSON object.

    • Authorization requires the https://www.googleapis.com/auth/script.metrics OAuth scope.

    Get metrics data for scripts, such as number of executions and active users.

    HTTP request

    GET https://script.googleapis.com/v1/projects/{scriptId}/metrics

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    scriptId

    string

    Required field indicating the script to get metrics for.

    Query parameters

    Parameters
    metricsGranularity

    enum ( MetricsGranularity )

    Required field indicating what granularity of metrics are returned.
    metricsFilter

    object ( MetricsFilter )

    Optional field containing filters to apply to the request. This limits the scope of the metrics returned to those specified in the filter.

    Request body

    The request body must be empty.

    Response body

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

    Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.

    JSON representation 
     { 
 "activeUsers" 
 : 
 [ 
 { 
 object (  MetricsValue 
 
) 
 } 
 ] 
 , 
 "totalExecutions" 
 : 
 [ 
 { 
 object (  MetricsValue 
 
) 
 } 
 ] 
 , 
 "failedExecutions" 
 : 
 [ 
 { 
 object (  MetricsValue 
 
) 
 } 
 ] 
 }
    Fields
    activeUsers[]

    object ( MetricsValue )

    Number of active users.
    totalExecutions[]

    object ( MetricsValue )

    Number of total executions.
    failedExecutions[]

    object ( MetricsValue )

    Number of failed executions.

    Authorization Scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/script.metrics

    For more information, see the OAuth 2.0 Overview .

    MetricsGranularity

    The granularity of metric to return data for.

    Enums
    UNSPECIFIED_GRANULARITY Default metric granularity used to query no metrics.
    WEEKLY Represents weekly metrics.
    DAILY Represents daily metrics over a period of 7 days.

    MetricsFilter

    Filter used to reduce the scope of the request.

    JSON representation 
     { 
 "deploymentId" 
 : 
 string 
 }
    Fields
    deploymentId

    string

    Optional field indicating a specific deployment to retrieve metrics from.

    MetricsValue

    Metrics value that holds number of executions counted.

    JSON representation 
     { 
 "value" 
 : 
 string 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 }
    Fields
    value

    string

    Indicates the number of executions counted.
    startTime

    string ( Timestamp format)

    Required field indicating the start time of the interval.

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
    endTime

    string ( Timestamp format)

    Required field indicating the end time of the interval.

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: