Versions Compared

Old Version 2

changes.mady.by.user Unknown User (ppieprzyk)

Saved on

compared with

New Version 3

changes.mady.by.user Unknown User (ppieprzyk)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
GET /api/v1/report/usage-history/feature/${featureId}/${returnType}?sd=${startDate}&ed={endDate}&granularity=${granularity}$(additional parameters, as needed)

 where:

 - $ indicates a variable value that you can replace with an appropriate value, as needed

 - the possible parameters are as follows:

ParameterRequiredTypeDescription
${featureId}YesintegerSpecifies feature-specific parameters.
${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf.
sdYesstringSpecifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-20.
edYesstringSpecifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-27.
granularityYesinteger

Specifies granularity of the returned data; Can be one of the following:

  • quarter - 2
  • month - 3
  • week - 4
  • day - 5
  • hour - 6
rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or Excel.
filterNojson/string
 

Applies filtering license usage data on all fields. To filter your data, use the following format:

Code Block
languagejs
[{"value": intOrString, "field": "${lud | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft}"}]


fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
{"lud": "1", "lumin": "1", "lua": "1", "lumax": "1", "lbmin": "1", "lbmax": "1", "ldtc": "1", "hu": "1", "ft": "1"}


where number "1" indicates that a specific field is visible.

Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostringSpecifies the field by which you want to order your data records. The field name can be one of the following: lud, lumin, lua, lumax, lbmin, lbmax, ldtc, hu, ft.
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.