Ontology
Lists ontology concepts for the workspace. Paginated (limit, cursor). Optional query param sourceId filters to concepts that have a field mapping for that source. Read from platform MongoDB (ontologyConcepts collection). Concepts are created by ontology extraction on sources or manually via POST.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123Query parameters
limitnumber · min: 1 · max: 1000OptionalExample:
Page size (1-1000, default 50).
1cursorstringOptionalExample:
Opaque cursor from a previous response's pagination.cursor.
examplesourceIdstringOptionalExample:
Restrict to concepts mapped to this source.
123Responses
200
Successful response
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
get/api/v1/workspaces/{wsId}/ontology/concepts
GET /api/v1/workspaces/{wsId}/ontology/concepts HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"id": "text",
"organisationId": "text",
"workspaceId": "text",
"name": "text",
"description": null,
"conceptClassification": "identifier",
"anchorConceptLinks": [
"text"
],
"schemaFieldName": "text",
"schemaType": "None",
"schemaSubtype": "Integer",
"metadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lockedMetadataFields": [
"text"
],
"detectedMetadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"fieldMappings": [
{
"sourceId": "text",
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null
}
],
"derivedInfo": {
"formula": null,
"formulaBlocks": {
"nodeId": "text",
"kind": "text",
"blockType": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"derivedType": "manual",
"kind": "op",
"source": "user",
"sourceColumns": [
"text"
],
"expression": null,
"r2": null,
"isDeterministic": null,
"lag": null,
"cumulativeDirection": null,
"sourceDataViewId": null,
"operationLineage": {
"opType": "SQL_QUERY",
"opId": "text",
"parentColumns": [
"text"
],
"parentConceptIds": [
"text"
]
},
"viewSnapshot": "[Circular Reference]",
"lineageHash": null,
"sourceJoinConfig": {
"joinType": "left",
"strategy": null
}
},
"conceptKind": "standard",
"metricSql": null,
"relationshipRules": [
{
"ruleType": "conditional_values",
"sourceVariable": "text",
"condition": {
"variable": "text",
"operator": "eq",
"value": 1
},
"allowedValues": [
"text"
],
"minValue": null,
"maxValue": null,
"confidence": 1,
"support": 0,
"strength": "hard",
"violationRate": null,
"source": null,
"cycle": null
}
],
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source",
"trustTier": "exploratory",
"ontologyRef": {
"ontologyId": "text",
"ontologyVersion": "text",
"canonicalId": "text",
"installScope": {
"conceptCanonicalIds": [
"text"
],
"filters": [
{
"conceptRef": "text",
"values": [
"text"
],
"start": null,
"end": null
}
]
}
},
"layerIds": [
"text"
],
"tags": [
"text"
],
"valueMappings": [
{
"canonicalValue": "text",
"aliases": [
"text"
]
}
],
"lockedConceptFields": [
"text"
],
"detectedConceptStructure": {
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source"
},
"lastEditedBy": null,
"lastEditedAt": null,
"lineageDrift": null,
"editVersion": 0,
"createdAt": "text",
"updatedAt": "text"
}
],
"pagination": {
"cursor": "text",
"hasMore": true,
"total": 1
}
}Creates a new ontology concept. Body: name, schemaFieldName, schemaType, optional metadata, description, conceptClassification, fieldMappings, anchorConceptLinks, derivedInfo, suggestedRole. Stored in platform MongoDB only; no data-service call. Used for manual curation or when auto-extraction is not used.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123Body
namestringRequired
schemaFieldNamestringRequired
schemaTypestring · enumRequiredPossible values:
schemaSubtypestring · enum · nullableOptionalPossible values:
descriptionstring · nullableOptional
conceptClassificationstring · enum · nullableOptionalPossible values:
anchorConceptLinksstring[]OptionalDefault:
[]conceptKindstring · enumOptionalDefault:
standardPossible values: metricSqlstring · nullableOptional
suggestedRolestring · enum · nullableOptionalPossible values:
Responses
201
Successful response
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
422
Unprocessable Entity
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
post/api/v1/workspaces/{wsId}/ontology/concepts
POST /api/v1/workspaces/{wsId}/ontology/concepts HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5049
{
"name": "text",
"schemaFieldName": "text",
"schemaType": "None",
"schemaSubtype": "Integer",
"metadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"description": null,
"conceptClassification": "identifier",
"anchorConceptLinks": [
"text"
],
"derivedInfo": {
"formula": null,
"formulaBlocks": {
"nodeId": "text",
"kind": "text",
"blockType": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"derivedType": "manual",
"kind": "op",
"source": "user",
"sourceColumns": [
"text"
],
"expression": null,
"r2": null,
"isDeterministic": null,
"lag": null,
"cumulativeDirection": null,
"sourceDataViewId": null,
"operationLineage": {
"opType": "SQL_QUERY",
"opId": "text",
"parentColumns": [
"text"
],
"parentConceptIds": [
"text"
]
},
"viewSnapshot": {
"sources": [
{
"id": "text",
"type": "text",
"name": null,
"conceptIds": [
"text"
],
"conceptVersions": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"version": {
"kind": "text"
}
}
],
"operations": [
"[Circular Reference]"
],
"outputColumn": "text"
},
"lineageHash": null,
"sourceJoinConfig": {
"joinType": "left",
"strategy": null
}
},
"conceptKind": "standard",
"metricSql": null,
"suggestedRole": "source",
"fieldMappings": [
{
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null,
"sourceId": "text"
}
]
}{
"data": {
"id": "text",
"organisationId": "text",
"workspaceId": "text",
"name": "text",
"description": null,
"conceptClassification": "identifier",
"anchorConceptLinks": [
"text"
],
"schemaFieldName": "text",
"schemaType": "None",
"schemaSubtype": "Integer",
"metadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lockedMetadataFields": [
"text"
],
"detectedMetadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"fieldMappings": [
{
"sourceId": "text",
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null
}
],
"derivedInfo": {
"formula": null,
"formulaBlocks": {
"nodeId": "text",
"kind": "text",
"blockType": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"derivedType": "manual",
"kind": "op",
"source": "user",
"sourceColumns": [
"text"
],
"expression": null,
"r2": null,
"isDeterministic": null,
"lag": null,
"cumulativeDirection": null,
"sourceDataViewId": null,
"operationLineage": {
"opType": "SQL_QUERY",
"opId": "text",
"parentColumns": [
"text"
],
"parentConceptIds": [
"text"
]
},
"viewSnapshot": {
"sources": [
{
"id": "text",
"type": "text",
"name": null,
"conceptIds": [
"text"
],
"conceptVersions": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"version": {
"kind": "text"
}
}
],
"operations": "[Circular Reference]",
"outputColumn": "text"
},
"lineageHash": null,
"sourceJoinConfig": {
"joinType": "left",
"strategy": null
}
},
"conceptKind": "standard",
"metricSql": null,
"relationshipRules": [
{
"ruleType": "conditional_values",
"sourceVariable": "text",
"condition": {
"variable": "text",
"operator": "eq",
"value": 1
},
"allowedValues": [
"text"
],
"minValue": null,
"maxValue": null,
"confidence": 1,
"support": 0,
"strength": "hard",
"violationRate": null,
"source": null,
"cycle": null
}
],
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source",
"trustTier": "exploratory",
"ontologyRef": {
"ontologyId": "text",
"ontologyVersion": "text",
"canonicalId": "text",
"installScope": {
"conceptCanonicalIds": [
"text"
],
"filters": [
{
"conceptRef": "text",
"values": [
"text"
],
"start": null,
"end": null
}
]
}
},
"layerIds": [
"text"
],
"tags": [
"text"
],
"valueMappings": [
{
"canonicalValue": "text",
"aliases": [
"text"
]
}
],
"lockedConceptFields": [
"text"
],
"detectedConceptStructure": {
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source"
},
"lastEditedBy": null,
"lastEditedAt": null,
"lineageDrift": null,
"editVersion": 0,
"createdAt": "text",
"updatedAt": "text"
}
}Returns the full ontology as a graph: nodes are all workspace concepts (from platform MongoDB); edges are anchor (anchorConceptLinks) and temporal_prerequisite (temporalPrerequisites). Built in-platform from ontologyConcepts; no proxy. Same structure as catalog/graph but from the ontology API.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123Responses
200
Successful response
application/json
dataany of · nullableRequired
Payload not declared in this repo
stringOptional
numberOptional
booleanOptional
or
401
Unauthorized
application/json
403
Forbidden
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
get/api/v1/workspaces/{wsId}/ontology/graph
GET /api/v1/workspaces/{wsId}/ontology/graph HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": "text"
}Runs an Anchor SQL statement over the workspace's ontology concepts. Concepts are referenced by name and the ontology plans the joins, time alignment and location matching; SHOW/DESCRIBE metadata commands are also accepted. Always responds 200 with the result union discriminated by ok: rows responses carry rows, columns, units, the compiled plan, warnings and nextStartKey (pass back as startKey to fetch the next page); error responses carry the structured compile error (code, span, candidates, suggestedQuery). The materialised result is not persisted; create a dataset via POST datasets to keep it.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123Body
anchorSqlstring · min: 1Required
Anchor SQL statement over ontology concepts. Reference concepts by name — the ontology plans the joins, time alignment and location matching; most queries need no FROM clause (scope explicitly with FROM source:"name", dataset:"name" or tag:"name" when needed). SHOW/DESCRIBE metadata commands are also accepted. Workspace and organisation ids are injected from the auth context.
limitinteger · min: 1 · max: 10000Optional
Rows per page (default 1000). Page through the full result with startKey; an Anchor SQL LIMIT still caps the statement itself.
startKeyintegerOptional
Resume paging from a rows response's nextStartKey
validateOnlybooleanOptional
Compile and plan without executing; the response is the validated arm carrying the plan and warnings
projectionModestring · enumOptionalPossible values:
related adds ontology-linked context columns; minimal returns only the selected concepts and their anchors
Responses
200
Successful response
application/json
dataany ofRequired
Anchor SQL result union, discriminated by ok and kind: rows (materialised result with nextStartKey paging), metadata (SHOW/DESCRIBE), validated (compile-only), or a structured compile error
or
or
or
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
422
Unprocessable Entity
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
post/api/v1/workspaces/{wsId}/ontology/query
POST /api/v1/workspaces/{wsId}/ontology/query HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"anchorSql": "text",
"limit": 1,
"startKey": 1,
"validateOnly": true,
"projectionMode": "related"
}{
"data": {
"ok": true,
"kind": "text",
"sql": "text",
"columns": [
"text"
],
"rows": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"rowCount": null,
"totalRowCount": null,
"truncated": false,
"nextStartKey": null,
"schemaEntries": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"units": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"plan": {
"chips": [
{
"kind": "text",
"label": "text",
"detail": null
}
],
"joinPlan": [
{
"sourceDatasetId": "text",
"targetDatasetId": "text",
"conceptName": "text",
"strategy": "text",
"fanout": null
}
],
"strategy": "text"
},
"warnings": [
"text"
],
"dataViewId": null,
"relatedColumns": [
"text"
],
"involvedConcepts": [
{
"conceptId": "text",
"name": "text",
"role": "referenced"
}
]
}
}Returns the concept by id from platform MongoDB. Must belong to the workspace.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123idstringRequiredExample:
Path parameter: id
123Responses
200
Successful response
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
get/api/v1/workspaces/{wsId}/ontology/concepts/{id}
GET /api/v1/workspaces/{wsId}/ontology/concepts/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"id": "text",
"organisationId": "text",
"workspaceId": "text",
"name": "text",
"description": null,
"conceptClassification": "identifier",
"anchorConceptLinks": [
"text"
],
"schemaFieldName": "text",
"schemaType": "None",
"schemaSubtype": "Integer",
"metadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lockedMetadataFields": [
"text"
],
"detectedMetadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"fieldMappings": [
{
"sourceId": "text",
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null
}
],
"derivedInfo": {
"formula": null,
"formulaBlocks": {
"nodeId": "text",
"kind": "text",
"blockType": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"derivedType": "manual",
"kind": "op",
"source": "user",
"sourceColumns": [
"text"
],
"expression": null,
"r2": null,
"isDeterministic": null,
"lag": null,
"cumulativeDirection": null,
"sourceDataViewId": null,
"operationLineage": {
"opType": "SQL_QUERY",
"opId": "text",
"parentColumns": [
"text"
],
"parentConceptIds": [
"text"
]
},
"viewSnapshot": {
"sources": [
{
"id": "text",
"type": "text",
"name": null,
"conceptIds": [
"text"
],
"conceptVersions": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"version": {
"kind": "text"
}
}
],
"operations": "[Circular Reference]",
"outputColumn": "text"
},
"lineageHash": null,
"sourceJoinConfig": {
"joinType": "left",
"strategy": null
}
},
"conceptKind": "standard",
"metricSql": null,
"relationshipRules": [
{
"ruleType": "conditional_values",
"sourceVariable": "text",
"condition": {
"variable": "text",
"operator": "eq",
"value": 1
},
"allowedValues": [
"text"
],
"minValue": null,
"maxValue": null,
"confidence": 1,
"support": 0,
"strength": "hard",
"violationRate": null,
"source": null,
"cycle": null
}
],
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source",
"trustTier": "exploratory",
"ontologyRef": {
"ontologyId": "text",
"ontologyVersion": "text",
"canonicalId": "text",
"installScope": {
"conceptCanonicalIds": [
"text"
],
"filters": [
{
"conceptRef": "text",
"values": [
"text"
],
"start": null,
"end": null
}
]
}
},
"layerIds": [
"text"
],
"tags": [
"text"
],
"valueMappings": [
{
"canonicalValue": "text",
"aliases": [
"text"
]
}
],
"lockedConceptFields": [
"text"
],
"detectedConceptStructure": {
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source"
},
"lastEditedBy": null,
"lastEditedAt": null,
"lineageDrift": null,
"editVersion": 0,
"createdAt": "text",
"updatedAt": "text"
}
}Replaces the concept with the provided fields. Platform loads the existing concept, merges the body, preserves the persisted editVersion when omitted, then proxies to data-service POST /api/ontology/update-concept so downstream consumers (e.g. catalog, data-service) stay in sync. Body should include _id and any fields to update.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123idstringRequiredExample:
Path parameter: id
123Body
_idstringRequired
ownerIdstringOptionalDefault:
systemorganisationIdstringOptional
workspaceIdstringOptional
namestringOptional
descriptionstring · nullableOptional
conceptClassificationstring · enum · nullableOptionalPossible values:
anchorConceptLinksstring[]OptionalDefault:
[]schemaFieldNamestringOptional
schemaTypestring · enumOptionalPossible values:
schemaSubtypestring · enum · nullableOptionalPossible values:
lockedMetadataFieldsstring[]Optional
conceptKindstring · enumOptionalDefault:
standardPossible values: metricSqlstring · nullableOptional
temporalPrerequisitesstring[]OptionalDefault:
[]suggestedRolestring · enum · nullableOptionalPossible values:
trustTierstring · enum · nullableOptionalPossible values:
layerIdsstring[] · nullableOptional
tagsstring[]OptionalDefault:
[]lockedConceptFieldsstring[]Optional
lastEditedBystring · nullableOptional
lastEditedAtstring · nullableOptional
lineageDriftboolean · nullableOptional
editVersionintegerOptionalDefault:
0createdAtstringOptional
updatedAtstringOptional
Responses
200
Successful response
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
409
Conflict
application/json
422
Unprocessable Entity
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
put/api/v1/workspaces/{wsId}/ontology/concepts/{id}
PUT /api/v1/workspaces/{wsId}/ontology/concepts/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 9626
{
"_id": "text",
"ownerId": "system",
"organisationId": "text",
"workspaceId": "text",
"name": "text",
"description": null,
"conceptClassification": "identifier",
"anchorConceptLinks": [
"text"
],
"schemaFieldName": "text",
"schemaType": "None",
"schemaSubtype": "Integer",
"metadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lockedMetadataFields": [
"text"
],
"detectedMetadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"derivedInfo": {
"formula": null,
"formulaBlocks": {
"nodeId": "text",
"kind": "text",
"blockType": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"derivedType": "manual",
"kind": "op",
"source": "user",
"sourceColumns": [
"text"
],
"expression": null,
"r2": null,
"isDeterministic": null,
"lag": null,
"cumulativeDirection": null,
"sourceDataViewId": null,
"operationLineage": {
"opType": "SQL_QUERY",
"opId": "text",
"parentColumns": [
"text"
],
"parentConceptIds": [
"text"
]
},
"viewSnapshot": {
"sources": [
{
"id": "text",
"type": "text",
"name": null,
"conceptIds": [
"text"
],
"conceptVersions": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"version": {
"kind": "text"
}
}
],
"operations": [
"[Circular Reference]"
],
"outputColumn": "text"
},
"lineageHash": null,
"sourceJoinConfig": {
"joinType": "left",
"strategy": null
}
},
"conceptKind": "standard",
"metricSql": null,
"relationshipRules": [
{
"ruleType": "conditional_values",
"sourceVariable": "text",
"condition": {
"variable": "text",
"operator": "eq",
"value": 1
},
"allowedValues": [
"text"
],
"minValue": null,
"maxValue": null,
"confidence": 1,
"support": 0,
"strength": "hard",
"violationRate": null,
"source": null,
"cycle": null
}
],
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source",
"trustTier": "exploratory",
"ontologyRef": {
"ontologyId": "text",
"ontologyVersion": "text",
"canonicalId": "text",
"installScope": {
"conceptCanonicalIds": [
"text"
],
"filters": [
{
"conceptRef": "text",
"values": [
"text"
],
"start": null,
"end": null
}
]
}
},
"layerIds": [
"text"
],
"tags": [
"text"
],
"valueMappings": [
{
"canonicalValue": "text",
"aliases": [
"text"
]
}
],
"lockedConceptFields": [
"text"
],
"detectedConceptStructure": {
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source"
},
"lastEditedBy": null,
"lastEditedAt": null,
"lineageDrift": null,
"editVersion": 0,
"createdAt": "text",
"updatedAt": "text",
"fieldMappings": [
{
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null,
"sourceId": "text"
}
]
}{
"data": {
"id": "text",
"organisationId": "text",
"workspaceId": "text",
"name": "text",
"description": null,
"conceptClassification": "identifier",
"anchorConceptLinks": [
"text"
],
"schemaFieldName": "text",
"schemaType": "None",
"schemaSubtype": "Integer",
"metadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lockedMetadataFields": [
"text"
],
"detectedMetadata": {
"categories": [
"text"
],
"minValue": null,
"maxValue": null,
"isMonotonicallyIncreasing": null,
"isMonotonicallyDecreasing": null,
"isUnique": null,
"isCyclic": null,
"isHeterogeneousIdentifier": null,
"compositeScopeConceptId": null,
"isUniformDistribution": null,
"locationType": "latitude",
"coordinateFormat": "dd",
"coordinateDatum": "wgs84",
"coordinatePairConceptId": null,
"locationDetectionSource": "values",
"latitudeInRangeFraction": null,
"longitudeInRangeFraction": null,
"fractionalPartFraction": null,
"coordinatePairFraction": null,
"dmsCoordinateFraction": null,
"postalCodeFraction": null,
"addressShapeFraction": null,
"enrichments": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "running",
"kind": "forward",
"enrichedAt": null,
"enricherVersion": null,
"dataVersion": null,
"version": null,
"sidecarKey": null,
"keyFields": [
"text"
],
"hintFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"corroborationFields": [
"text"
],
"latLonPrecision": null,
"distinctTotal": null,
"matchedCount": null,
"unmatchedCount": null,
"truncated": null,
"error": null,
"appliedDatum": null
}
},
"geoEnrichmentStatus": "running",
"geoEnrichmentKind": "forward",
"geoEnrichedAt": null,
"geoEnrichmentVersion": null,
"geoSidecarKey": null,
"geoDistinctTotal": null,
"geoMatchedCount": null,
"geoUnmatchedCount": null,
"geoTruncated": null,
"geoEnrichmentError": null,
"nanFillStrategy": "forward",
"changeRate": null,
"dateTimeFormat": null,
"displayFormat": null,
"averageInterval": null,
"isConsistentInterval": null,
"unit": null,
"unitModifier": null,
"higherIsBetter": null,
"isEqualInterval": null,
"intervalSize": null,
"valueClass": "continuous",
"fracZero": null,
"zeroRunLengthP95": null,
"nonZeroRunLengthP95": null,
"trendSlopePerSecond": null,
"trendR2": null,
"emailFraction": null,
"medianLength": null,
"distinctLengthCount": 1,
"tsGranularity": null,
"tsValidGranularities": [
"text"
],
"tsTypicalDeltaSeconds": null,
"tsSelectedGrid": null,
"tsGapProfile": {
"expectedIntervalSeconds": null,
"p50GapSeconds": null,
"p95GapSeconds": null,
"p99GapSeconds": null,
"maxGapSeconds": null,
"gapCount": null,
"largestGapStart": null
},
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsPerEnvProfiles": {
"ANY_ADDITIONAL_PROPERTY": {
"envKey": "text",
"tsSeasonalPeriods": [
{
"periodSeconds": 1,
"cycleLabel": null,
"strength": 1,
"confidence": 1,
"amplitude": null,
"phase": null,
"order": 1
}
],
"tsCategoricalSeasonality": [
{
"periodSeconds": 1,
"cycleLabel": null,
"nPhaseBins": 1,
"cramersV": 1,
"chi2PerDof": null,
"phaseDistribution": [
[
1
]
],
"levels": [
"text"
]
}
],
"tsMissingPatterns": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"tsActiveWindows": [
{
"cycle": "hour_of_day",
"activeIndices": [
1
],
"inactiveIndices": [
1
],
"densityByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"aggByIndex": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
],
"trendSlopePerSecond": null,
"trendR2": null,
"tsTypicalDeltaSeconds": null
}
},
"tsAnalyzerVersion": null,
"tsAnalyzedAt": null,
"elementSchemaType": "None",
"elementCategories": [
"text"
],
"sizeStatistics": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"fieldMappings": [
{
"sourceId": "text",
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null
}
],
"derivedInfo": {
"formula": null,
"formulaBlocks": {
"nodeId": "text",
"kind": "text",
"blockType": "text",
"values": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"derivedType": "manual",
"kind": "op",
"source": "user",
"sourceColumns": [
"text"
],
"expression": null,
"r2": null,
"isDeterministic": null,
"lag": null,
"cumulativeDirection": null,
"sourceDataViewId": null,
"operationLineage": {
"opType": "SQL_QUERY",
"opId": "text",
"parentColumns": [
"text"
],
"parentConceptIds": [
"text"
]
},
"viewSnapshot": {
"sources": [
{
"id": "text",
"type": "text",
"name": null,
"conceptIds": [
"text"
],
"conceptVersions": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"version": {
"kind": "text"
}
}
],
"operations": "[Circular Reference]",
"outputColumn": "text"
},
"lineageHash": null,
"sourceJoinConfig": {
"joinType": "left",
"strategy": null
}
},
"conceptKind": "standard",
"metricSql": null,
"relationshipRules": [
{
"ruleType": "conditional_values",
"sourceVariable": "text",
"condition": {
"variable": "text",
"operator": "eq",
"value": 1
},
"allowedValues": [
"text"
],
"minValue": null,
"maxValue": null,
"confidence": 1,
"support": 0,
"strength": "hard",
"violationRate": null,
"source": null,
"cycle": null
}
],
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source",
"trustTier": "exploratory",
"ontologyRef": {
"ontologyId": "text",
"ontologyVersion": "text",
"canonicalId": "text",
"installScope": {
"conceptCanonicalIds": [
"text"
],
"filters": [
{
"conceptRef": "text",
"values": [
"text"
],
"start": null,
"end": null
}
]
}
},
"layerIds": [
"text"
],
"tags": [
"text"
],
"valueMappings": [
{
"canonicalValue": "text",
"aliases": [
"text"
]
}
],
"lockedConceptFields": [
"text"
],
"detectedConceptStructure": {
"temporalPrerequisites": [
"text"
],
"suggestedRole": "source"
},
"lastEditedBy": null,
"lastEditedAt": null,
"lineageDrift": null,
"editVersion": 0,
"createdAt": "text",
"updatedAt": "text"
}
}Deletes the concept from platform MongoDB only (deleteManyOntologyConcepts). Does not call data-service; any data-service copy or derived indices are not updated by this route.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123idstringRequiredExample:
Path parameter: id
123Responses
204
No Content
No content
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
delete/api/v1/workspaces/{wsId}/ontology/concepts/{id}
DELETE /api/v1/workspaces/{wsId}/ontology/concepts/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Merges one or more source concepts into a single target concept in one atomic request. Body: targetConceptId, sourceConceptIds (string array); sourceConceptId (string) is a deprecated legacy single-merge field coalesced into sourceConceptIds. Proxies to data-service POST /api/ontology/merge-concepts. Field mappings and relationships from every source are consolidated into the target; the sources are deleted. The whole batch is rejected atomically if any source is missing or fails merge validation. Returns the merged concept.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123Body
sourceConceptIdstringOptional
sourceConceptIdsstring[]Required
targetConceptIdstringRequired
Responses
200
Successful response
application/json
dataany of · nullableRequired
Payload not declared in this repo
stringOptional
numberOptional
booleanOptional
or
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
422
Unprocessable Entity
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
post/api/v1/workspaces/{wsId}/ontology/concepts/merge
POST /api/v1/workspaces/{wsId}/ontology/concepts/merge HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79
{
"sourceConceptId": "text",
"sourceConceptIds": [
"text"
],
"targetConceptId": "text"
}{
"data": "text"
}Searches concepts by text and filters. Query params: query (text), schemaType, classification, sourceId, limit (default 50). Proxies to data-service GET /api/ontology/search/{workspaceId}. Use for typeahead or filtered concept pickers.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123Query parameters
querystringRequiredExample:
Search text matched against concept names.
examplelimitnumberOptionalExample:
Maximum number of concepts to return.
1sourceIdstringOptionalExample:
Restrict to concepts mapped to this source.
123classificationstringOptionalExample:
Filter by concept classification.
exampleschemaTypestringOptionalExample:
Filter by concept schema type.
exampleResponses
200
Successful response
application/json
dataany of · nullableRequired
Payload not declared in this repo
stringOptional
numberOptional
booleanOptional
or
401
Unauthorized
application/json
403
Forbidden
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
get/api/v1/workspaces/{wsId}/ontology/concepts/search
GET /api/v1/workspaces/{wsId}/ontology/concepts/search?query=text HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": "text"
}Returns the concept's id, name, and fieldMappings (source/table and field links). Read from platform MongoDB; no proxy. fieldMappings link this concept to columns in workspace sources.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123idstringRequiredExample:
Path parameter: id
123Responses
200
Successful response
application/json
dataany of · nullableRequired
Payload not declared in this repo
stringOptional
numberOptional
booleanOptional
or
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
get/api/v1/workspaces/{wsId}/ontology/concepts/{id}/mappings
GET /api/v1/workspaces/{wsId}/ontology/concepts/{id}/mappings HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": "text"
}Returns the concept's id, name, anchorConceptLinks, and temporalPrerequisites. Read from platform MongoDB. anchorConceptLinks are concept ids this concept is anchored to; temporalPrerequisites are concept ids that must precede this one in time.
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123idstringRequiredExample:
Path parameter: id
123Responses
200
Successful response
application/json
dataany of · nullableRequired
Payload not declared in this repo
stringOptional
numberOptional
booleanOptional
or
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
get/api/v1/workspaces/{wsId}/ontology/concepts/{id}/relationships
GET /api/v1/workspaces/{wsId}/ontology/concepts/{id}/relationships HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": "text"
}Splits one concept by moving a single field mapping to a new concept. Body: fieldMapping (the mapping to split out). Proxies to data-service POST /api/ontology/split-concept with conceptId and fieldMapping. Returns the result from data-service (e.g. new concept and updated original).
Authorizations
AuthorizationstringRequired
An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.
Path parameters
wsIdstringRequiredExample:
Path parameter: wsId
123idstringRequiredExample:
Path parameter: id
123Body
Responses
200
Successful response
application/json
dataany of · nullableRequired
Payload not declared in this repo
stringOptional
numberOptional
booleanOptional
or
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Entity
application/json
429
Too Many Requests; the response carries Retry-After
application/json
500
Internal Server Error
application/json
post/api/v1/workspaces/{wsId}/ontology/concepts/{id}/split
POST /api/v1/workspaces/{wsId}/ontology/concepts/{id}/split HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 508
{
"fieldMapping": {
"datasetId": "text",
"field": "text",
"status": "confirmed",
"source": "ingest",
"confidence": null,
"evidence": null,
"valueMap": [
[]
],
"canonicalField": null,
"scopeFields": [
"text"
],
"precedence": null,
"keyRole": "primary",
"conformance": {
"rowsScanned": 1,
"nullRate": 1,
"allowedValueCoverage": null,
"unresolvedValues": [
{
"value": "text",
"count": 1
}
],
"inferredGranularity": null,
"granularityMatch": null,
"duplicateAnchorKeys": null,
"unitNote": null,
"verdict": "pass"
},
"decidedBy": null,
"decidedAt": null,
"sourceId": "text"
}
}{
"data": "text"
}Last updated