Aggregated Data

Endpoints to submit your own usage data and track its writing

Submit aggregated data

post

Uploads aggregated data required to calculate Popularity Score for assets.

There are 2 different ways to provide keys and type (see examples).

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Bodyobject · AggregatedData[]

application/json

toDatestring · date-timeOptional

End date of the 30-day window used for popularity calculation

Example: 2025-01-30T00:00:00Z

timePeriodstringOptionalExample: 30_DAYS

queryCountintegerOptionalExample: 1203

distinctUsersintegerOptional

Number of distinct users that have queried the asset

Example: 14

Responses

202

Submits a batch of data to be written (asynchronous endpoint).

application/json

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/aggregatedData/submit

HTTPcURLJavaScriptPython

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

[
  {
    "assetLocator": {
      "type": "RDBMS",
      "product": "postgres",
      "keys": [
        "system_name",
        "database_name",
        "schema_name",
        "table_name",
        "column_name"
      ]
    },
    "toDate": "2025-01-30T00:00:00Z",
    "timePeriod": "30_DAYS",
    "queryCount": 1203,
    "distinctUsers": 14
  }
]

HierarchicalAssetId

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-07-14T14:30:20.452Z",
  "startDate": "2026-07-14T14:30:20.452Z",
  "endDate": "2026-07-14T14:30:20.452Z",
  "status": "Waiting",
  "report": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Find jobs

get

Returns a list of jobs related to the data aggregation process.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

statusstring · enumOptional

The status of the jobs to retrieve.

If not set, this filter will not be applied and everything will be returned.

Possible values:

offsetinteger · int32 · max: 2147483647Optional

The index of the first result to retrieve.

If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 0) will be used. The maximum value for this parameter is 500.

Default: 10

Responses

200

List of jobs successfully retrieved. The report of the job will not be present.

application/json

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

get/aggregatedData/jobs

HTTPcURLJavaScriptPython

GET /rest/dataUsage/v1/aggregatedData/jobs HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2026-07-14T14:30:20.452Z",
      "startDate": "2026-07-14T14:30:20.452Z",
      "endDate": "2026-07-14T14:30:20.452Z",
      "status": "Waiting",
      "report": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Find job by id

get

Returns a job related to the data aggregation process by its ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The job ID to retrieve.

Example: b00db37d-282e-4ea9-86d4-5881660ba46a

Responses

200

Job successfully retrieved.

application/json

idstring · uuidRequired

createdBystring · uuidRequired

createdOnstring · date-timeRequired

startDatestring · date-timeRequired

endDatestring · date-timeOptional

statusstring · enumRequiredPossible values:

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

get/aggregatedData/jobs/{id}

HTTPcURLJavaScriptPython

GET /rest/dataUsage/v1/aggregatedData/jobs/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-07-14T14:30:20.452Z",
  "startDate": "2026-07-14T14:30:20.452Z",
  "endDate": "2026-07-14T14:30:20.452Z",
  "status": "Waiting",
  "report": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}