Function LogsApiFactory

Returns {
    adminGetLogs(groupId, appId, coId?, errorsOnly?, userId?, startDate?, endDate?, skip?, limit?, type?, options?) => AxiosPromise<AdminGetLogs200Response>;
}

• adminGetLogs:function

  • adminGetLogs(groupId, appId, coId?, errorsOnly?, userId?, startDate?, endDate?, skip?, limit?, type?, options?): AxiosPromise<AdminGetLogs200Response>

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

    • Optional coId: any

      Return only log messages associated with the given request Correlation ID.

    • Optional errorsOnly: any

      The value of this field does not matter. If included in the request, this endpoint only returns error logs (even if the value is set to `false`). If this field is excluded from the request, this endpoint only returns non-error logs.

    • Optional userId: any

      Return only log messages associated with the given `user_id`.

    • Optional startDate: any

      The date and time in ISO 8601 at which to begin returning results, exclusive.

    • Optional endDate: any

      The date and time in ISO 8601 at which to cease returning results, inclusive.

    • Optional skip: any

      The offset number of matching log entries to skip before including them in the response.

    • Optional limit: any

      The maximum number of log entries to include in the response. If the query matches more than this many logs, it returns documents in ascending order by date until the limit is reached.

    • Optional type: AdminGetLogsTypeEnum

      The kind of log you would like to retrieve.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AdminGetLogs200Response>

    Summary

    Retrieve App Services logs

    Throws