Popularity

Endpoints for reading popularity/usage data

Find Popularity

post

Returns latest information about the popularity and usage for assets

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Bodyobject · AssetLocator[]

application/json

Describes where to search for a specific Catalog asset. It might match more than one result.

It also specifies the type of the datastore of origin and its commercial name

typestringRequired

Identifier for the datastore type of origin.

Example: RDBMS

productstringOptional

Commercial name of the datastore of origin.

keysstring[] · min: 1Required

Ordered list of names for each member of the hierarchy of an item.

Responses

200

List of popularity scores

application/json

errorMessagestringOptional

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

post/findPopularity

HTTPcURLJavaScriptPython

POST /rest/dataUsage/v1/findPopularity HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 119

[
  {
    "type": "RDBMS",
    "product": "postgres",
    "keys": [
      "system_name",
      "database_name",
      "schema_name",
      "table_name",
      "column_name"
    ]
  }
]

HierarchicalAssetId

[
  {
    "assetLocator": [
      {
        "type": "RDBMS",
        "product": "text",
        "keys": [
          "text"
        ]
      }
    ],
    "popularity": {
      "score": "4 - Very high",
      "calculatedAt": "2020-01-01T00:00:00Z"
    },
    "usageData": {
      "fromDate": "2020-01-01T00:00:00Z",
      "toDate": "2020-12-01T00:00:00Z",
      "queryCount": 1200,
      "distinctUsers": 14
    },
    "errorMessage": "text"
  }
]