Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-09181183330.0 KB
metrics

Retrieve App Services metrics

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.

get/groups/{groupId}/apps/{appId}/metrics

Path parameters

groupIdstring required

An Atlas Project/Group ID.

appIdstring required

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

Query parameters

startstring required

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

endstring required

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

granularitystring required

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).

metrics'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'

The name of the metric to filter by. For detailed information on the available metrics and their units, see App Services Metrics Reference.

Response

Successfully retrieved.

app_idstring required

The app ID sent in the request.

app_namestring required

The app's human-readable name.

group_idstring required

The group ID sent in the request.

startstring required

The date and time (ISO-8601 format) of the earliest requested measurement.

endstring required

The date and time (ISO-8601 format) of the latest requested measurement.

granularitystring required

The requested granularity of the metrics in ISO-8601 duration format.

Example response

{
  "start": "2022-10-27T14:01:01Z",
  "end": "2022-12-27T14:01:01Z"
}