App Services のメトリクスを取得する

GET /groups/{groupId}/apps/{appId}/metrics
tokenAuth

計算時間、データ転送、同期時間（分)、成功したリクエスト、失敗したリクエストなど、さまざまなメトリクスを検索します。利用可能なメトリクスの完全なリストについては、App Services メトリクス リファレンスを参照してください。

path パラメータ

クエリ パラメータ

  • 始める string 必須

    クエリ期間の開始の ISO-8601 日時（例: "2022-10-27T14:01:01Z"）。

  • end string 必須

    クエリ期間の終了の ISO-8601 日時（例:"2022-12-27T14:01:01Z"）。

  • 粒度 string 必須

    クエリ期間の粒度を ISO-8601 期間値 として指定します。たとえば、「"P31D」（31 日）、「PT1H」（1 時間）、「PT5M」（5 分）などがあります。

  • メトリクス string

    フィルタリングするメトリクスの名前。利用可能なメトリクスとその単位の詳細については、App Services メトリクス リファレンスを参照してください。

    値は ACTIVE_OPEN_SYNC_SESSIONS、AUTH_EGRESS_BYTES、AUTH_FAILED_REQUESTS、AUTH_RESPONSE_MS、AUTH_SUCCESSFUL_LOGIN、AUTH_SUCCESSFUL_REQUESTS、AUTH_TOTAL_USERS、ENDPOINTS_COMPUTE_MS、ENDPOINTS_EGRESS_BYTES、ENDPOINTS_FAILED_REQUEST、ENDPOINTS_RESPONSE_MS、ENDPOINTS_SUCCESSFUL_REQUESTS、 GRAPHQL_RESPONSE_MS、GRAPHQL_COMPUTE_MS、GRAPHQL_EGRESS_BYTES、GRAPHQL_FAILED_REQUESTS、GRAPHQL_SUCCESSFUL_REQUESTS、LF_RESPONSE_MS、OVERALL_COMPUTE_MS、OVERALL_EGRESS_BYTES、OVERALL_FAILED_REQUESTS、OVERALL_SUCCESSFUL_REQUESTS、OVERALL_SYNC_MINUTES、SDK_COMPUTE_MS、SDK_EGRESS_BYTES、SDK_FAILED_REQUESTS、SDK_FNS_RESPONSE_MS、SDK_MQL_COMPUTE_MS、SDK_MQL_EGRESS_BYTES、SDK_MQL_FAILED_REQUESTS、SDK_MQL_RESPONSE_MS、SDK_MQL_SUCCESSFUL_REQUESTS、SDK_SUCCESSFUL_REQUESTS、SYNC_CLIENT_BOOTSTRAP_MS、SYNC_CLIENT_UPLOADS_INVALID、SYNC_CURRENT_OPLOG_LAG_MS_SUM、SYNC_EGRESS_BYTES、 SYNC_FAILED_REQUESTS、SYNC_HISTORY_WRITE_MS、SYNC_MINUTES、SYNC_NUM_INTEGRATION_ATTEMPTS、SYNC_NUM_UNSYNCABLE_DOC、SYNC_OT_MS、SYNC_SESSIONS_ENDED、SYNC_SESSIONS_STARTED、SYNC_SUCCESSFUL_REQUESTS、SYNC_UPLOAD_PROPS_MS、TRIGGERS_COMPUTE_MS、TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM、TRIGGERS_EGRESS_BYTES、TRIGGERS_FAILED_REQUESTS、TRIGGERS_RESPONSE_MS、または TRIGGERS_SUCCESSFUL_REQUESTS のいずれか）。

応答

  • 200 application/ JSON

    正常に取得されました。

    応答属性の非表示 応答属性の表示 オブジェクト
    • 測定値 array[オブジェクト] 必須

      メトリクスのリスト。

      測定属性を非表示にする 測定値属性の表示 オブジェクト
      • data_points array[オブジェクト]

        特定のメトリクスのデータ ポイント のセット。

        data_points 属性を非表示 data_points 属性の表示 オブジェクト
        • タイムスタンプ string

          測定の ISO-8601 日時。

        • 価値 数値

          メトリクスの unitプロパティによって指定される単位での測定値。

      • name string

        メトリクスの名前。利用可能なメトリックとその単位の完全なリストについては、App Services メトリクス リファレンス を参照してください。

      • 単位 string

        各データ ポイントの valueプロパティの単位。

    • app_id string 必須

      リクエストで送信されたアプリID 。

    • app_name string 必須

      人間が判読できるアプリの名前。

    • group_id string 必須

      リクエストで送信されたグループ ID 。

    • 始める string 必須

      最初に要求された測定の日時（ ISO-8601形式）。

    • end string 必須

      最新のリクエストされた測定の日時（ ISO-8601形式）。

    • 粒度 string 必須

      ISO-8601 期間形式のメトリクスの要求された粒度。
GET /groups/{groupId}/apps/{appId}/metrics 
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/metrics?start=string&end=string&granularity=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例（200） 
{
  "measurements": [
    {
      "data_points": [
        {
          "timestamp": "string",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "string"
    }
  ],
  "app_id": "string",
  "app_name": "string",
  "group_id": "string",
  "start": "2022-10-27T14:01:01Z",
  "end": "2022-12-27T14:01:01Z",
  "granularity": "string"
}