View metered usage processing status
The Metered usage V2 REST API is referred to in this topic. See Metered usage V2.
❗ Important Metered usage v2 is currently in Early Availability status. Features in Early Availability status are only available in production to a limited number of customers based on fit with specific use cases. For more information about Early Availability status, see Product lifecycle phases. If you would like to use the product capabilities described here during the Early Availability phase, contact your AppDirect technical representative.
After metered usage is submitted, Marketplace Managers, and Developers who belong to a Developer company and own IaaS products, have two options to check whether it processed successfully, view errors, and manage failures (see Fix metered usage errors):
- in the user interface (UI) on the Metered usage page
- with the Metered usage v2 API, if the usage was submitted with the Metered usage v2 API—see Fetch usage processing status
The Metered usage page displays processing status for usage submitted
- with the Metered usage V2 API
- by AppDirect for Infrastructure as a Service (IaaS) billing products—Google Cloud Platform, Azure, and Amazon Web Services pay-as-you-go (see View IaaS billing metered usage processing status)
📝 Note Only AppDirect can enable the Metered usage page. To request it, contact your AppDirect technical representative.
The Metered usage page displays the following information, depending on your role:
- Marketplace Managers: every metered usage request submitted to the marketplace
- Developers who belong to a Developer company that owns products: every metered usage request submitted to the marketplace for their products
- Developers who belong to the company that owns the marketplace: no access to the Metered usage page
Key terms and metered usage submission process
Metered usage is submitted to marketplaces by API request. Request is a standard API term.
Metered usage API requests (also known as calls) are performed to send usage data to marketplaces. Each request can include one or more usage events, which are individual usage records. When metered usage requests are submitted with an optional caller-generated Request Group Identifier, the requests appear together in the UI.
As metered usage requests and events are processed, they appear on the Metered usage listing and detail pages, on In processing, Failed, and Successful tabs. The tabs only appear if there are events to display on them.
How you can check the status of metered usage processing, and descriptions of the information that appears, follows.
To check metered usage processing status and errors
- Go to Manage > Marketplace > Dashboard | BILLING | Metered Usage.
The Metered usage page opens. It displays:
- usage requests, when requests were submitted without a Request Group ID
- groups of usage requests, when requests were submitted with a Request Group ID (with the optional requestGroupId parameter)
- a summary of each request or request group (for definitions of the information that appears on this page, see the Request summary information link later in this topic)
- Click a request, or request group, row. The request details page opens. Successful, and sometimes Failed and In Progress, tabs display metered usage events included in the requests. For definitions of the information that appears on this page, see the Request details link that appears later in this topic.
- To view events currently being processed, click In Progress.
- To view events that failed, click Failed.
- To view the errors that caused an event to fail, click the event. System errors and Data errors tabs display failed events (for definitions of the information that appears in this view, see the Failed event errors link later in this topic). There is also an option to reprocess system errors.
Metered usage processing status information that appears in the UI
Request summary information
The Metered usage page displays a list of requests and a summary of each one.
Request summary
| Request details |
|---|
| Request status |
| Completion date |
Request details
The request details page displays additional information about a request.
Request details
| Request summary pane | |
|---|---|
| Either: Request identifier—System-generated identifier for the request returned in a response Group Request Identifier—Caller-generated identifier submitted with related requests to associate them (for example, all requests submitted for a particular billing period) | |
| Request status | |
| In progress—Usage processing is underway | |
| Run Completed—All usage events in the run were processed, successfully or not | |
| Failed—All usage requests in a usage submission run failed | |
| Usage events received—Number of usage events submitted with the request | |
| Usage events failed—Number of usage events in the request that did not process successfully | |
| Usage events successful—Number of usage events in the request that were processed successfully | |
| Usage events ready—Number of volume pricing events that are ready for bulk processing after the billing period ends (always displays zero for other pricing models) | |
| Request processing status tabs | The following tabs appear when there are events in the corresponding status. The number that appears next to the tab name is the number of requests currently in that status (and that appear on the tab). |
| Successful tab—All events in the request were processed successfully | |
| Failed tab—One or more events in the request were not processed successfully | |
| In processing tab—The requests for which processing is in progress | |
| Request details | |
| Date and time the request was submitted | |
| Request identifier—System-generated identifier for the request returned in a response | |
| Idempotency key | Vendor- or marketplace-assigned request identifier |
| Records processed | The number of events currently in the tab status (Successful, Failed, In Progress) and the total number of events in the request |
Failed event errors
The Error report page provides additional information about the events that failed to process successfully and why.
Failed event errors
| Error report pane |
|---|
| Error type tabs |
| System errors tab |
| Data errors tab |
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!