Oracle GoldenGate

Oracle GoldenGate Monitoring API

Performance metrics and process monitoring

Documentation GitHub OpenAPI

Operations 21

GET /services/v2/config/health Oracle Goldengate Get Service Health Details #

GET /services/v2/mpoints/processes Oracle Goldengate Retrieve All Process Metrics #

GET /services/v2/mpoints/{item}/statisticsReplicat Oracle Goldengate Retrieve Replicat Statistics #

GET /services/v2/config/health/check Oracle Goldengate Get Service Health Summary Check #

GET /services/v2/mpoints/{item}/process Oracle Goldengate Retrieve Process Metrics for a Specific Process #

GET /services/v2/mpoints/{item}/statisticsExtract Oracle Goldengate Retrieve Extract Database Statistics #

GET /services/v2/mpoints/{item}/heartbeat Oracle Goldengate Retrieve Heartbeat Timing Metrics #

GET /services/v2/mpoints/{item}/cacheStatistics Oracle Goldengate Retrieve Cache Manager Statistics #

GET /services/v2/mpoints/{item}/processPerformance Oracle Goldengate Retrieve Process Performance Utilization #

GET /services/v2/monitoring/messages Oracle Goldengate Retrieve Process Messages #

GET /services/v2/monitoring/statusChanges Oracle Goldengate Retrieve Process Status Changes #

GET /services/v2/messages Oracle Goldengate Retrieve Administrative Messages #

GET /services/v2/requests Oracle Goldengate Retrieve Background Requests #

GET /services/v2/requests/{request} Oracle Goldengate Retrieve Request Status #

GET /services/v2/oggerr Oracle Goldengate List Message Codes #

GET /services/v2/oggerr/{message} Oracle Goldengate Retrieve Message Explanation #

GET /services/monitoring/jobs Oracle Goldengate Retrieve Job Statistics #

GET /services/monitoring/cps Oracle Goldengate Retrieve Compare Pair Statistics #

GET /services/oos/{runId} Oracle Goldengate Retrieve Out-of-sync Data #

GET /services/monitoring/comparison/{runId}/reports Oracle Goldengate Retrieve Comparison Report #

DELETE /services/purge/stats Oracle Goldengate Purge Comparison Statistics #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/oracle-goldengate-monitoring-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Oracle Goldengate Monitoring API
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-refined-note:
  - x-documentation differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Monitoring across 3 of this provider''s published API definitions: oracle-goldengate-big-data-rest-api-openapi.yml, oracle-goldengate-rest-api-openapi.yml, oracle-goldengate-veridata-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{goldengate-host}:{port}
  description: Oracle GoldenGate for Big Data Microservices server
  variables:
    goldengate-host:
      default: localhost
      description: GoldenGate Big Data host
    port:
      default: '443'
      description: HTTPS port
- url: https://{veridata-host}:{port}/veridata/v1
  description: Oracle GoldenGate Veridata server
  variables:
    veridata-host:
      default: localhost
      description: Veridata server host
    port:
      default: '8830'
      description: Veridata HTTPS port
security:
- basicAuth: []
tags:
- name: Monitoring
  description: Performance metrics and process monitoring
