openapi: 3.1.0
info:
  title: Adobe Analytics Annotations Jobs 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: Jobs
  description: Create and monitor data repair jobs
paths:
  /{rsid}/job:
    get:
      operationId: listJobs
      summary: Adobe Analytics List Data Repair Jobs
      description: Returns a list of the most recent 20 data repair jobs for the specified report suite, including both completed and in-progress jobs. Each job record includes status, progress, and result information.
      tags:
      - Jobs
      parameters:
      - $ref: '#/components/parameters/rsidPath'
      responses:
        '200':
          description: List of repair jobs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RepairJob'
              examples:
                Listjobs200Example:
                  summary: Default listJobs 200 response
                  x-microcks-default: true
                  value:
                  - jobId: '500123'
                    reportSuiteId: '500123'
                    dateRangeStart: '2026-01-15'
                    dateRangeEnd: '2026-01-15'
                    status: processing
                    progress: 10
                    jobCreateTime: '2026-01-15T10:30:00Z'
                    jobCompleteTime: '2026-01-15T10:30:00Z'
                    serverCalls: 10
                    nodesProcessed: 10
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listjobs401Example:
                  summary: Default listJobs 401 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createRepairJob
      summary: Adobe Analytics Create a Data Repair Job
      description: Creates and starts a new data repair job for the specified report suite and date range. The validationToken from the serverCallEstimate endpoint must be included as a query parameter. The request body defines which variables to repair and what actions to take (delete or set).
      tags:
      - Jobs
      parameters:
      - $ref: '#/components/parameters/rsidPath'
      - name: validationToken
        in: query
        required: true
        description: The token returned by the serverCallEstimate endpoint, confirming you have reviewed the cost estimate
        schema:
          type: string
        example: CAUQAA
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepairJobDefinition'
            examples:
              CreaterepairjobRequestExample:
                summary: Default createRepairJob request
                x-microcks-default: true
                value:
                  variables: example_value
      responses:
        '200':
          description: Repair job created and started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepairJob'
              examples:
                Createrepairjob200Example:
                  summary: Default createRepairJob 200 response
                  x-microcks-default: true
                  value:
                    jobId: '500123'
                    reportSuiteId: '500123'
                    dateRangeStart: '2026-01-15'
                    dateRangeEnd: '2026-01-15'
                    status: processing
                    progress: 10
                    jobCreateTime: '2026-01-15T10:30:00Z'
                    jobCompleteTime: '2026-01-15T10:30:00Z'
                    serverCalls: 10
                    nodesProcessed: 10
        '400':
          description: Invalid job definition or validation token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createrepairjob400Example:
                  summary: Default createRepairJob 400 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createrepairjob401Example:
                  summary: Default createRepairJob 401 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /{rsid}/job/{jobId}:
    get:
      operationId: getRepairJob
      summary: Adobe Analytics Get a Data Repair Job
      description: Returns the current status and details for a specific data repair job, including progress percentage, number of rows processed, and completion status.
      tags:
      - Jobs
      parameters:
      - $ref: '#/components/parameters/rsidPath'
      - name: jobId
        in: path
        required: true
        description: The repair job ID returned when the job was created
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: Repair job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepairJob'
              examples:
                Getrepairjob200Example:
                  summary: Default getRepairJob 200 response
                  x-microcks-default: true
                  value:
                    jobId: '500123'
                    reportSuiteId: '500123'
                    dateRangeStart: '2026-01-15'
                    dateRangeEnd: '2026-01-15'
                    status: processing
                    progress: 10
                    jobCreateTime: '2026-01-15T10:30:00Z'
                    jobCompleteTime: '2026-01-15T10:30:00Z'
                    serverCalls: 10
                    nodesProcessed: 10
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getrepairjob404Example:
                  summary: Default getRepairJob 404 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    RepairJob:
      type: object
      description: Status and details of a data repair job
      properties:
        jobId:
          type: integer
          description: Unique job identifier
          example: '500123'
        reportSuiteId:
          type: string
          description: The report suite being repaired
          example: '500123'
        dateRangeStart:
          type: string
          format: date
          description: Start of the repair date range
          example: '2026-01-15'
        dateRangeEnd:
          type: string
          format: date
          description: End of the repair date range
          example: '2026-01-15'
        status:
          type: string
          description: Current status of the repair job
          enum:
          - processing
          - complete
          - failed
          example: processing
        progress:
          type: integer
          description: Job completion percentage (0-100)
          minimum: 0
          maximum: 100
          example: 10
        jobCreateTime:
          type: string
          format: date-time
          description: Timestamp when the job was created
          example: '2026-01-15T10:30:00Z'
        jobCompleteTime:
          type: string
          format: date-time
          description: Timestamp when the job completed
          example: '2026-01-15T10:30:00Z'
        serverCalls:
          type: integer
          description: Actual number of server calls processed
          example: 10
        nodesProcessed:
          type: integer
          description: Number of data nodes processed
          example: 10
    RepairJobDefinition:
      type: object
      required:
      - variables
      description: Definition of a data repair job
      properties:
        variables:
          type: object
          description: Map of variable names to repair actions. Keys are Analytics variable names (e.g. eVar1, prop5, activitymap) and values are action objects.
          additionalProperties:
            $ref: '#/components/schemas/RepairAction'
          example: example_value
    RepairAction:
      type: object
      required:
      - action
      description: The action to take on a specific variable
      properties:
        action:
          type: string
          description: The repair action to perform
          enum:
          - delete
          - set
          example: delete
        setValue:
          type: string
          description: The value to set the variable to (required when action is 'set')
          example: example_value
        filter:
          $ref: '#/components/schemas/RepairFilter'
    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
    RepairFilter:
      type: object
      description: Optional filter to limit which rows are affected by the repair
      properties:
        condition:
          type: string
          description: The filter condition type
          enum:
          - contains
          - streq
          - startswith
          example: contains
        matchValue:
          type: string
          description: The value to match against for filtering
          example: example_value
  parameters:
    rsidPath:
      name: rsid
      in: path
      required: true
      description: The report suite 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/