1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. Management module

  8. /

  9. Manage metering and billing

  10. /
  11. Get MAU usage records

Get MAU usage records

Update time: 2025-07-23 07:34:21
Edit

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Get the current user pool MAU usage record

Method Name

ManagementClient.getMauPeriodUsageHistory

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
endTimestringyes-End time (year, month, day)20220802
startTimestringyes-Start time (year, month, day)20220202

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CostGetCurrentUsageRespDto;
import cn.authing.sdk.java.dto.CostGetMauPeriodUsageHistoryRespDto;
import cn.authing.sdk.java.dto.GetMauPeriodUsageHistoryDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class GetMauPeriodUsageHistoryTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        GetMauPeriodUsageHistoryDto getMauPeriodUsageHistoryDto = new GetMauPeriodUsageHistoryDto();
        getMauPeriodUsageHistoryDto.setStartTime("20220202");
        getMauPeriodUsageHistoryDto.setEndTime("20220802");
        CostGetMauPeriodUsageHistoryRespDto mauPeriodUsageHistory = client.getMauPeriodUsageHistory(getMauPeriodUsageHistoryDto);
        System.out.println(JsonUtils.serialize(mauPeriodUsageHistory));
    }
}

Request Response

Type： CostGetMauPeriodUsageHistoryRespDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see：API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataMauPeriodUsageHistoryResponse data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "records": {
      "periodStartTime": "20210901",
      "periodEndTime": "20220901",
      "amount": "0",
      "current": "0"
    }
  }
}

Data Structure

MauPeriodUsageHistory

NameType
Is it required
Description
Example Value
recordsarrayyesResponse data nested type：MauPeriodUsageHistoryDto。

MauPeriodUsageHistoryDto

NameType
Is it required
Description
Example Value
periodStartTimestringyesPeriod start time (year, month, day)20210901
periodEndTimestringyesPeriod end time (year, month, day)20220901
amountstringyesTotal amount of mau used in the current period0
currentstringyesAmount of mau used in the current period0