StatusType

The Export Service provides an interface for exporting customer data that is stored within the SDK.

Within the context of the Export Service, there is the concept of a “product.” Each product represents a specifically configured data set that can be retrieved through the Export Service. Behind each product is an OpenSearch index where the corresponding data is stored.

These data sets (or “data buckets”) are created in collaboration with the respective data owners to ensure that only approved data is made available for export.

The Export Service is hosted under:

https://app.sdk-cloud.de/charginghubexporter/api/v1/export/

Users accessing the interface must have the necessary permissions to retrieve the underlying data. If you are using a client provided by the SDK team, these permissions are already handled. Otherwise, please reach out to the SDK team through the usual channels to request access.

If a user intends to query data from the export service, he usaly uses one of the clients (audicharginghub-cap-client or audicharginghub-konzernforschung-client ) the client MUST have access to the respective opensearch indexes. If a new product/data source is created in the future remember to add access to these/the new client!

Each request must contain a valid JWT authentication token which can be request from https://app.sdk-cloud.de/auth/realms/efs-sdk/protocol/openid-connect/token via the OAuth2 client credentialsauthorization flow.

The service provides two endpoints:

Product endpoint

An endpoint to retrieve a list of all products you have access to.

Example call

curl --request GET \
  --url 'https://app.sdk-cloud.de/charginghubexporter/api/v1/export/products?organization=audicharginghub' \
  --header 'Authorization: Bearer <TOKEN>'

Example response

[
	"audicharginghub_batteriedaten_analysis_batteriedaten_battall",
	"audicharginghub_batteriedaten_analysis_batteriedaten_grid",
	"audicharginghub_ladedaten_analysis_prediction",
	"audicharginghub_batteriedaten_analysis_batteriedaten_evs"
]

Query endpoint

An endpoint to query for the data of a product.

The query endpoint expects multiple parameters:

Parameterrequired?ExampleDescription
organizationyesaudicharginghubName of the organization for permission checks
spacenoladedatenOptional name of a space for permission checks
productyesladedatenName of the product that shall be queried
startDateyes2023-04-30T00:00:00Start date of the requested timeframe
endDateyes2023-05-01T00:00:00End date of the requested timeframe
numRowsno10.000Number of requested results. Default: 10.000
continueTokennoToken for requesting more data in subsequent calls

Example call

curl --request GET \
  --url 'https://app.sdk-cloud.de/charginghubexporter/api/v1/export/query?organization=audicharginghub&product=audicharginghub_batteriedaten_analysis_batteriedaten_grid&startDate=2025-06-01T00%3A00%3A00&endDate=2025-06-02T00%3A00%3A00&numRows=1000' \
  --header 'Authorization: Bearer <TOKEN>'

Example response

{
	"continueToken": "",
	"numResults": 1000,
	"result": [
		{
			"Pset_kW": 90.0,
			"P_kW": 120.0,
			"timestamp": 1748817901101
		},
		{
			"Pset_kW": 100.0,
			"P_kW": 100.0,
			"timestamp": 1748817961100
		},
		{
			"Pset_kW": 90.0,
			"P_kW": 90.0,
			"timestamp": 1748818021100
		},
		{
			"Pset_kW": 95.0,
			"P_kW": 95.0,
			"timestamp": 1748818081100
		}
	]
}

If the amount of data is larger than the numRows parameter a continueTokenis added to the response. This can be used in subsecent querys to fetch the complete data set.