Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Celonis Data API

The Data API from Celonis — 2 operation(s) for data.

Celonis Data API is one of 17 APIs that Celonis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version v1.2.0.

Requests are made against a single base URL, https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com.

4 operations 2 paths 19 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.2.0
Base URL
https://{team_domain}.{realm}.celonis.cloud
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Celonis Data API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as AppKey (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Data 4
GET
/intelligence/api/knowledge-models/{km_id}/data
Get a list of KM data
getKnowledgeModelDataResult 12 params → 200400401403404429500503
POST
/intelligence/api/knowledge-models/{km_id}/data
Get a list of KM data with advanced filtering
getKnowledgeModelQueryResultByUsingQueryInBody 1 param body → 200400401403404429500503
GET
/intelligence/api/knowledge-models/{km_id}/records/{record_id}/data
Get a list of KM Record data
getRecordDataResult 12 params → 200400401403404429500503
POST
/intelligence/api/knowledge-models/{km_id}/records/{record_id}/data
Get a list of KM Record data with advanced filtering
getRecordDataResultByUsingQueryInBody 2 params body → 200400401403404429500503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are recordItemHeaderDTO (8 properties), Projection (7 properties), KmRecordDataRequestProjection (6 properties), errorDTO (5 properties). Each schema is shown below with its type and property counts.

KmRecordFieldsProjection
string
Projection of KM Record fields expressed as a comma separated list of Record Fields names to be used.
FiltersProjection
object
Defines filtering criteria for the Knowledge Model query.
2 properties
SearchProjection
object
Defines search criteria for full-text search or specific field search.
3 properties
SortProjectionKm
string
Defines the order in which results are returned (Knowledge Model–level query body). The sort property must be a comma-separated list of record fields and/or KP…
recordResultPageDTO
object
1 property
resultPage
object
4 properties
KmQueryDataRequest
object
The top-level request object for querying the Knowledge Model.
1 property 1 required
Projection
object
Defines the projection criteria for the Knowledge Model query.
7 properties
KmRecordDataRequestProjection
object
Defines the parameters related to the query to be executed against the Knowledge Model Record.
6 properties 1 required
recordItemDTO
object
2 properties
KmQueryRecordDataRequest
object
The top-level request records for querying the Knowledge Model.
1 property 1 required
KmPaginationProjection
object
Projection of pagination parameters to be used, expressed as a page number and a page size.
2 properties
errorDTO
object
This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse…
5 properties
KmOptionsProjection
array
Set different options to customize the data results for a projection.
recordItemHeaderDTO
object
8 properties
SortProjectionRecord
string
Defines the order in which results are returned (record-level query body). The sort property must be a comma-separated list of record fields. Any value used in…
authErrorDTO
object
1 property
KpisProjection
array
List of KPIs.
KmOptionsValues
string
Set different options to customize the data results for a query. Supported options Distinct: Enable the unique data results for a query

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celonis-data-api-openapi.yml Raw ↑

Other APIs Celonis publishes across the network.

Celonis Agents - Conversation API
Celonis Beta: OData Protocol API
Celonis Beta: Semantics for 3P AI Agents API
Celonis Job Execution API
Celonis Job Execution Group API
Celonis Login History API API
Celonis Members API API
Celonis Notebook API
Celonis Notebook Execution API
Celonis Notebook Resources API
Celonis OpenAPI Tool Calling API
Celonis Permissions Export API API