Function BillingApiAxiosParamCreator

  • BillingApi - axios parameter creator

    Parameters

    Returns {
        adminAppMeasurements: ((groupId, appId, start?, end?, granularity?, options?) => Promise<RequestArgs>);
        adminMeasurements: ((groupId, start?, end?, granularity?, options?) => Promise<RequestArgs>);
    }

    • adminAppMeasurements: ((groupId, appId, start?, end?, granularity?, options?) => Promise<RequestArgs>)
        • (groupId, appId, start?, end?, granularity?, options?): Promise<RequestArgs>
        • List the request, compute, sync, data transfer, and memory usage of a specific app in a given period for billing purposes.

          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 start: any

            The ISO 8601 date and time of the start of the query period. Default is 00:00:00 UTC on the first day of the current month.

          • Optional end: any

            The ISO 8601 date and time of the end of the query period. Default is 23:59:59 UTC on the the last day of the current month.

          • Optional granularity: AdminAppMeasurementsGranularityEnum

            Specifies the granularity of the query period, either P31D (31 day) or PT1H (1 hour). Default is P31D.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          List app billing usage

          Throws

    • adminMeasurements: ((groupId, start?, end?, granularity?, options?) => Promise<RequestArgs>)
        • (groupId, start?, end?, granularity?, options?): Promise<RequestArgs>
        • List the request, compute, sync, and data transfer usage in a given period for billing purposes.

          Parameters

          • groupId: any

            An Atlas Project/Group ID.

          • Optional start: any

            The ISO 8601 date and time of the start of the query period. Default is 00:00:00 UTC on the first day of the current month.

          • Optional end: any

            The ISO 8601 date and time of the end of the query period. Default is 23:59:59 UTC on the the last day of the current month.

          • Optional granularity: AdminMeasurementsGranularityEnum

            Specifies the granularity of the query period, either P31D (31 day) or PT1H (1 hour). Default is P31D.

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          List group billing usage in a given period

          Throws

    Export

Generated using TypeDoc