Skip to content

Consumption

Endpoints

Skip to section
GET/v1/consumption/executions

Retrieves the list of executions on an specific tenant

manage

Lists of execution records by tenant.

Facts GET /v1/consumption/executions

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/consumption/executions

actionToBlock
string

No description

customerFacing
boolean

No description

filter
string

The filter for finding entries.

limit
default=20, minimum=1, maximum=200
integer

Limit the returned result set

offset
integer

Offset for pagination - how many elements to skip

page
string

The cursor to the page of data.

periodsToInclude
Array<string>

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

Enum:

current

previous

sort
Array<string>

No description

Enum:

periodstart

-periodstart

+periodstart

periodend

-periodend

+periodend

Responses GET /v1/consumption/executions

200
application/json
ExecutionsByTenantList

The executions list has been successfully returned

404
application/json

Resource does not exist.

500
application/json

Internal server error.

default
application/json

Error response.

GET/v1/consumption/executions

curl "https://your-tenant.us.qlikcloud.com/api/v1/consumption/executions" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/consumption/executions

{
  "undefined": {
    "totalCount": 1,
    "currentPageCount": 1,
    "data": [
      {
        "unit": "string",
        "scope": [
          "tenant",
          "resourceType"
        ],
        "userId": "string",
        "blocked": true,
        "overage": true,
        "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": true,
        "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": true,
    "closeToOverage": true,
    "globalUsageAvailable": true
  }
}

Enforcement

object

Properties

resourceType
string

Resource type to be blocked

actionToBlock
string

Resource action type to be blocked

ErrorResponse

object

Properties

errors

No description

traceId
string

No description

ExecutionResponse

object

Properties

unit
filterable
string

Unit of measurement for the resource consumption

scope
Array<string>

No description

userId
filterable
string

The user id.

blocked
default=false
filterable
boolean<boolean>

No description

overage
default=false
filterable
boolean<boolean>

No description

segments
Array<object>

No description

taskName
filterable
string

The resource task name.

tenantId
filterable
string

The tenant id.

periodEnd
filterable
string

The end of the associated period.

localUsage
filterable
number<number>

The local usage.

periodType
filterable
string

No description

Enum:

day

month

year

resourceId
filterable
string

The resource id.

updateTime
filterable
string

The RFC3339 timestamp when the resource was updated.

enforcement
filterable

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

globalUsage
filterable
number<number>

The global usage.

periodStart
filterable
string

The start of the associated period.

resourceType
filterable
string

The resource type.

Enum:

app

automations

space

data.volume.consumption

scopeMapping
filterable
string

The map to the resource scope.

capacityLimit
filterable
number

The capacity limit.

closeToOverage
default=false
filterable
boolean<boolean>

No description

customerFacing
filterable
boolean

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

guardrailLimit
filterable
number

The guardrail limit.

resourceAction
filterable
string

The resource action.

Enum:

report.generated

reload

scheduledReload

executed

aggregation

import

updated

deployed

taskDescription
filterable
string

The resource task description.

blockedEventTime
filterable
string

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

overageEventTime
filterable
string

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

consumptionReportId
filterable
string<uid>

The id of the consumption report

ExecutionsByTenantList

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

data

No description

links

No description

overage
boolean

No description

closeToOverage
boolean

No description

globalUsageAvailable
boolean

No description

object

Properties

next

No description

prev

No description

self

Object with Href to a particular element or set of elements

Page

object

Properties

href
string

URL to particular set of elements

type
string

Page type, can be next or prev

Enum:

prev

next

token
string

Page unique token

Self

object

Object with Href to a particular element or set of elements

Properties

href
string

No description

SingleErrorResponse

object

Properties

code
string

Error code specific to usage-tracker.

meta
object

meta properties for an error.

title
string

Error title.

detail
string

Error cause.

StandardListResponseProps

object

properties that should be added to every list response

Properties

totalCount
required
integer

total count of entries in the collection as a whole

currentPageCount
required
integer

count of entries on the currently shown page

v0.809.0
Was this page helpful?