Jump to

• Request
• Response

Get instance overview

get

/apex/statistics/overview

This service returns aggregated overview data for an Application Express instance. If number_of_days parameter is not specified the response is for upto 30 days of aggregated data. A client requires SQL Administrator role to invoke this service.

Request

Supported Media Types

• application/json

Query Parameters

• number_of_days(optional): integer(int32)
  Specifies the number of days into the past to aggregate data for.

Back to Top

Response

Supported Media Types

• application/json

200 Response

All APEX workspaces in the instance.

Body ()

Root Schema : APEXInstanceOverview

Type: object

Title: APEXInstanceOverview

This object represents aggregated data from APEX_APPLICATIONS record data.

Show Source

• active_apps_timeframe(optional): integer(int32)
  Total of applications with last_updated_on within this timeframe.
• active_developers_timeframe(optional): integer(int32)
  Total of distinct developers for applications active during this timeframe.
• apps_total(optional): integer(int32)
  Total number of APEX_APPLICATIONS records.
• links(optional): array links
• reporting_timeframe_since(optional): string
  Indicates the start date for records that this aggregated data is based on.
• reporting_timeframe_to(optional): string
  Indicates the end date for records that this aggregated data is based on.
• schemas_total(optional): integer(int32)
  Total number of distinct schemas with applications.
• workspaces_timeframe(optional): integer(int32)
  Total of distinct workspaces active during this timeframe.
• workspaces_total(optional): integer(int32)
  Total number of workspaces with applications.

{
    "title":"APEXInstanceOverview",
    "description":"This object represents aggregated data from APEX_APPLICATIONS record data.",
    "type":"object",
    "properties":{
        "active_apps_timeframe":{
            "description":"Total of applications with last_updated_on within this timeframe.",
            "type":"integer",
            "format":"int32"
        },
        "active_developers_timeframe":{
            "description":"Total of distinct developers for applications active during this timeframe.",
            "type":"integer",
            "format":"int32"
        },
        "apps_total":{
            "description":"Total number of APEX_APPLICATIONS records.",
            "type":"integer",
            "format":"int32"
        },
        "reporting_timeframe_since":{
            "description":"Indicates the start date for records that this aggregated data is based on.",
            "type":"string"
        },
        "reporting_timeframe_to":{
            "description":"Indicates the end date for records that this aggregated data is based on.",
            "type":"string"
        },
        "schemas_total":{
            "description":"Total number of distinct schemas with applications.",
            "type":"integer",
            "format":"int32"
        },
        "workspaces_timeframe":{
            "description":"Total of distinct workspaces active during this timeframe.",
            "type":"integer",
            "format":"int32"
        },
        "workspaces_total":{
            "description":"Total number of workspaces with applications.",
            "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