Anomaly Detection ChangePoint API

openapi: 3.2.0
info:
  title: Azure AI Anomaly Detector Change Point API
  version: '1.0'
  description: 'Managed REST API service from Azure AI Services that monitors and detects

    anomalies in time series data without requiring machine learning expertise.

    Supports univariate batch detection across an entire series, last-point

    detection for streaming, and change-point detection. The multivariate API

    enables anomaly detection across up to 300 correlated signals.


    NOTE: The service is being retired on 1 October 2026 in favor of Microsoft

    Fabric real-time intelligence.

    '
  contact:
    name: Azure Anomaly Detector Support
    url: https://learn.microsoft.com/en-us/azure/ai-services/anomaly-detector/
servers:
- url: https://{resource-name}.cognitiveservices.azure.com/anomalydetector/v1.0
  description: Univariate Anomaly Detector v1.0 endpoint
  variables:
    resource-name:
      default: my-resource
      description: Name of the Azure AI resource provisioned in the Azure portal.
- url: https://{resource-name}.cognitiveservices.azure.com/anomalydetector/v1.1
  description: Anomaly Detector v1.1 (includes multivariate)
  variables:
    resource-name:
      default: my-resource
      description: Name of the Azure AI resource provisioned in the Azure portal.
security:
- SubscriptionKey: []
tags:
- name: ChangePoint
  description: Trend change-point detection.
paths:
  /timeseries/changepoint/detect:
    post:
      tags:
      - ChangePoint
      summary: Detect trend change points
      description: Detects trend change points across a series of data points.
      operationId: detectUnivariateChangePoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnivariateChangePointDetectionOptions'
      responses:
        '200':
          description: Change-point detection result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnivariateChangePointDetectionResult'
components:
  schemas:
    UnivariateChangePointDetectionResult:
      type: object
      properties:
        period:
          type: integer
        isChangePoint:
          type: array
          items:
            type: boolean
        confidenceScores:
          type: array
          items:
            type: number
    TimeSeriesPoint:
      type: object
      required:
      - value
      properties:
        timestamp:
          type: string
          format: date-time
        value:
          type: number
    UnivariateChangePointDetectionOptions:
      allOf:
      - $ref: '#/components/schemas/UnivariateDetectionOptions'
      - type: object
        properties:
          threshold:
            type: number
          stableTrendWindow:
            type: integer
    UnivariateDetectionOptions:
      type: object
      required:
      - series
      properties:
        series:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesPoint'
        granularity:
          type: string
          enum:
          - yearly
          - monthly
          - weekly
          - daily
          - hourly
          - minutely
          - secondly
          - microsecond
          - none
        customInterval:
          type: integer
        period:
          type: integer
        maxAnomalyRatio:
          type: number
        sensitivity:
          type: integer
        imputeMode:
          type: string
          enum:
          - auto
          - previous
          - linear
          - fixed
          - zero
          - notFill
        imputeFixedValue:
          type: number
  securitySchemes:
    SubscriptionKey:
      type: apiKey
      in: header
      name: Ocp-Apim-Subscription-Key
      description: Azure Cognitive Services subscription key for the Anomaly Detector resource.