Get an entitlements consumption report

Returns a consumption report for the given parameters, as a ZIP file containing the following files:

• A CSV file with the requests report per day
• A file with a signature for the requests report per day
• A CSV file with the max records per day
• A file with a signature for the max records report per day
• A CSV file with the events occurred for requests
• A file with a signature for the events occurred for requests
• A CSV file with the events occurred for records
• A file with a signature for the events occurred for records

This endpoint accepts the following combinations of parameters:

• If no parameters provided, the current contract period is calculated, then data is returned based on that period.

• If startDate and endDate are provided, then the data is returned based on that date range.

• If licenseId and periodIndex are provided, then the data is returned based on that specific period data.

• Other combination of parameters result in an error.

GET /entitlements/report

Error

A valid request URL is required to generate request examples

200

[
  {}
]

Query Parameters

startDate · string · default: ""

The results start date, formatted as yyyy-MM-dd.

endDate · string · default: ""

The results end date, formatted as yyyy-MM-dd.

licenseId · string · default: ""

The entitlements license ID. Use /apps-manager/entitlements/periods to get license IDs.

periodIndex · string · default: ""

The entitlement period index in the license. Use /apps-manager/entitlements/periods to get period indices.

Response

200 - application/octet-stream

OK