Class MetricsApi

MetricsApi - object-oriented interface

Export

Hierarchy

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

adminGetMetrics

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

adminGetMetrics

  • 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. "2022-10-27T14:01:01Z").

    • end: any

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

    • granularity: any

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

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<AdminGetMetrics200Response, any>>

    Summary

    Retrieve App Services metrics

    Throws

    Memberof

    MetricsApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc