openapi: 3.1.0
info:
  title: Adobe Analytics Annotations Calculated Metrics API
  description: The Adobe Analytics 2.0 APIs provide programmatic access to data, reports, and administration features within Adobe Analytics. You can perform almost any action available in the Analytics user interface, including reporting, segment management, calculated metrics, dimensions, and component administration.
  version: '2.0'
  contact:
    name: Adobe Analytics Support
    url: https://developer.adobe.com/analytics-apis/docs/2.0/support/
  termsOfService: https://www.adobe.com/legal/terms.html
  x-last-validated: '2026-04-18'
servers:
- url: https://analytics.adobe.io/api/{globalCompanyId}
  description: Adobe Analytics Production API
  variables:
    globalCompanyId:
      description: The global company ID for your Adobe Analytics organization
      default: YOUR_GLOBAL_COMPANY_ID
security:
- bearerAuth: []
  apiKey: []
tags:
- name: Calculated Metrics
  description: Manage calculated metrics built from existing metrics
paths:
  /calculatedmetrics:
    get:
      operationId: listCalculatedMetrics
      summary: Adobe Analytics List Calculated Metrics
      description: Retrieves all calculated metrics for the company. Supports filtering by owner, tags, report suite, and whether to include shared or template calculated metrics.
      tags:
      - Calculated Metrics
      parameters:
      - $ref: '#/components/parameters/locale'
      - name: limit
        in: query
        schema:
          type: integer
          default: 10
          maximum: 1000
        example: 10
      - name: page
        in: query
        schema:
          type: integer
          default: 0
        example: 10
      - name: expansion
        in: query
        description: Comma-separated additional fields to include
        schema:
          type: string
        example: example_value
      - name: includeType
        in: query
        description: Controls which calculated metrics are returned
        schema:
          type: string
          enum:
          - all
          - shared
          - templates
        example: all
      responses:
        '200':
          description: List of calculated metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedMetricList'
              examples:
                Listcalculatedmetrics200Example:
                  summary: Default listCalculatedMetrics 200 response
                  x-microcks-default: true
                  value:
                    content:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      rsid: '500123'
                      definition: example_value
                      modified: '2026-01-15T10:30:00Z'
                      type: DECIMAL
                    totalElements: 42
                    totalPages: 42
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listcalculatedmetrics401Example:
                  summary: Default listCalculatedMetrics 401 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
                    errorId: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCalculatedMetric
      summary: Adobe Analytics Create a Calculated Metric
      description: Creates a new calculated metric using a definition that combines existing metrics with mathematical operators and functions.
      tags:
      - Calculated Metrics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatedMetricCreate'
            examples:
              CreatecalculatedmetricRequestExample:
                summary: Default createCalculatedMetric request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  rsid: '500123'
                  definition: example_value
                  type: DECIMAL
      responses:
        '200':
          description: Calculated metric created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedMetric'
              examples:
                Createcalculatedmetric200Example:
                  summary: Default createCalculatedMetric 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    rsid: '500123'
                    owner:
                      id: abc123
                      name: Example Title
                      login: example_value
                    definition: example_value
                    modified: '2026-01-15T10:30:00Z'
                    type: DECIMAL
        '400':
          description: Invalid definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createcalculatedmetric400Example:
                  summary: Default createCalculatedMetric 400 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
                    errorId: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /calculatedmetrics/{calculatedMetricId}:
    get:
      operationId: getCalculatedMetric
      summary: Adobe Analytics Get a Calculated Metric
      description: Retrieves a single calculated metric by its ID.
      tags:
      - Calculated Metrics
      parameters:
      - $ref: '#/components/parameters/calculatedMetricId'
      responses:
        '200':
          description: Calculated metric details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedMetric'
              examples:
                Getcalculatedmetric200Example:
                  summary: Default getCalculatedMetric 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    rsid: '500123'
                    owner:
                      id: abc123
                      name: Example Title
                      login: example_value
                    definition: example_value
                    modified: '2026-01-15T10:30:00Z'
                    type: DECIMAL
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getcalculatedmetric404Example:
                  summary: Default getCalculatedMetric 404 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
                    errorId: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateCalculatedMetric
      summary: Adobe Analytics Update a Calculated Metric
      description: Updates an existing calculated metric definition or metadata.
      tags:
      - Calculated Metrics
      parameters:
      - $ref: '#/components/parameters/calculatedMetricId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatedMetricCreate'
            examples:
              UpdatecalculatedmetricRequestExample:
                summary: Default updateCalculatedMetric request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  rsid: '500123'
                  definition: example_value
                  type: DECIMAL
      responses:
        '200':
          description: Updated calculated metric
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedMetric'
              examples:
                Updatecalculatedmetric200Example:
                  summary: Default updateCalculatedMetric 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    rsid: '500123'
                    owner:
                      id: abc123
                      name: Example Title
                      login: example_value
                    definition: example_value
                    modified: '2026-01-15T10:30:00Z'
                    type: DECIMAL
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCalculatedMetric
      summary: Adobe Analytics Delete a Calculated Metric
      description: Permanently deletes the specified calculated metric.
      tags:
      - Calculated Metrics
      parameters:
      - $ref: '#/components/parameters/calculatedMetricId'
      responses:
        '200':
          description: Deleted successfully
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CalculatedMetricCreate:
      type: object
      required:
      - name
      - rsid
      - definition
      description: Payload for creating or updating a calculated metric
      properties:
        name:
          type: string
          description: Display name
          maxLength: 255
          example: Example Title
        description:
          type: string
          description: Description of what the metric measures
          example: A sample description.
        rsid:
          type: string
          description: Report suite ID
          example: '500123'
        definition:
          type: object
          description: The formula definition
          example: example_value
        type:
          type: string
          description: The metric output type
          enum:
          - DECIMAL
          - TIME
          - PERCENT
          - CURRENCY
          example: DECIMAL
    CalculatedMetricList:
      type: object
      description: Paginated list of calculated metrics
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CalculatedMetric'
          example: []
        totalElements:
          type: integer
          description: Total number of calculated metrics available
          example: 42
        totalPages:
          type: integer
          description: Total number of pages
          example: 42
    CalculatedMetric:
      type: object
      description: A calculated metric definition
      properties:
        id:
          type: string
          description: Unique calculated metric identifier
          example: abc123
        name:
          type: string
          description: Display name
          example: Example Title
        description:
          type: string
          description: Description of what the metric measures
          example: A sample description.
        rsid:
          type: string
          description: The report suite this calculated metric is based on
          example: '500123'
        owner:
          $ref: '#/components/schemas/Owner'
        definition:
          type: object
          description: The formula definition for this calculated metric
          example: example_value
        modified:
          type: string
          format: date-time
          description: Last modification timestamp
          example: '2026-01-15T10:30:00Z'
        type:
          type: string
          description: The metric type
          enum:
          - DECIMAL
          - TIME
          - PERCENT
          - CURRENCY
          example: DECIMAL
    ErrorResponse:
      type: object
      description: Error response from the API
      properties:
        errorCode:
          type: string
          description: Machine-readable error code
          example: example_value
        errorDescription:
          type: string
          description: Human-readable error message
          example: example_value
        errorId:
          type: string
          description: Unique ID for tracking this error
          example: '500123'
    Owner:
      type: object
      description: The owner of an Analytics component
      properties:
        id:
          type: integer
          description: Owner user ID
          example: abc123
        name:
          type: string
          description: Owner display name
          example: Example Title
        login:
          type: string
          description: Owner login identifier
          example: example_value
  parameters:
    locale:
      name: locale
      in: query
      description: The locale for response labels
      schema:
        type: string
        enum:
        - en_US
        - fr_FR
        - jp_JP
        - ja_JP
        - de_DE
        - es_ES
        - ko_KR
        - pt_BR
        - zh_CN
        - zh_TW
    calculatedMetricId:
      name: calculatedMetricId
      in: path
      required: true
      description: The calculated metric ID
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token from Adobe IMS
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Adobe Developer Console API key
externalDocs:
  description: Adobe Analytics 2.0 API Documentation
  url: https://developer.adobe.com/analytics-apis/docs/2.0/