Provides read-only access to usage consumption and allowance information for Data Integrity Suite services that support usage-based pricing. This API is read-only and does not perform billing, quota enforcement, or purchasing actions.
Request
Query parameters
| Key | Required | Type | Description |
|---|---|---|---|
| period | No | string | Time period for usage. Default value:
billing_period Available values:
last_hour | last_day | last_week | last_month |
billing_period
|
| startDate | No | string | Start date for the usage period in ISO 8601 format. |
| endDate | No | string | End date for the usage period in ISO 8601 format. |
| productName | Conditional | string |
Optional, but mandatory if serviceName is provided. Default: all authorized modules. Available values: |
| serviceName | No | string | Default: all metrics for selected module. |
| userId | No | string | User ID to filter usage for a specific user. |
Response
The successful response returns aggregated usage metrics for the specified account and time range.
Response body properties
| Ancestors | Property | Required | Type | Description |
|---|---|---|---|---|
| accountId | Yes | string | Customer account identifier. | |
| usage | Yes | array(object) | Collection of usage metrics. | |
| usage.metric | Yes | string | Name of the pricing metric. | |
| usage.consumed | Yes | number | Amount of usage consumed during the requested period. | |
| usage.unit | No | string | Unit of measurement for the metric. |
Response body examples
Example status code responses for this method are shown here. To view the response schemas, you can download the Open API Specification from the Precisely Developer Portal.
{
"subscriptionId": "r3izlti0s6",
"usageByWorkspace": [
{
"workspaceId": "ty4mizrwqih6egnq",
"startDate": "2025-12-01T00:00:00Z",
"endDate": "2026-02-25T23:31:00Z",
"interval": "month",
"usageByProducts": {
"Data Catalog": {
"usageByService": {
"Technical Assets Count": {
"totalCreditsAllocated": 0,
"totalUsage": 668,
"totalCreditsUsed": 668,
"usage": {
"Technical Assets Count": [
{
"timestamp": "2025-12-01 00:00:00.000000000",
"usage": 406,
"credits": 406
},
{
"timestamp": "2026-01-01 00:00:00.000000000",
"usage": 239,
"credits": 239
},
{
"timestamp": "2026-02-01 00:00:00.000000000",
"usage": 23,
"credits": 23
}
]
}
}
}
},
"Geo Addressing": {
"usageByService": {
"Address Autocomplete Enterprise - AMER": {
"totalCreditsAllocated": 500000,
"totalUsage": 0,
"totalCreditsUsed": 0,
"usage": {}
},
"Address Autocomplete Premium - AMER": {
"totalCreditsAllocated": 500000,
"totalUsage": 50021,
"totalCreditsUsed": 50021,
"usage": {
"AddressAutocomplete": [
{
"userId": "00u2jvut11aRWDeHq0h8",
"timestamp": "2026-02-01 00:00:00.000000000",
"usage": 1,
"credits": 1
},
{
"timestamp": "2026-02-01 00:00:00.000000000",
"usage": 20000,
"credits": 20000
}
],
"AddressAutocompleteExpress": [
{
"timestamp": "2026-02-01 00:00:00.000000000",
"usage": 30020,
"credits": 30020
}
]
}
},
"Address Bulk Geocode Premium - AMER": {
"totalCreditsAllocated": 100000,
"totalUsage": 0,
"totalCreditsUsed": 0,
"usage": {}
},
"Address Verify Essentials - AMER": {
"totalCreditsAllocated": 500000,
"totalUsage": 0,
"totalCreditsUsed": 0,
"usage": {}
},
"Email Verification - World": {
"totalCreditsAllocated": 0,
"totalUsage": 0,
"totalCreditsUsed": 0,
"usage": {}
},
"Phone Verification - World": {
"totalCreditsAllocated": 0,
"totalUsage": 0,
"totalCreditsUsed": 0,
"usage": {}
}
}
}
}
}
]
}{
"title": "Bad Request",
"status": 400,
"detail": "Invalid query parameters",
"instance": "/api/v1/administration/usage/summary",
"errorCode": "ADMIN-USAGE-USR-0005"
}{
"errors": [
{
"status": "INVALID_TOKEN",
"errorMessage": "Unauthorized (DIS-1001)"
}
]
}{
"title": "Forbidden",
"status": 403,
"detail": "User is Forbidden",
"instance": "/api/v1/administration/usage/summary",
"errorCode": "ADMIN-USAGE-USR-0004"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Rate limit exceeded"
}{
"title": "Internal Server Error",
"status": 500,
"detail": "Error in fetching usage summary",
"instance": "/api/v1/administration/usage/summary",
"errorCode": "ADMIN-USAGE-SVC-0002"
}