Skip to content

CDQ Analytics API (1.0.0)

Service allows to generate and obtain various reporting artifacts such as excel reports and charts in a unified, flexible and secure way

Download OpenAPI description
api-v1.json
api-v1.yaml
Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/

Production SOAP

https://analytics-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/api/rest/soap/v1/

Production

https://analytics-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/api/rest/

Job

Operations for creating and querying reporting jobs.

Operations

Artifact

Operations for querying artifact related metadata.

Operations

List Artifacts

Request

Returns a list of ArtifactInfo objects.

Security
APIKeyHeader or authorization
Query
typeType (string) or Type (null)(Type)

Type of the artifact (currently only report artifacts are supported).

Any of:

Type of the artifact (currently only report artifacts are supported).

string(Type)

Type of the artifact (currently only report artifacts are supported).

dataClinicEnabledOnlyDataclinicenabledonly (boolean) or Dataclinicenabledonly (null)(Dataclinicenabledonly)

Flag controlling whether the response should include only Data Clinic standard reports.

Default true
Any of:

Flag controlling whether the response should include only Data Clinic standard reports.

boolean(Dataclinicenabledonly)

Flag controlling whether the response should include only Data Clinic standard reports.

Default true
pageinteger(Page)
Default 0
pageSizeinteger(Pagesize)> 0
Default 100
curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/artifacts?type=string&dataClinicEnabledOnly=true&page=0&pageSize=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
pageinteger(Page)required

The number of requested page. Starts from 0.

Example: 0
pageSizeinteger(Pagesize)required

The number or items to include in a single page. If the resulting number of items will be lower than the input, page size will show the number of returned items.

Example: 17
totalinteger(Total)required

Describes the number of all jobs available for the user.

Example: 150
valuesArray of objects(Values)required
values[].​idstring(Id)required

Id of a reporting artifact.

Example: "data_defects_report"
values[].​labelstring(Label)required

Human friendly name of the artifact.

values[].​typeOfstring(Typeof)required

Base type of the artifact.

Example: "Report"
values[].​domainDomain (string) or Domain (null)(Domain)required

The domain the artifact is assigned to.

Example: "validation"
Any of:

The domain the artifact is assigned to.

string(Domain)

The domain the artifact is assigned to.

values[].​descriptionDescription (string) or Description (null)(Description)required

Detailed description of the artifact.

Any of:

Detailed description of the artifact.

string(Description)

Detailed description of the artifact.

values[].​schemaobject(Schema)required
values[].​schema.​namestring(Name)required
values[].​schema.​fieldsArray of objects(Fields)required
values[].​schema.​fields[].​idstring(Id)required
values[].​schema.​fields[].​labelstring(Label)required
values[].​schema.​fields[].​typestring(Type)required
values[].​schema.​fields[].​descriptionDescription (string) or Description (null)(Description)required
Any of:
string(Description)
values[].​schema.​fields[].​groupIdGroupid (string) or Groupid (null)(Groupid)
Any of:
string(Groupid)
values[].​schema.​filtersArray of Filters (objects) or Filters (null)(Filters)
Any of:
values[].​schema.​groupsArray of Groups (objects) or Groups (null)(Groups)
Any of:
values[].​featuresArray of Features (strings) or Features (null)(Features)

List of reporting features supported.

Any of:

List of reporting features supported.

Response
application/json
{
  "page": 0,
  "pageSize": 17,
  "total": 150,
  "values": [
    { … }
  ]
}

Get Artifact Info

Request

Returns a single ArtifactInfo object.

Security
APIKeyHeader or authorization
Path
idstring(Id)required

String identifier of the requested artifact.

curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/artifacts/{id}/info' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
idstring(Id)required

Id of a reporting artifact.

Example: "data_defects_report"
labelstring(Label)required

Human friendly name of the artifact.

typeOfstring(Typeof)required

Base type of the artifact.

Example: "Report"
domainDomain (string) or Domain (null)(Domain)required

The domain the artifact is assigned to.

Example: "validation"
Any of:

The domain the artifact is assigned to.

string(Domain)

The domain the artifact is assigned to.

descriptionDescription (string) or Description (null)(Description)required

Detailed description of the artifact.

Any of:

Detailed description of the artifact.

string(Description)

Detailed description of the artifact.

schemaobject(Schema)required
schema.​namestring(Name)required
schema.​fieldsArray of objects(Fields)required
schema.​fields[].​idstring(Id)required
schema.​fields[].​labelstring(Label)required
schema.​fields[].​typestring(Type)required
schema.​fields[].​descriptionDescription (string) or Description (null)(Description)required
Any of:
string(Description)
schema.​fields[].​groupIdGroupid (string) or Groupid (null)(Groupid)
Any of:
string(Groupid)
schema.​filtersArray of Filters (objects) or Filters (null)(Filters)
Any of:
schema.​groupsArray of Groups (objects) or Groups (null)(Groups)
Any of:
featuresArray of Features (strings) or Features (null)(Features)

List of reporting features supported.

Any of:

List of reporting features supported.

Response
application/json
{
  "id": "data_defects_report",
  "label": "string",
  "typeOf": "Report",
  "domain": "validation",
  "description": "string",
  "schema": {
    "name": "string",
    "fields": [ … ],
    "filters": [ … ],
    "groups": [ … ]
  },
  "features": [
    "SHOW_MATCHING_EXPLANATION"
  ]
}

Get Artifact File Formats

Request

Returns a list of ArtifactFileFormat objects. Each object's id property value can be used as the input for the format parameter of the /jobs/create request body.

Security
APIKeyHeader or authorization
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/artifacts/fileFormats \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
pageinteger(Page)
Default 1
pageSizeinteger(Pagesize)
Default 2
totalinteger(Total)
Default 2
valuesArray of Values (objects) or Values (null)(Values)
Default [{"id":"xlsx","label":"Excel"},{"id":"csv","label":"CSV"}]
Any of:
Response
application/json
{
  "page": 1,
  "pageSize": 2,
  "total": 2,
  "values": [
    { … },
    { … }
  ]
}