Function MetricsApiFactory

  • MetricsApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        adminGetMetrics(groupId, appId, start, end, granularity, options?) => AxiosPromise<AdminGetMetrics200Response>;
    }

    • adminGetMetrics:function
      • adminGetMetrics(groupId, appId, start, end, granularity, options?): AxiosPromise<AdminGetMetrics200Response>

      • Retrieves a variety of metrics, including: Compute Time, Data Transfer, Sync Minutes, Requests Succeeded, Requests Failed. For a complete list of available metrics, see App Services Metrics Reference.

        Parameters

        • groupId: any

          An Atlas Project/Group ID.

        • appId: any

          The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

        • start: any

          The ISO-8601 date and time of the start of the query period (e.g. &quot;2022-10-27T14:01:01Z&quot;).

        • end: any

          The ISO-8601 date and time of the end of the query period (e.g. &quot;2022-12-27T14:01:01Z&quot;).

        • granularity: any

          Specifies the granularity of the query period as an ISO-8601 duration value. Examples include &quot;P31D&quot; (31 day), &quot;PT1H&quot; (1 hour), and &quot;PT5M&quot; (5 minutes).

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<AdminGetMetrics200Response>

        Summary

        Retrieve App Services metrics

        Throws

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc