Oracle Partitioning Performance API
Services related to the runtime performance of the Oracle database instance.
Services related to the runtime performance of the Oracle database instance.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/oracle-partitioning-performance-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: '<p>Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.</p><p>To install and configure Oracle REST Data Services refer to the <a href=https://docs.oracle.com/pls/topic/lookup?ctx=ords-latest&id=ORDIG> Oracle® REST Data Services Installation and Configuration Guide</a>.</p>
<p>An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration. <p><p>The pattern for the API document URL is: </p>
<code>https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path> </code>
<p>Where, the <code><my database></code> and <code><my schema></code> variables can be optional, depending on the ORDS configuration and the service invoked.'
version: 2026.03.26
title: Oracle REST Data Services Performance API
contact:
name: Oracle REST Data Services
url: https://www.oracle.com/database/technologies/appdev/rest.html
x-summary: Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API.
tags:
- name: Performance
description: Services related to the runtime performance of the Oracle database instance.
paths:
/database/performance/active_sessions_history/:
get:
tags:
- Performance
summary: Get all sampled session activity in the database
description: Oracle Diagnostics Pack licence is required for this service. Returns all records from GV$ACTIVE_SESSION_HISTORY. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of sampled session activity in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceActionSessionHistories'
x-internal-id: database-performance-active_sessions_history--get
x-filename-id: database-performance-active_sessions_history-get
/database/performance/active_sessions_history/{sample_id},{session_id}:
get:
tags:
- Performance
summary: Get a specified sampled session activity in the database
description: Oracle Diagnostics Pack licence is required for this service. Returns specified records from GV$ACTIVE_SESSION_HISTORY. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sample_id
in: path
description: ID of the sample.
required: true
schema:
type: number
- name: session_id
in: path
description: Session identifier for the sampled session.
required: true
schema:
type: number
responses:
'200':
description: Active session history record.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceActionSessionHistoriesItem'
x-internal-id: database-performance-active_sessions_history-{sample_id},{session_id}-get
x-filename-id: database-performance-active_sessions_history-sample_id-session_id-get
/database/performance/active_sessions_history_waits/:
get:
tags:
- Performance
summary: Get the last 10 wait events for each active session
description: Return records from GV$SESSION_WAIT_HISTORY. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of session wait history.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceActionSessionHistoryWaits'
x-internal-id: database-performance-active_sessions_history_waits--get
x-filename-id: database-performance-active_sessions_history_waits-get
/database/performance/active_sessions_history_waits/{sid},{seq_number}/:
get:
tags:
- Performance
summary: Get the specified wait event for specific active session
description: Return data from GV$SESSION_WAIT_HISTORY for the specified Session Identifier and Event Sequence Number. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session Identifier.
required: true
schema:
type: number
- name: seq_number
in: path
description: Sequence number of wait event; 1 is the most recent.
required: true
schema:
type: number
responses:
'200':
description: The session wait history for a particular session and event.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceActionSessionHistoryWaitsItem'
x-internal-id: database-performance-active_sessions_history_waits-{sid},{seq_number}--get
x-filename-id: database-performance-active_sessions_history_waits-sid-seq_number-get
/database/performance/active_sessions_history_waits/{sid},{seq_number}/active_sql:
get:
tags:
- Performance
summary: Get SQL statistics for a specific session
description: Return records from GV$SQLAREA for a given session with current waits on GV$SESSION_WAIT_HISTORY. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session Identifier.
required: true
schema:
type: number
- name: seq_number
in: path
description: Sequence number of wait event; 1 is the most recent.
required: true
schema:
type: number
responses:
'200':
description: Stastics on the SQL statements currently executing for specific session.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceActionSessionHistoryWaitsActiveSQLItem'
x-internal-id: database-performance-active_sessions_history_waits-{sid},{seq_number}-active_sql-get
x-filename-id: database-performance-active_sessions_history_waits-sid-seq_number-active_sql-get
/database/performance/sql_statements/:
get:
tags:
- Performance
summary: Get statistics for all SQL statements
description: Oracle Tuning Pack licence is required for this service. Returns data from GV$SQL with GV$SQL_MONITOR timing data. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all SQL statements in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatements'
x-internal-id: database-performance-sql_statements--get
x-filename-id: database-performance-sql_statements-get
/database/performance/sql_statements/{sql_id}/:
get:
tags:
- Performance
summary: Get statistics for a SQL statement
description: Oracle Tuning Pack licence is required for this service. Returns data from GV$SQL with GV$SQL_MONITOR timing data for the specified SQL statement identifier. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
responses:
'200':
description: Statistic for a SQL statement.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementsItem'
x-internal-id: database-performance-sql_statements-{sql_id}--get
x-filename-id: database-performance-sql_statements-sql_id-get
/database/performance/sql_statements/{sql_id}/monitor/:
get:
tags:
- Performance
summary: Get monitoring statistics for a SQL Statement
description: Oracle Tuning Pack licence is required for this service. Returns all GV$SQL_MONITOR records for a specified SQL_ID. GV$SQL_MONITOR will contain statistics only for SQL statements whose execution have been (or are being) monitored by Oracle. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all monitored SQL statements in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementMonitors'
x-internal-id: database-performance-sql_statements-{sql_id}-monitor--get
x-filename-id: database-performance-sql_statements-sql_id-monitor-get
/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/:
get:
tags:
- Performance
summary: Get information on a monitored statement
description: Oracle Tuning Pack licence is required for this service. Returns information on a monitored statement from GV$SQL_MONITOR view. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
- name: sql_exec_id
in: path
description: Execution identifier.
required: true
schema:
type: number
- name: sql_exec_start
in: path
description: Time when the execution started.
required: true
schema:
type: string
format: date-time
responses:
'200':
description: Description of a monitored SQL statement.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementMonitorsItem'
x-internal-id: database-performance-sql_statements-{sql_id}-monitor-{sql_exec_id},{sql_exec_start}--get
x-filename-id: database-performance-sql_statements-sql_id-monitor-sql_exec_id-sql_exec_start-get
/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/parallelism:
get:
tags:
- Performance
summary: Get parallel execution information for specific statement execution
description: Oracle Tuning Pack licence is required for this service. Returns information on a monitored statement that is executed in parallel. Using GV$SQL_MONITOR view, the information includes the Parallel Coordinator and the instance(s) where it was executed. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
- name: sql_exec_id
in: path
description: Execution identifier.
required: true
schema:
type: number
- name: sql_exec_start
in: path
description: Time when the execution started.
required: true
schema:
type: string
format: date-time
responses:
'200':
description: Returns information on a monitored statement. The structure of the data may vary depending on the database used.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementMonitorParallelism'
x-internal-id: database-performance-sql_statements-{sql_id}-monitor-{sql_exec_id},{sql_exec_start}-parallelism-get
x-filename-id: database-performance-sql_statements-sql_id-monitor-sql_exec_id-sql_exec_start-parallelism-get
/database/performance/sql_statements/{sql_id}/plan:
get:
tags:
- Performance
summary: Get execution plan for an SQL Statement
description: Returns all GV$SQL_PLAN records for a specified SQL_ID. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Execution plan for the specified SQL statement.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementPlanItem'
x-internal-id: database-performance-sql_statements-{sql_id}-plan-get
x-filename-id: database-performance-sql_statements-sql_id-plan-get
/database/performance/sql_statements/{sql_id}/history:
get:
tags:
- Performance
summary: Get historical statistics for a SQL statement
description: Oracle Diagnostics Pack licence is required for this service. Returns DBA_HIST_SQLSTAT and DBA_HIST_SNAPSHOT records for a specified SQL_ID. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Historical statistics for the specified SQL statement.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementHistoryItem'
x-internal-id: database-performance-sql_statements-{sql_id}-history-get
x-filename-id: database-performance-sql_statements-sql_id-history-get
/database/performance/sql_statements/{sql_id}/text:
get:
tags:
- Performance
summary: Get SQL statement
description: Returns records from GV$SQL for specified SQL_ID. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sql_id
in: path
description: SQL identifier.
required: true
schema:
type: string
responses:
'200':
description: The text of a specific SQL statement.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceSQLStatementTextItem'
x-internal-id: database-performance-sql_statements-{sql_id}-text-get
x-filename-id: database-performance-sql_statements-sql_id-text-get
/database/performance/top_sql_statements/:
get:
tags:
- Performance
summary: Get all SQL statements ordered by CPU time descending
description: Returns records from GV$SQL ordered by CPU time descending, SQL Text ascending. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of the SQL statements in the database ordered to show the top SQL statements first.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceTopSQLStatements'
x-internal-id: database-performance-top_sql_statements--get
x-filename-id: database-performance-top_sql_statements-get
/database/performance/top_sql_statements/maximums:
get:
tags:
- Performance
summary: Get SQL statistics maximum values
description: Returns maximum values for cpu time, elapsed time, disk reads, buffer gets and executions from GV$SQL. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Maximum values for SQL statement performance statistics recorded in GV$SQL.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceTopSQLStatementsMaximumsItem'
x-internal-id: database-performance-top_sql_statements-maximums-get
x-filename-id: database-performance-top_sql_statements-maximums-get
components:
schemas:
PerformanceActionSessionHistoryWaitsActiveSQLItem:
type: object
description: Describes statistics on an SQL statement that is in memory, parsed and ready for execution but waiting on an event. The list of attributes may vary depending on database version.
properties:
username:
type: string
description: Name of the user that is associated with the session that is waiting.
inst_id:
type: integer
description: Instance number from which the associated V$ view information was obtained.
sql_text:
type: string
description: First thousand characters of the SQL text for the current cursor.
sql_fulltext:
type: string
description: All characters of the SQL text for the current cursor.
sql_id:
type: string
description: SQL identifier of the parent cursor in the library cache.
sharable_mem:
type: integer
description: Amount of shared memory used by a cursor. If multiple child cursors exist, then the sum of all shared memory used by all child cursors.
persistent_mem:
type: integer
description: Fixed amount of memory used for the lifetime of an open cursor. If multiple child cursors exist, then the fixed sum of memory used for the lifetime of all the child cursors.
runtime_mem:
type: integer
description: Fixed amount of memory required during execution of a cursor. If multiple child cursors exist, then the fixed sum of all memory required during execution of all the child cursors.
sorts:
type: integer
description: Sum of the number of sorts that were done for all the child cursors.
version_count:
type: integer
description: Number of child cursors that are present in the cache under this parent.
loaded_versions:
type: integer
description: Number of child cursors that are present in the cache and have their context heap loaded.
open_versions:
type: integer
description: Number of child cursors that are currently open under this current parent.
users_opening:
type: integer
description: Number of users that have any of the child cursors open.
fetches:
type: integer
description: Number of fetches associated with the SQL statement.
executions:
type: integer
description: Total number of executions, totalled over all the child cursors.
px_servers_executions:
type: integer
description: Total number of executions performed by parallel execution servers (0 when the statement has never been executed in parallel).
end_of_fetch_count:
type: integer
description: Number of times this cursor was fully executed since the cursor was brought into the library cache. The value of this statistic is not incremented when the cursor is partially executed, either because it failed during the execution or because only the first few rows produced by this cursor are fetched before the cursor is closed or re-executed. By definition, the value of the END_OF_FETCH_COUNT column should be less or equal to the value of the EXECUTIONS column.
users_executing:
type: integer
description: Total number of users executing the statement over all child cursors.
loads:
type: integer
description: Number of times the object was loaded or reloaded.
first_load_time:
type: string
description: Timestamp of the parent creation time.
invalidations:
type: integer
description: Total number of invalidations over all the child cursors.
parse_calls:
type: integer
description: Sum of all parse calls to all the child cursors under this parent.
disk_reads:
type: integer
description: Sum of the number of disk reads over all child cursors.
direct_writes:
type: integer
description: Sum of the number of direct writes over all child cursors.
direct_reads:
type: integer
description: Sum of the number of direct reads over all child cursors.
buffer_gets:
type: integer
description: Sum of buffer gets over all child cursors.
application_wait_time:
type: integer
description: Application wait time (in microseconds).
concurrency_wait_time:
type: integer
description: Concurrency wait time (in microseconds).
cluster_wait_time:
type: integer
description: Cluster wait time (in microseconds).
user_io_wait_time:
type: integer
description: User I/O Wait Time (in microseconds).
plsql_exec_time:
type: integer
description: PL/SQL execution time (in microseconds).
java_exec_time:
type: integer
description: Java execution time (in microseconds).
rows_processed:
type: integer
description: Total number of rows processed on behalf of this SQL statement.
command_type:
type: integer
description: Oracle command type definition.
optimizer_mode:
type: string
description: Mode under which the SQL statement was executed.
optimizer_cost:
type: integer
description: Cost of this query given by the optimizer.
optimizer_env:
type: string
description: Optimizer environment.
optimizer_env_hash_value:
type: integer
description: Hash value for the optimizer environment.
parsing_user_id:
type: integer
description: User ID of the user that has parsed the very first cursor under this parent.
parsing_schema_id:
type: integer
description: Schema ID that was used to parse this child cursor.
parsing_schema_name:
type: string
description: Schema name that was used to parse this child cursor.
kept_versions:
type: integer
description: Number of child cursors that have been marked to be kept using the DBMS_SHARED_POOL package.
address:
type: string
description: Address of the handle to the parent for this cursor.
hash_value:
type: integer
description: Hash value of the parent statement in the library cache.
old_hash_value:
type: integer
description: Old SQL hash value.
plan_hash_value:
type: integer
description: Numeric representation of the current SQL plan for this cursor. Comparing one PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line).
full_plan_hash_value:
type: integer
description: Numeric representation of the complete SQL plan for this cursor. Comparing one FULL_PLAN_HASH_VALUE to another easily identifies whether or not two plans are the same (rather than comparing the two plans line by line). Note that the FULL_PLAN_HASH_VALUE cannot be compared across databases releases. It is not backward compatible.
module:
type: string
description: Contains the name of the module that was executing when the SQL statement was first parsed as set by calling DBMS_APPLICATION_INFO.SET_MODULE
module_hash:
type: integer
description: Hash value of the module that is named in the MODULE column.
action:
type: string
description: Contains the name of the action that was executing when the SQL statement was first parsed as set by calling DBMS_APPLICATION_INFO.SET_ACTION.
action_hash:
type: integer
description: Hash value of the action that is named in the ACTION column.
serializable_aborts:
type: integer
description: Number of times the transaction failed to serialize, producing ORA-08177 errors, totalled over all the child cursors.
outline_category:
type: string
description: If an outline was applied during construction of the cursor, then this column displays the category of that outline. Otherwise the column is left blank.
cpu_time:
type: integer
description: CPU time (in microseconds) used by this cursor for parsing, executing, and fetching.
elapsed_time:
type: integer
description: Elapsed time (in microseconds) used by this cursor for parsing, executing, and fetching. If the cursor uses parallel execution, then ELAPSED_TIME is the cumulative time for the query coordinator, plus all parallel query slave processes.
outline_sid:
type: string
description: Outline session identifier.
last_active_child_address:
type: string
description: Address (identifier) of the child cursor that was the last to be active in the group (that is, the child cursor on behalf of which statistics in GV$SQL were updated).
remote:
type: string
description: Indicates whether the cursor is remote mapped (Y) or not (N).
object_status:
type: string
description: Status of the cursor.
literal_hash_value:
type: integer
description: Hash value of the literals which are replaced with system-generated bind variables and are to be matched, when CURSOR_SHARING is used. This is not the hash value for the SQL statement. If CURSOR_SHARING is not used, then the value is 0.
last_load_time:
type: string
description: Time at which the query plan was loaded into the library cache.
is_obsolete:
type: string
description: Indicates whether the cursor has become obsolete (Y) or not (N). This can happen if the number of child cursors is too large.
is_bind_sensitive:
type: string
description: Indicates whether the cursor is bind sensitive (Y) or not (N). A query is considered bind-sensitive if the optimizer peeked at one of its bind variable values when computing predicate selectivities and where a change in a bind variable value may cause the optimizer to generate a different plan.
is_bind_aware:
type: string
description: Indicates whether the cursor is bind aware (Y) or not (N). A query is considered bind-aware if it has been marked to use extended cursor sharing. The query would already have been marked as bind-sensitive.
child_latch:
type: integer
description: Child latch number that is protecting the cursor. This column is obsolete and maintained for backward compatibility.
sql_profile:
type: string
description: SQL profile used for this statement, if any.
sql_patch:
type: string
description: SQL patch used for this statement, if any.
sql_plan_baseline:
type: string
description: SQL plan baseline used for this statement, if any.
program_id:
type: integer
description: Program identifier.
program_line#:
type: integer
description: Program line number.
exact_matching_signature:
type: integer
description: Signature used when the CURSOR_SHARING parameter is set to EXACT.
force_matching_signature:
type: integer
description: Signature used when the CURSOR_SHARING parameter is set to FORCE.
last_active_time:
type: string
description: Time at which the query plan was last active.
bind_data:
type: string
description: Bind data.
typecheck_mem:
type: integer
description: Typecheck memory.
io_cell_offload_eligible_bytes:
type: integer
description: Number of I/O bytes which can be filtered by the Exadata storage system.
io_interconnect_bytes:
type: integer
description: Number of I/O bytes exchanged between Oracle Database and the storage system.
physical_read_requests:
type: integer
description: Number of physical read I/O requests issued by the monitored SQL.
physical_read_bytes:
type: integer
description: Number of bytes read from disks by the monitored SQL.
physical_write_requests:
type: integer
description: Number of physical write I/O requests issued by the monitored SQL.
physical_write_bytes:
type: integer
description: Number of bytes written to disks by the monitored SQL.
optimized_phy_read_requests:
type: integer
description: Number of physical read I/O requests from Database Smart Flash Cache issued by the monitored SQL.
locked_total:
type: integer
description: Total number of times the child cursor has been locked.
pinned_total:
type: integer
description: Total number of times the child cursor has been pinned.
io_cell_uncompressed_bytes:
type: integer
description: Number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells.
io_cell_offload_returned_bytes:
type: integer
description: Number of bytes that are returned by Exadata cell through the regular I/O path.
con_id:
type: integer
description: The ID of the container to which the data pertains.
is_reoptimizable:
type: string
description: This columns shows whether the next execution matching this child cursor will trigger a reoptimization.
is_resolved_adaptive_plan:
type: string
description: This column shows whether all of the adaptive parts of a plan have been resolved to the final plan.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
PerformanceSQLStatementMonitors:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PerformanceSQLStatementMonitorsItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
PerformanceSQLStatementMonitorsItem:
type: object
description: This object provides statistics for a single execution of an SQL statement. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Instance number from which the associated GV$SQL_MONITOR view information was obtained.
key:
type: integer
# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-partitioning/refs/heads/main/openapi/oracle-partitioning-performance-api-openapi.yml