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
typestring(Type)

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

dataClinicEnabledOnlyboolean(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[].​domainstring(Domain)required

The domain the artifact is assigned to.

Example: "validation"
values[].​descriptionstring(Description)required

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[].​descriptionstring(Description)required
values[].​schema.​fields[].​groupIdstring(Groupid)
values[].​schema.​filtersArray of objects(Filters)
values[].​schema.​groupsArray of objects(Groups)
values[].​featuresArray of strings(Features)

List of reporting features supported.

Items Enum"SHOW_MATCHING_EXPLANATION""SHOW_RETRACTED_LINKS""SHOW_COVER_PAGE""SHOW_ADDITIONAL_ATTRIBUTES"
values[].​quickFiltersArray of strings(Quickfilters)

List of quick filters supported.

Items Enum"OPEN_CASES_ONLY""ONLY_WITH_DECISIONS""ONLY_WITH_CONFIRMED_CASES""ONLY_WITH_CLEARED_CASES"
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"
domainstring(Domain)required

The domain the artifact is assigned to.

Example: "validation"
descriptionstring(Description)required

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[].​descriptionstring(Description)required
schema.​fields[].​groupIdstring(Groupid)
schema.​filtersArray of objects(Filters)
schema.​groupsArray of objects(Groups)
featuresArray of strings(Features)

List of reporting features supported.

Items Enum"SHOW_MATCHING_EXPLANATION""SHOW_RETRACTED_LINKS""SHOW_COVER_PAGE""SHOW_ADDITIONAL_ATTRIBUTES"
quickFiltersArray of strings(Quickfilters)

List of quick filters supported.

Items Enum"OPEN_CASES_ONLY""ONLY_WITH_DECISIONS""ONLY_WITH_CONFIRMED_CASES""ONLY_WITH_CLEARED_CASES"
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"
  ],
  "quickFilters": [
    "OPEN_CASES_ONLY"
  ]
}

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 objects(Values)
Response
application/json
{
  "page": 1,
  "pageSize": 2,
  "total": 2,
  "values": [
    { … }
  ]
}