Audits

Audits provides access to events emitted upon each action taken in your tenant, providing detailed access to what's happening in your tenant.

Download OpenAPI spec

Endpoints

GET

/api/v1/audits
GET

/api/v1/audits/{id}
POST

/api/v1/audits/actions/fetch-consumption-app
GET

/api/v1/audits/archive
GET

/api/v1/audits/settings
GET

/api/v1/audits/sources
GET

/api/v1/audits/types

Retrieves list of events for subscribed services for your tenant. Stores events for 90 days, after which they can be accessed via /v1/audits/archive.

Facts

Rate limit

Special (1000 requests per minute)

Header Parameters

Authorization string

Required

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters

eventTime string

The start/end time interval formatted in ISO 8601 to search by eventTime. For example, "?eventTime=2021-07-14T18:41:15.00Z/2021-07-14T18:41:15.99Z".

pattern = "YYYY-MM-DDThh:mm:ss.sssZ/YYYY-MM-DDThh:mm:ss.sssZ"
eventType string

The case-sensitive string used to search by eventType. Retrieve a list of possible eventTypes with /v1/audits/types.
id string

The comma separated list of audit unique identifiers.
limit integer

The maximum number of resources to return for a request.

minimum = 1, maximum = 100, default = 10, format = int64, default = 10
next string

The cursor to the next page of resources. Provide either the next or prev cursor, but not both.
prev string

The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.
sort string

The property of a resource to sort on (default sort is -eventTime). The supported properties are source, eventType, and eventTime. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

default = "-eventTime"
source string

The case-sensitive string used to search by source. Retrieve a list of possible sources with /v1/audits/sources.
userId string

The case-sensitive string used to search by userId.

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  List of audit items.
  
  Show data properties
  
  id string
  
  The resource item's unique identifier.
  
  data object
  
  Additional information about the event's details. The structure depends on the type and version of the event.
  
  links object
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  source string
  
  The source of the event message, usually the producing service.
  
  userId string
  
  The ID of the user who performed the action that triggered the event.
  
  eventId string
  
  The event's unique identifier.
  
  tenantId string
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  eventTime string
  
  The RFC3339 datetime when the event happened.
  
  format = "date-time"
  
  eventType string
  
  The type of event that describes committed action.
  
  extensions object
  
  The availability of the properties depends on the event and the context it was triggered in.
  
  Show extensions properties
  
  actor object
  
  Specifies the entity performing the action on behalf of another party listed as triggering the action.
  
  Show actor properties
  
  sub string
  
  Opaque value identifying impersonating entity.
  
  subType string
  
  The type of the impersonating entity.
  
  ownerId string
  
  Id of the owner of the resource affected by the eventContext.
  
  spaceId string
  
  Id of the space related to the action performed on the eventContext.
  
  updates any
  
  Might be present if the action is of type "updated" and should contain information about the changes made to the resource.
  
  topLevelResourceId string
  
  If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource.
  
  contentType string
  
  The type that content is encoded in, always "application/json".
  
  eventTypeVersion string
  
  The version of the event type.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
  
  self object
  
  Show self properties
  
  href string

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/audits

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.getAudits({})

qlik audit ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "data": {},
      "links": {
        "self": {
          "href": "string"
        }
      },
      "source": "string",
      "userId": "string",
      "eventId": "string",
      "tenantId": "string",
      "eventTime": "2018-10-30T07:06:22Z",
      "eventType": "string",
      "extensions": {
        "actor": {
          "sub": "string",
          "subType": "string"
        },
        "ownerId": "string",
        "spaceId": "string",
        "topLevelResourceId": "string"
      },
      "contentType": "string",
      "eventTypeVersion": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns a specific audit events for the given event ID.

Facts

Rate limit

Special (1000 requests per minute)

Header Parameters

Authorization string

Required

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Path Parameters

id string

Required

The audit item's unique identifier.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The resource item's unique identifier.
- data object
  
  Additional information about the event's details. The structure depends on the type and version of the event.
- links object
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
- source string
  
  The source of the event message, usually the producing service.
- userId string
  
  The ID of the user who performed the action that triggered the event.
- eventId string
  
  The event's unique identifier.
- tenantId string
  
  The ID of the tenant that owns the item. This is populated using the JWT.
- eventTime string
  
  The RFC3339 datetime when the event happened.
  
  format = "date-time"
- eventType string
  
  The type of event that describes committed action.
- extensions object
  
  The availability of the properties depends on the event and the context it was triggered in.
  
  Show extensions properties
  
  actor object
  
  Specifies the entity performing the action on behalf of another party listed as triggering the action.
  
  Show actor properties
  
  sub string
  
  Opaque value identifying impersonating entity.
  
  subType string
  
  The type of the impersonating entity.
  
  ownerId string
  
  Id of the owner of the resource affected by the eventContext.
  
  spaceId string
  
  Id of the space related to the action performed on the eventContext.
  
  updates any
  
  Might be present if the action is of type "updated" and should contain information about the changes made to the resource.
  
  topLevelResourceId string
  
  If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource.
- contentType string
  
  The type that content is encoded in, always "application/json".
- eventTypeVersion string
  
  The version of the event type.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/audits/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.getAudit('string')

