Analytics

Build Technical Reports

Validation of the request can be found in the description of TechnicalReportsRequest below.

SecurityapiKey
Request
Request Body schema: application/json
required

TechnicalReportsRequest

description
string (JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
name
string (JobName)

Name of a Job.

Example: "Process vendor data."
object (TechnicalReportsConfiguration)

Configures if and how technical reports are generated.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/technicalreports
Request samples
application/json
{
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "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-12-21T01:35:31Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "reportsConfiguration": {
    }
}

Poll Technical Reports

Poll Technical Reports by id. The id is returned by the build Technical Reports request.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

ID of the technical reports job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/technicalreports/{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-12-21T01:35:31Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "reportsConfiguration": {
    }
}