Jump to

• Request
• Response

Get instance statistics

get

/apex/statistics/instance/

This service returns usage statistics for the whole Oracle APEX instance. A client requires SQL Administrator role to invoke this service.

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer(int32)
  The maximum number of records to return.
• q(optional): string
  Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.

Back to Top

Response

Supported Media Types

• application/json

200 Response

All usage statistics for the Oracle APEX instance.

Body ()

Root Schema : APEXUsageStatistics

Type: object

Title: APEXUsageStatistics

Show Source

• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Indicates if there are more records to be retrieved.
• items(optional): array items
• limit(optional): integer(int32)
  The actual page size limit on number of records applied by the server.
• links(optional): array links
• offset(optional): integer(int32)
  The actual index from which the item resources are returned.

{
    "title":"APEXUsageStatistics",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/APEXUsageStatisticsItem"
            }
        },
        "hasMore":{
            "description":"Indicates if there are more records to be retrieved.",
            "type":"boolean"
        },
        "limit":{
            "description":"The actual page size limit on number of records applied by the server.",
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "description":"The actual index from which the item resources are returned.",
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "description":"Total number of records in the current response.",
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object APEXUsageStatisticsItem
  Title: APEXUsageStatisticsItem

  This object represents a APEX_WORKSPACE_LOG_ARCHIVE record of page view activity. Page view activity is a daily summary of workspace activity that is retained until physically purged.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/APEXUsageStatisticsItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation
  Title: LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

Nested Schema : APEXUsageStatisticsItem

Type: object

Title: APEXUsageStatisticsItem

This object represents a APEX_WORKSPACE_LOG_ARCHIVE record of page view activity. Page view activity is a daily summary of workspace activity that is retained until physically purged.

Show Source

• application_id(optional): integer(int32)
  Application ID for which this page view log was recorded.
• application_name(optional): string
  Application Name for which this page view log was recorded.
• average_render_time(optional): number(double)
  Summarized information by day, application and workspace.
• builder_events(optional): integer(int32)
  TBD
• distinct_pages(optional): integer(int32)
  Summarized information by day, application and workspace of the number of distinct pages used.
• distinct_sessions(optional): integer(int32)
  Summarized information by day, application and workspace of the number of distinct sessions.
• distinct_users(optional): integer(int32)
  Summarized information by day, application and workspace of the number of distinct users.
• error_count(optional): integer(int32)
  Summarized information by day, application and workspace of the number of errors.
• links(optional): array links
• log_day(optional): string
  Total not null interactive report search values logged to the activity log.
• maximum_render_time(optional): number(double)
  Summarized information by day, application and workspace indicating maximum render time.
• median_render_time(optional): number(double)
  Summarized information by day, application and workspace indicating median render time.
• page_events(optional): integer(int32)
  Total number of page events logged for a given day, application and workspace.
• public_page_events(optional): integer(int32)
  Total public page events for a given day, application and workspace.
• total_render_time(optional): number(double)
  Summarized information by day, application and workspace indicating total render time.
• workspace_id(optional): integer(int32)
  Identifies workspace.
• workspace_login_events(optional): integer(int32)
  Total workspace login events by day, application and workspace.

{
    "title":"APEXUsageStatisticsItem",
    "description":"This object represents a APEX_WORKSPACE_LOG_ARCHIVE record of page view activity. Page view activity is a daily summary of workspace activity that is retained until physically purged.",
    "type":"object",
    "properties":{
        "application_id":{
            "description":"Application ID for which this page view log was recorded.",
            "type":"integer",
            "format":"int32"
        },
        "application_name":{
            "description":"Application Name for which this page view log was recorded.",
            "type":"string"
        },
        "average_render_time":{
            "description":"Summarized information by day, application  and workspace.",
            "type":"number",
            "format":"double"
        },
        "builder_events":{
            "description":"TBD",
            "type":"integer",
            "format":"int32"
        },
        "distinct_pages":{
            "description":"Summarized information by day, application and workspace of the number of distinct pages used.",
            "type":"integer",
            "format":"int32"
        },
        "distinct_sessions":{
            "description":"Summarized information by day, application and workspace of the number of distinct sessions.",
            "type":"integer",
            "format":"int32"
        },
        "distinct_users":{
            "description":"Summarized information by day, application and workspace of the number of distinct users.",
            "type":"integer",
            "format":"int32"
        },
        "error_count":{
            "description":"Summarized information by day, application and workspace of the number of errors.",
            "type":"integer",
            "format":"int32"
        },
        "log_day":{
            "description":"Total not null interactive report search values logged to the activity log.",
            "type":"string"
        },
        "maximum_render_time":{
            "description":"Summarized information by day, application and workspace indicating maximum render time.",
            "type":"number",
            "format":"double"
        },
        "median_render_time":{
            "description":"Summarized information by day, application and workspace indicating median render time.",
            "type":"number",
            "format":"double"
        },
        "page_events":{
            "description":"Total number of page events logged for a given day, application and workspace.",
            "type":"integer",
            "format":"int32"
        },
        "public_page_events":{
            "description":"Total public page events for a given day, application and workspace.",
            "type":"integer",
            "format":"int32"
        },
        "total_render_time":{
            "description":"Summarized information by day, application and workspace indicating total render time.",
            "type":"number",
            "format":"double"
        },
        "workspace_id":{
            "description":"Identifies workspace.",
            "type":"integer",
            "format":"int32"
        },
        "workspace_login_events":{
            "description":"Total workspace login events by day, application and workspace.",
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation
  Title: LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Title: LinkRelation

Show Source

• href: string
• rel: string

{
    "title":"LinkRelation",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top