qlik audit get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "data": {},
  "links": {
    "self": {
      "href": "string"
    }
  },
  "source": "string",
  "userId": "string",
  "eventId": "string",
  "tenantId": "string",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventType": "string",
  "extensions": {
    "actor": {
      "sub": "string",
      "subType": "string"
    },
    "ownerId": "string",
    "spaceId": "string",
    "topLevelResourceId": "string"
  },
  "contentType": "string",
  "eventTypeVersion": "string"
}

Returns a Qlik Sense application (QVF file) containing usage data for the tenant's subscription. Requesting user must be assigned the TenantAdmin role. Available only for Capacity subscriptions. Consumption report is updated once per day.

Facts

Rate limit

Tier 2 (100 requests per minute)

Header Parameters

Authorization string

Required

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses

200

OK Response

*/* string

format = "binary"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/audits/actions/fetch-consumption-app

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.fetchConsumptionAppAudits()

qlik audit fetch-consumption-app

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits/actions/fetch-consumption-app" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

"string"

Retrieves audit events from long-term storage. Returns all archived audit events for the specified date and tenant, formatted as a JSON array. Archived events are retained for the full lifetime of the tenant, and are not removed or size-limited.

Facts

Rate limit

Special (1000 requests per minute)

Header Parameters

Authorization string

Required

The JWT is used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters

date string

Required

Date to be used as filter and criteria during extraction.

pattern = "YYYY-MM-DD", format = "date"

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  List of archived events. The structure of the events depend on their type and version.
  
  Show data properties
  
  data object
  
  Additional information about the event's details. The structure depends on the type and version of the event.
  
  source string
  
  The source of the event message, usually the producing service.
  
  userId string
  
  The ID of the user who performed the action that triggered the event.
  
  eventId string
  
  The event's unique identifier.
  
  tenantId string
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  eventTime string
  
  The RFC3339 datetime when the event happened.
  
  format = "date-time"
  
  eventType string
  
  The type of event that describes committed action.
  
  extensions object
  
  The availability of the properties depends on the event and the context it was triggered in.
  
  Show extensions properties
  
  actor object
  
  Specifies the entity performing the action on behalf of another party listed as triggering the action.
  
  Show actor properties
  
  sub string
  
  Opaque value identifying impersonating entity.
  
  subType string
  
  The type of the impersonating entity.
  
  ownerId string
  
  Id of the owner of the resource affected by the eventContext.
  
  spaceId string
  
  Id of the space related to the action performed on the eventContext.
  
  updates any
  
  Might be present if the action is of type "updated" and should contain information about the changes made to the resource.
  
  topLevelResourceId string
  
  If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource.
  
  contentType string
  
  The type that content is encoded in, always "application/json".
  
  eventTypeVersion string
  
  The version of the event type.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not Found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/audits/archive

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.getArchivedAudits({
  date: '2020-02-20',
})

qlik audit archive \
  --date '2020-02-20'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits/archive" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "data": {},
      "source": "string",
      "userId": "string",
      "eventId": "string",
      "tenantId": "string",
      "eventTime": "2018-10-30T07:06:22Z",
      "eventType": "string",
      "extensions": {
        "actor": {
          "sub": "string",
          "subType": "string"
        },
        "ownerId": "string",
        "spaceId": "string",
        "topLevelResourceId": "string"
      },
      "contentType": "string",
      "eventTypeVersion": "string"
    }
  ]
}

Returns the server configuration options. It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.

Facts

Rate limit

Special (1000 requests per minute)

Header Parameters

Authorization string

Required

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses

200

OK Response

application/json object
Show application/json properties
- data object
  
  Server configuration options.
  
  Show data properties
  
  EventTTL integer
  
  The events TTL in seconds.
  
  ArchiveEnabled boolean
  
  Is Long Term Storage archiving enabled?.

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/audits/settings

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.getAuditsSettings()

qlik audit settings

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits/settings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "EventTTL": 42,
    "ArchiveEnabled": true
  }
}

Finds and returns the list of possible event sources for this tenant.

Facts

Rate limit

Special (1000 requests per minute)

Header Parameters

Authorization string

Required

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses

200

OK Response

application/json object
Show application/json properties
- data array of strings
  
  List of requested resources.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
  
  self object
  
  Show self properties
  
  href string

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/audits/sources

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.getAuditSources()

qlik audit sources

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits/sources" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    "string"
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns the list of possible event types for this tenant.

Facts

Rate limit

Special (1000 requests per minute)

Header Parameters

Authorization string

Required

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses

200

OK Response

application/json object
Show application/json properties
- data array of strings
  
  List of requested resources.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
  
  self object
  
  Show self properties
  
  href string

401

Not authorized.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/audits/types

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.audits.getAuditTypes()

qlik audit types

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/audits/types" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    "string"
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Audits

Endpoints

List recent audit events

Facts

Header Parameters

Query Parameters

Responses

200

400

401

500

Example Response

Get a specific audit event

Facts

Header Parameters

Path Parameters

Responses

200

400

401

404

500

Example Response

Export consumption app

Facts

Header Parameters

Responses

200

400

401

403

404

500

Example Response

List archived audit events

Facts

Header Parameters

Query Parameters

Responses

200

400

401

404

500

Example Response

Get server configuration options

Facts

Header Parameters

Responses

200

401

500

Example Response

List possible event sources

Facts

Header Parameters

Responses

200

401

500

Example Response

List possible event types

Facts

Header Parameters

Responses

200

401

500

Example Response