Entitlement consumption

Tracks usage of entitled features in a tenant, used for the consumption metrics in the admin console in a tenant.

Download specification

Retrieves the list of executions on an specific tenant

Lists of execution records by tenant.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Query Parameters

  • actionToBlockstring
  • filterstring

    The advanced filtering to use for the query. Refer to RFC 7644 for the syntax.

    example taskName eq "automation_run_ended" or taskName eq "report_triggered" or or taskName eq "dataVolumeAggregated"

    The following fields are supported: scope, resourcetype, resourceaction, resourceid, capacitylimit, localusage, globalusage, overage, blocked, periodstart, periodend, consumptionreportid, blockedeventtime, overageeventtime, taskname, taskdescription, userid, tenantid, customerfacing, actiontoblock

  • limitinteger

    Limit the returned result set

  • offsetinteger

    Offset for pagination - how many elements to skip

  • pagestring

    The cursor to the page of data.

  • periodsToIncludearray of strings

    Specifies which periods to include regardless of the period type, start and end specified

    Values may be any of: "current""previous"

  • sortarray of strings

    Values may be any of: "periodstart""-periodstart""+periodstart""periodend""-periodend""+periodend"

Responses

200

application/json

The executions list has been successfully returned

  • application/jsonobject
    Show application/json properties
    • totalCountinteger
      Required

      total count of entries in the collection as a whole

    • currentPageCountinteger
      Required

      count of entries on the currently shown page

    • dataarray of objects
      Show data properties
      • unitstring

        Unit of measurement for the resource consumption

      • scopearray of strings

        Values may be any of: "user""tenant""resourceId""resourceType""resourceAction"

      • userIdstring

        The user id.

      • blockedboolean
      • overageboolean
      • segmentsarray of objects
      • taskNamestring

        The resource task name.

      • tenantIdstring

        The tenant id.

      • periodEndstring

        The end of the associated period.

      • localUsagenumber

        The local usage.

      • periodTypestring

        Can be one of: "day""month""year""""fixed""minute"

      • resourceIdstring

        The resource id.

      • updateTimestring

        The RFC3339 timestamp when the resource was updated.

      • enforcementarray of objects

        Contains a list of resources that are blocked when quota for this is reached.

        Show enforcement properties
        • resourceTypestring

          Resource type to be blocked

        • actionToBlockstring

          Resource action type to be blocked

      • globalUsagenumber

        The global usage.

      • periodStartstring

        The start of the associated period.

      • resourceTypestring

        The resource type.

        Can be one of: "app""automations""space""data.volume.consumption"

      • scopeMappingstring

        The map to the resource scope.

      • capacityLimitnumber

        The capacity limit.

      • closeToOverageboolean
      • customerFacingboolean

        The field to determine if a resource should be visible on the client.

      • guardrailLimitnumber

        The guardrail limit.

      • resourceActionstring

        The resource action.

        Can be one of: "report.generated""reload""scheduledReload""executed""aggregation""import""updated""deployed""3rd_party_executed""standard_executed"

      • taskDescriptionstring

        The resource task description.

      • blockedEventTimestring

        RFC3339 timestamp when a block event was last emitted for this execution.

      • overageEventTimestring

        RFC3339 timestamp when a overage event was last emitted for this execution.

      • consumptionReportIdstring

        The id of the consumption report

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • prevobject
        Show prev properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • overageboolean
    • closeToOverageboolean
    • globalUsageAvailableboolean

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to usage-tracker.

      • metaobject

        meta properties for an error.

      • titlestring

        Error title.

      • detailstring

        Error cause.

    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to usage-tracker.

      • metaobject

        meta properties for an error.

      • titlestring

        Error title.

      • detailstring

        Error cause.

    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to usage-tracker.

      • metaobject

        meta properties for an error.

      • titlestring

        Error title.

      • detailstring

        Error cause.

    • traceIdstring
GET /v1/consumption/executions
curl "https://your-tenant.us.qlikcloud.com/api/v1/consumption/executions" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/consumption/executions',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"totalCount": 1,
"currentPageCount": 1,
"data": [
{
"unit": "string",
"scope": [
"tenant",
"resourceType"
],
"userId": "string",
"blocked": false,
"overage": false,
"segments": [
{
"QDI": 10
},
{
"APP": 10
}
],
"taskName": "task_name",
"tenantId": "string",
"periodEnd": "2022-01-31",
"localUsage": 20,
"periodType": "month",
"resourceId": "228ac375-086e-4652-b9c0-fa8689bac75f",
"updateTime": "string",
"enforcement": [
{
"resourceType": "string",
"actionToBlock": "string"
}
],
"globalUsage": 29,
"periodStart": "2022-01-01",
"resourceType": "app",
"scopeMapping": "string",
"capacityLimit": 50,
"closeToOverage": false,
"customerFacing": true,
"guardrailLimit": 20,
"resourceAction": "reload",
"taskDescription": "some description",
"blockedEventTime": "string",
"overageEventTime": "string",
"consumptionReportId": "01xQ1chLoHkOikyzUGcHJquteNrAfketW"
}
],
"links": {
"next": {
"href": "http://localhost:8787/v1/items?limit=12",
"type": "next",
"token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
},
"prev": {
"href": "http://localhost:8787/v1/items?limit=12",
"type": "next",
"token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
},
"self": {
"href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
}
},
"overage": false,
"closeToOverage": false,
"globalUsageAvailable": true
}