Analytics Query API

From CDQ
API/Query API
Jump to navigation Jump to search
Name Name of a concept, e.g. a data model concept. In contrast to terms, the name does not depend on a given context, e.g. a country-specific language. Analytics Query API
Short description Informal and short human-readable definition of a concept. This is an API for fetching metrics from the e2e database.
Description Informal and comprehensive human-readable definition of a concept. Analytics Query API was created to enable end users to access various KPIs from e2e database, without the need to query the database directly. It provides two endpoints and both of them can be accessed through the API user interface. The API is accessible only with active VPN connection.
Technical key Defines a unique key by which e.g. data model concepts can be referenced in a technical integration context. These keys are unique in the CDL context. API_QUERY
API Documentation https://reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/analytics-query-api/openapi.json
WSDL Download Not yet supported
Invokes ML model(s) Does not invoke any ML model yet

API endpoints

This is just a selection of endpoints, most relevant ones from business perspective, without version information or other details. For a complete technical documentation of the endpoints, please go to the technical API documentation.

EndpointTechnical KeyDocumentation
MetricsQUERY_API_GET_METRICShttps://reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/analytics-query-api/docs#/default/metrics stats metrics get
Metrics/valuesQUERY_API_GET_METRICS_VALUEShttps://reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/analytics-query-api/docs#/default/metrics values metrics values get

API feature toggles

No feature flags documented

Use cases

Use caseShort Description
Secured Access To KPIsSecured Access To KPIs with constant memory footprint.