Partner get usage report status for all reports

The report creation Async API retrieves the status of all usage report requests and returns them in the response. The status report can be downloaded when it has completed, using the status report download URL included in the response.

API response records are sorted based on the date they were created, in ascending or descending order, depending on which order was passed as the sort parameter in the API request. If the sort parameter is not used in the request, the records are sorted in descending order, as this is the default.

Request

This example uses org123456789 as the realmId.

GET /usage/realms/org123456789/reports

Parameters

The parameters shown here are necessary for this request. For a complete list of parameters, see the Tutorials overview.

The usage search results are grouped into pages. A page is a set of usage records presented in a single view. The search results view can be customized by using offset and limit parameters. The offset determines the current page number on the view, and limit restricts search result counts to a specified number.

realmId
required 		string [ 5 .. 30 ] characters
Example: org123456789
Your partner organization ID.
limit integer [ 1 .. 100 ]
Default: 100
The number of records returned. The default and maximum is 100 records.
sort string
Default: "desc"
Enum: "asc" "desc"
The status for each report is returned in ascending or descending order depending on the date that the status request was created.
offset integer greater than or equal to 0
Default: 0
Offset page number.

Header parameters

X-Request-ID string
User-provided token that can be used to trace a request or a group of requests sent to the service.
X-Correlation-ID
required 		string
Auto-generated ID, which uniquely identifies the request, available in the response. When contacting the support with an inquiry regarding a specific request, provide the value of this header; This will help troubleshooting the issue.

Response HTTP 200

{
    "total": 18,
    "limit": 5,
    "count": 2,
    "nextOffset": 0,
    "lastOffset": 3,
    "items": 
[
{
    "id": "REPORT-100",
    "status": "inProgress",
    "created": "2022-03-01'T'00:00:00",
    "parameters": 
    {
        "realm": "org1879256",
        "startDate": "2022-03-01'T'00:00:00",
        "endDate": "2022-07-01'T'00:00:00",
        "emailId": "test_requester@here.com"
    }
},
{
    "id": "REPORT-145",
    "status": "completed",
    "resultHref": "https://usage/realms/org236848/report/REPORT-1475/output",
    "created": "2022-04-01'T'00:00:00",
    "parameters": 
    {
        "realm": "org1879256",
        "startDate": "2022-03-01'T'00:00:00",
        "endDate": "2022-07-01'T'00:00:00",
        "emailId": "test_requester@here.com"
    }
},
{
    "id": "REPORT-167",
    "status": "failed",
    "created": "2022-08-01'T'00:00:00",
    "parameters": 
            {
                "realm": "org1879586",
                "startDate": "2022-03-01'T'00:00:00",
                "endDate": "2022-07-01'T'00:00:00",
                "emailId": "test_requester2@here.com"
            }
        }
    ]
}

More information can be found in the Usage API Reference.

results matching ""

    No results matching ""