paths:
  /services/v2/config/health:
    get:
      operationId: getServiceHealth
      summary: Oracle Goldengate Get Service Health Details
      description: Returns detailed health information for the GoldenGate for Big Data service.
      tags:
      - Monitoring
      responses:
        '200':
          description: Service health details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHealth'
              examples:
                Getservicehealth200Example:
                  summary: Default getServiceHealth 200 response
                  x-microcks-default: true
                  value:
                    healthy: true
                    services:
                    - name: Example Title
                      status: example_value
                      port: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/mpoints/processes:
    get:
      operationId: listProcessMetrics
      summary: Oracle Goldengate Retrieve All Process Metrics
      description: Returns performance metrics for all running processes.
      tags:
      - Monitoring
      responses:
        '200':
          description: Metrics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessMetricsList'
              examples:
                Listprocessmetrics200Example:
                  summary: Default listProcessMetrics 200 response
                  x-microcks-default: true
                  value:
                    processes:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      lag: 42.5
                      operationsProcessed: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/mpoints/{item}/statisticsReplicat:
    get:
      operationId: getReplicatStats
      summary: Oracle Goldengate Retrieve Replicat Statistics
      description: Returns handler-level statistics for a big data Replicat including records written to the target.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/mpointItemParam'
      responses:
        '200':
          description: Statistics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicatStatistics'
              examples:
                Getreplicatstats200Example:
                  summary: Default getReplicatStats 200 response
                  x-microcks-default: true
                  value:
                    processName: example_value
                    totalOperations: 10
                    inserts: 10
                    updates: 10
                    deletes: 10
                    handlerStatistics:
                      recordsWritten: 10
                      bytesWritten: 10
                      batchesProcessed: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/config/health/check:
    get:
      operationId: getServiceHealthCheck
      summary: Oracle Goldengate Get Service Health Summary Check
      description: Returns a quick health check summary indicating overall service status.
      tags:
      - Monitoring
      responses:
        '200':
          description: Health check passed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckSummary'
              examples:
                Getservicehealthcheck200Example:
                  summary: Default getServiceHealthCheck 200 response
                  x-microcks-default: true
                  value:
                    healthy: true
                    status: example_value
                    timestamp: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/mpoints/{item}/process:
    get:
      operationId: getProcessMetrics
      summary: Oracle Goldengate Retrieve Process Metrics for a Specific Process
      description: Returns detailed performance metrics for a specific GoldenGate process.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/mpointItemParam_2'
      responses:
        '200':
          description: Process metrics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessMetrics'
              examples:
                Getprocessmetrics200Example:
                  summary: Default getProcessMetrics 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: example_value
                    status: example_value
                    lag: 42.5
                    checkpointLag: 42.5
                    inputBytes: 10
                    outputBytes: 10
                    operationsProcessed: 10
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/mpoints/{item}/statisticsExtract:
    get:
      operationId: getExtractDatabaseStats
      summary: Oracle Goldengate Retrieve Extract Database Statistics
      description: Returns database-level statistics for an Extract process.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/mpointItemParam_2'
      responses:
        '200':
          description: Extract statistics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseStatistics'
              examples:
                Getextractdatabasestats200Example:
                  summary: Default getExtractDatabaseStats 200 response
                  x-microcks-default: true
                  value:
                    processName: example_value
                    totalOperations: 10
                    inserts: 10
                    updates: 10
                    deletes: 10
                    truncates: 10
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/mpoints/{item}/heartbeat:
    get:
      operationId: getHeartbeatMetrics
      summary: Oracle Goldengate Retrieve Heartbeat Timing Metrics
      description: Returns heartbeat timing information used to measure replication lag.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/mpointItemParam_2'
      responses:
        '200':
          description: Heartbeat metrics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatMetrics'
              examples:
                Getheartbeatmetrics200Example:
                  summary: Default getHeartbeatMetrics 200 response
                  x-microcks-default: true
                  value:
                    processName: example_value
                    lastHeartbeat: '2026-01-15T10:30:00Z'
                    lagInSeconds: 42.5
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/mpoints/{item}/cacheStatistics:
    get:
      operationId: getCacheStatistics
      summary: Oracle Goldengate Retrieve Cache Manager Statistics
      description: Returns cache manager statistics for a process.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/mpointItemParam_2'
      responses:
        '200':
          description: Cache statistics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CacheStatistics'
              examples:
                Getcachestatistics200Example:
                  summary: Default getCacheStatistics 200 response
                  x-microcks-default: true
                  value:
                    processName: example_value
                    cacheSize: 10
                    cacheUsed: 10
                    cacheHitRatio: 42.5
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/mpoints/{item}/processPerformance:
    get:
      operationId: getProcessPerformance
      summary: Oracle Goldengate Retrieve Process Performance Utilization
      description: Returns CPU and memory utilization metrics for a GoldenGate process.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/mpointItemParam_2'
      responses:
        '200':
          description: Performance metrics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessPerformance'
              examples:
                Getprocessperformance200Example:
                  summary: Default getProcessPerformance 200 response
                  x-microcks-default: true
                  value:
                    processName: example_value
                    cpuUsage: 42.5
                    memoryUsage: 10
                    threadCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/monitoring/messages:
    get:
      operationId: listMonitoringMessages
      summary: Oracle Goldengate Retrieve Process Messages
      description: Returns messages from all monitored processes.
      tags:
      - Monitoring
      responses:
        '200':
          description: Messages retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringMessageList'
              examples:
                Listmonitoringmessages200Example:
                  summary: Default listMonitoringMessages 200 response
                  x-microcks-default: true
                  value:
                    messages:
                    - id: abc123
                      timestamp: '2026-01-15T10:30:00Z'
                      process: example_value
                      severity: example_value
                      message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/monitoring/statusChanges:
    get:
      operationId: listStatusChanges
      summary: Oracle Goldengate Retrieve Process Status Changes
      description: Returns a log of process status changes across all monitored processes.
      tags:
      - Monitoring
      responses:
        '200':
          description: Status changes retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusChangeList'
              examples:
                Liststatuschanges200Example:
                  summary: Default listStatusChanges 200 response
                  x-microcks-default: true
                  value:
                    statusChanges:
                    - id: abc123
                      timestamp: '2026-01-15T10:30:00Z'
                      process: example_value
                      previousStatus: example_value
                      currentStatus: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/messages:
    get:
      operationId: listMessages
      summary: Oracle Goldengate Retrieve Administrative Messages
      description: Returns administrative messages from the server.
      tags:
      - Monitoring
      responses:
        '200':
          description: Messages retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageList'
              examples:
                Listmessages200Example:
                  summary: Default listMessages 200 response
                  x-microcks-default: true
                  value:
                    messages:
                    - timestamp: '2026-01-15T10:30:00Z'
                      severity: example_value
                      message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/requests:
    get:
      operationId: listBackgroundRequests
      summary: Oracle Goldengate Retrieve Background Requests
      description: Returns a list of background requests that are being processed.
      tags:
      - Monitoring
      responses:
        '200':
          description: Background requests listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestList'
              examples:
                Listbackgroundrequests200Example:
                  summary: Default listBackgroundRequests 200 response
                  x-microcks-default: true
                  value:
                    requests:
                    - id: abc123
                      status: example_value
                      type: example_value
                      startTime: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/requests/{request}:
    get:
      operationId: getRequestStatus
      summary: Oracle Goldengate Retrieve Request Status
      description: Returns the status of a specific background request.
      tags:
      - Monitoring
      parameters:
      - name: request
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Request status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestStatus'
              examples:
                Getrequeststatus200Example:
                  summary: Default getRequestStatus 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    status: pending
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
                    result: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/oggerr:
    get:
      operationId: listMessageCodes
      summary: Oracle Goldengate List Message Codes
      description: Returns a list of GoldenGate error and informational message codes.
      tags:
      - Monitoring
      responses:
        '200':
          description: Message codes listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageCodeList'
              examples:
                Listmessagecodes200Example:
                  summary: Default listMessageCodes 200 response
                  x-microcks-default: true
                  value:
                    codes:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/oggerr/{message}:
    get:
      operationId: getMessageExplanation
      summary: Oracle Goldengate Retrieve Message Explanation
      description: Returns a detailed explanation and recommended action for a specific message code.
      tags:
      - Monitoring
      parameters:
      - name: message
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Message explanation retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageExplanation'
              examples:
                Getmessageexplanation200Example:
                  summary: Default getMessageExplanation 200 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
                    explanation: example_value
                    action: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/monitoring/jobs:
    get:
      operationId: getJobStatistics
      summary: Oracle Goldengate Retrieve Job Statistics
      description: Returns comparison statistics for completed and running jobs.
      tags:
      - Monitoring
      responses:
        '200':
          description: Job statistics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatisticsList'
              examples:
                Getjobstatistics200Example:
                  summary: Default getJobStatistics 200 response
                  x-microcks-default: true
                  value:
                    statistics:
                    - runId: '500123'
                      jobName: example_value
                      status: example_value
                      startTime: '2026-01-15T10:30:00Z'
                      endTime: '2026-01-15T10:30:00Z'
                      totalComparePairs: 10
                      inSyncCount: 10
                      outOfSyncCount: 10
                      failedCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/monitoring/cps:
    get:
      operationId: getComparePairStatistics
      summary: Oracle Goldengate Retrieve Compare Pair Statistics
      description: Returns detailed comparison statistics at the compare pair level.
      tags:
      - Monitoring
      responses:
        '200':
          description: Compare pair statistics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparePairStatisticsList'
              examples:
                Getcomparepairstatistics200Example:
                  summary: Default getComparePairStatistics 200 response
                  x-microcks-default: true
                  value:
                    statistics:
                    - comparePairId: '500123'
                      sourceTable: example_value
                      targetTable: example_value
                      status: In Sync
                      sourceRowCount: 10
                      targetRowCount: 10
                      outOfSyncRows: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/oos/{runId}:
    get:
      operationId: getOutOfSyncData
      summary: Oracle Goldengate Retrieve Out-of-sync Data
      description: Returns the rows identified as out-of-sync during a comparison run.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/runIdParam'
      responses:
        '200':
          description: Out-of-sync data retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutOfSyncData'
              examples:
                Getoutofsyncdata200Example:
                  summary: Default getOutOfSyncData 200 response
                  x-microcks-default: true
                  value:
                    runId: '500123'
                    rows:
                    - comparePairId: '500123'
                      sourceTable: example_value
                      targetTable: example_value
                      oosType: missing_in_target
                      keyValues: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/monitoring/comparison/{runId}/reports:
    get:
      operationId: getComparisonReport
      summary: Oracle Goldengate Retrieve Comparison Report
      description: Returns a detailed comparison report for a specific job run.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/runIdParam'
      responses:
        '200':
          description: Report retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonReport'
              examples:
                Getcomparisonreport200Example:
                  summary: Default getComparisonReport 200 response
                  x-microcks-default: true
                  value:
                    runId: '500123'
                    jobName: example_value
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
                    summary:
                      totalComparePairs: 10
                      inSync: 10
                      outOfSync: 10
                      failed: 10
                    details:
                    - sourceTable: example_value
                      targetTable: example_value
                      status: example_value
                      sourceRowCount: 10
                      targetRowCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/purge/stats:
    delete:
      operationId: purgeStatistics
      summary: Oracle Goldengate Purge Comparison Statistics
      description: Deletes stored comparison and repair statistics data.
      tags:
      - Monitoring
      responses:
        '204':
          description: Statistics purged
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
components:
  schemas:
    ReplicatStatistics:
      type: object
      properties:
        processName:
          type: string
          example: example_value
        totalOperations:
          type: integer
          format: int64
          example: 10
        inserts:
          type: integer
          format: int64
          example: 10
        updates:
          type: integer
          format: int64
          example: 10
        deletes:
          type: integer
          format: int64
          example: 10
        handlerStatistics:
          type: object
          properties:
            recordsWritten:
              type: integer
              format: int64
            bytesWritten:
              type: integer
              format: int64
            batchesProcessed:
              type: integer
              format: int64
          example: example_value
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
        severity:
          type: string
          example: example_value
    ServiceHealth:
      type: object
     

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/openapi/oracle-goldengate-monitoring-api-openapi.yml