Analytics

Build Reference Data Reports

Requests the building of reference data reports. The reports are built asynchronously. The response contains the ID of the report. The report can be polled using the ID.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

lookupJobId
string (LookupJobId)
Deprecated

Use lookupJobId inside reportsConfiguration.lookup.jobId. When provided value is copied to reportsConfiguration.lookup.jobId.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
object (ReferenceDataReportsConfiguration)

Configures if and how Reference Data reports are generated.

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedatareports
Request samples
application/json
{
  • "lookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "reportsConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2024-04-24T13:32:12Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "lookup": {
    },
  • "dnb": {
    }
}

Poll Reference Data Reports

Polls the status of a reference data report. The report is built asynchronously. The response contains the ID of the report. The report can be polled using the ID.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the compliance reports.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/referencedatareports/{id}
Request samples 
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2024-04-24T13:32:12Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "lookup": {
    },
  • "dnb": {
    }
}