Getting started
The Reporting API supports industry standard REST requests to retrieve data. Please choose “REST API” in your 3rd party analytical tool to start the setup.
The location of the API resource is defined by the domains specified in the tables below and the endpoints as specified by the OpenAPI documentation. For example, to get your first 100 processes using the API as a US customer, you would make an API call similar to this, with the request headers as defined in the Authentication section below:
GET [https://api-reporting.us-1.symbio.cloud/api/v1/elements?take=100\&facetName=processes](https://api-reporting.us-1.symbio.cloud/api/v1/elements?take=100&facetName=processes)NOTE: The API will update data once a day overnight, so you will not see the latest data immediately after connection.
The API key will have an automatic 90 day expiration period, which requires a new API key to be generated in the Admin App. Without an updated API key, API calls on the receiving 3rd-party application will fail with “unauthorized” error.
Prerequisites
An Admin App needs to be available on the database and model data needs to be created in the Designer in order for this feature to work.
Authentication
The API call can be authenticated with an API Key authentication method, and API keys can be generated via the Admin App. To request data, you need to specify both this key and that your tenant is within the REST API call.
| Header | Description |
|---|---|
| x-tenant-id | This is a unique ID to identify your data location. Currently it can only be found by opening either the Navigator or Admin App and checking the URL of the page after it has fully loaded. You can find it via: the first GUID of the Navigator URL: https://navigator.symbio.cloud/celonis/c592ade4-4a5a-4804-a6e0-267f6a164fc6 or the “tenant” section of the Admin App URL: https://admin.symbio.cloud/?company=celonis&tenant=c592ade4-4a5a-4804-a6e0-267f6a164fc6 |
| x-api-key | The API key can be generated using the Admin App within the “Reporting” section. |
Before you begin
Pagination considerations
Maximum 100 elements per pagination. A custom pagination can be indicated with “take” & “Skip” operation. If not specified, the default max (100 elements) will be applied.
Versioning
The API is currently at version [1] with path v1. Future versions will be introduced with URL path versioning.
Data Formats
The API uses JSON for request and response bodies.