Function BillingApiFactory

  • BillingApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        adminAppMeasurements(groupId, appId, start?, end?, granularity?, options?) => AxiosPromise<AdminAppMeasurements200Response>;
        adminMeasurements(groupId, start?, end?, granularity?, options?) => AxiosPromise<AdminMeasurements200Response>;
    }

    • adminAppMeasurements:function
      • adminAppMeasurements(groupId, appId, start?, end?, granularity?, options?): AxiosPromise<AdminAppMeasurements200Response>

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

          Override http request option.

        Returns AxiosPromise<AdminAppMeasurements200Response>

        Summary

        List app billing usage

        Throws

    • adminMeasurements:function
      • adminMeasurements(groupId, start?, end?, granularity?, options?): AxiosPromise<AdminMeasurements200Response>

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

          Override http request option.

        Returns AxiosPromise<AdminMeasurements200Response>

        Summary

        List group billing usage in a given period

        Throws

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc