Get MAU usage records
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.get_mau_period_usage_history
Request parameters
| Name | Type | Is it required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| startTime | string | yes | - | Start time (year, month, day) | 20220202 |
| endTime | string | yes | - | End time (year, month, day) | 20220802 |
Request Response
Type: CostGetMauPeriodUsageHistoryRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful. 200 means success. |
| message | string | Description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, please see: API Code List |
| requestId | string | Request ID. Returned when the request fails. |
| data | <a MauPeriodUsageHistory | Response data |
Sample result:
json
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"records": {
"periodStartTime": "20210901",
"periodEndTime": "20220901",
"amount": "0",
"current": "0"
}
}
}Data Structure
MauPeriodUsageHistory
| Name | Type | Required | Description | Sample value |
|---|---|---|---|---|
| records | array | Yes | Response data Nested type: <a MauPeriodUsageHistoryDto. |
MauPeriodUsageHistoryDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| periodStartTime | string | Yes | Period start time (year, month, day) | 20210901 |
| periodEndTime | string | Yes | Period end time (year, month, day) | 20220901 |
| amount | string | Yes | Total amount of mau used in the current period | 0 |
| current | string | Yes | Amount of mau used in the current period | 0 |