Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Measurement Series API

2 actions 2 updates phrasing extends openapi/cumulocity-series-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cumulocity's API. It is a proposal applied on top of the contract, not a document Cumulocity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/measurement/measurements/series'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Measurement Series API
  version: 1.0.0
extends: openapi/cumulocity-series-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/measurement/measurements/series'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated measurement series
      effect: read
      questions:
      - How do I get hourly or daily averages of a sensor series?
      - Can I fetch aggregated time-series data for charting?
      instructions:
      - text: Get series {series} for device {source} from {dateFrom} to {dateTo}.
        slots:
          series: query.series
          source: query.source
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Aggregate {series} on device {source} by {aggregationType} between {dateFrom} and {dateTo}.
        slots:
          series: query.series
          source: query.source
          aggregationType: query.aggregationType
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      method: generated
      generated: '2026-10-01'