How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Platforms Analytics API

The analytics API from Oracle Platforms — 19 operation(s) for analytics.

Oracle Platforms Analytics API is one of 11 APIs that Oracle Platforms publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and pricing.

This API exposes 29 operations across 19 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 20190331.

Requests are made against a single base URL, /20190331.

29 operations 19 paths 29 schemas 5 DELETE9 GET11 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20190331
Base URL
https://iaas.{region}.oraclecloud.com
License
Oracle Corporation
Resource Areas
1

Paths & Operations 29

Across 19 paths, the API surfaces 29 operations — 5 DELETE, 9 GET, 11 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

analytics 29
GET
/analyticsInstances
List Analytics instances.
ListAnalyticsInstances 10 params → 200400401404429500default
POST
/analyticsInstances
Create an Analytics instance.
CreateAnalyticsInstance 2 params body → 201400401404409412429500
DELETE
/analyticsInstances/{analyticsInstanceId}
Delete an Analytics instance.
DeleteAnalyticsInstance 4 params → 204400401404409412429500
GET
/analyticsInstances/{analyticsInstanceId}
Retrieve Analytics instance metadata.
GetAnalyticsInstance 2 params → 200400401404429500default
PUT
/analyticsInstances/{analyticsInstanceId}
Update an Analytics instance.
UpdateAnalyticsInstance 3 params body → 200400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/changeCompartment
Change the compartment of an Analytics instance.
ChangeAnalyticsInstanceCompartment 4 params body → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/changeNetworkEndpoint
Change the network endpoint for an Analytics instance.
ChangeAnalyticsInstanceNetworkEndpoint 4 params body → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/scale
Scale an Analytics instance up or down.
ScaleAnalyticsInstance 4 params body → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/setFeatureBundle
Set the feature bundle of an Analytics instance.
SetFeatureBundle 4 params body → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/setKmsKey
Encrypts customer data with an OCI vault key or reverts back to an Oracle-managed key.
SetKmsKey 4 params body → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/start
Starts the specified Analytics instance.
StartAnalyticsInstance 4 params → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/actions/stop
Stop the specified Analytics instance.
StopAnalyticsInstance 4 params → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/privateAccessChannels
Create a private access channel for the Analytics instance.
CreatePrivateAccessChannel 3 params body → 202400401404409412429500
DELETE
/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}
Delete private access channel with given unique identifier key, for an Analytics instance.
DeletePrivateAccessChannel 5 params → 204400401404409412429500
GET
/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}
Retrieve private access channel for the specified Analytics Instance.
GetPrivateAccessChannel 3 params → 200400401404429500default
PUT
/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}
Update the private access channel.
UpdatePrivateAccessChannel 5 params body → 202400401404409412429500
GET
/analyticsInstances/{analyticsInstanceId}/resourceGroups
List resource groups for an instance.
ListResourceGroups 7 params → 200400401404429500default
POST
/analyticsInstances/{analyticsInstanceId}/resourceGroups
Create a resource group for the Analytics Instance.
CreateResourceGroup 3 params body → 201400401404409412429500
DELETE
/analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId}
Delete a resource group for the Analytics Instance.
DeleteResourceGroup 5 params → 204400401404409412429500
GET
/analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId}
Gets one of the resource groups for an instance
GetResourceGroup 3 params → 200400401404429500default
PUT
/analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId}
Update a resource group for an instance
UpdateResourceGroup 5 params body → 202400401404409412429500
POST
/analyticsInstances/{analyticsInstanceId}/vanityUrls
Create a vanity URL for the Analytics instance.
CreateVanityUrl 3 params body → 202400401404409412429500
DELETE
/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}
Delete a vanity URL for the Analytics instance.
DeleteVanityUrl 5 params → 202400401404409412429500
PUT
/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}
Upload a new certificate for a vanity URL.
UpdateVanityUrl 5 params body → 202400401404409412429500
GET
/workRequests
List all work requests.
ListWorkRequests 9 params → 200400401404429500default
DELETE
/workRequests/{workRequestId}
Cancel a work request.
DeleteWorkRequest 3 params → 204400401404409412429500
GET
/workRequests/{workRequestId}
Get work request details.
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Get work request errors.
ListWorkRequestErrors 4 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Get work request logs.
ListWorkRequestLogs 4 params → 200400401404429500default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are AnalyticsInstance (23 properties), AnalyticsInstanceSummary (16 properties), CreateAnalyticsInstanceDetails (16 properties), WorkRequest (9 properties). Each schema is shown below with its type and property counts.

AnalyticsInstanceSummary
object
Analytics Instance metadata (summary view).
16 properties 8 required
PrivateSourceScanHost
object
Private source SCAN hostname model.
3 properties 2 required
CreateVanityUrlDetails
object
Input payload to create a vanity URL.
6 properties 4 required
PrivateAccessChannel
object
Analytics instance private access channel model.
9 properties 6 required
WorkRequestError
object
Error encountered during the execution of a work request.
3 properties 3 required
AnalyticsInstance
object
Analytics instance metadata.
23 properties 8 required
WorkRequestSummary
object
An asynchronous work request.
8 properties 6 required
WorkRequest
object
An asynchronous work request.
9 properties 7 required
SetKmsKeyDetails
object
Input payload to reset the OCI vault encryption key.
1 property 1 required
ScaleAnalyticsInstanceDetails
object
Input payload to scale an Analytics instance up or down.
1 property 1 required
InstanceResourceGroup
object
Resource Groups for Instance
5 properties 3 required
SetFeatureBundleDetails
object
Input payload for the feature set of an Analytics instance.
1 property
ChangeCompartmentDetails
object
Input payload to change a resource's compartment.
1 property 1 required
WorkRequestLog
object
Log entries related to a specific work request.
2 properties 2 required
Capacity
object
Service instance capacity metadata (for example, OLPU count, number of users, and so on).
2 properties 2 required
CreateAnalyticsInstanceDetails
object
Input payload to create an Anaytics instance.
16 properties 5 required
UpdatePrivateAccessChannelDetails
object
Input payload to update a private access channel.
6 properties
UpdateAnalyticsInstanceDetails
object
Input payload to update an Analytics instance. Fields that aren't provided won't be updated.
6 properties
Error
object
2 properties 2 required
NetworkEndpointDetails
object
Base representation of a network endpoint.
1 property 1 required
InstanceResourceGroupSummary
object
Resource Groups for Instance
5 properties 3 required
CreateResourceGroupDetails
object
Input payload to create resource group.
4 properties 2 required
VanityUrlDetails
object
Vanity URL configuration details.
5 properties
CreatePrivateAccessChannelDetails
object
Input payload to create a private access channel.
6 properties 4 required
UpdateResourceGroupDetails
object
Input payload to update a resource group.
4 properties 2 required
ChangeAnalyticsInstanceNetworkEndpointDetails
object
Input payload to update endpoint details for an Analytics instance.
1 property 1 required
WorkRequestResource
object
5 properties 4 required
UpdateVanityUrlDetails
object
Input payload to update a vanity URL.
4 properties 3 required
PrivateSourceDnsZone
object
Private source DNS zone model.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-platforms-analytics-api-openapi.yml Raw ↑

Other APIs Oracle Platforms publishes across the network.

Oracle Fusion Cloud ERP API
Oracle APEX REST APIs
Oracle Platforms Blockstorage API
Oracle Platforms Compute API
Oracle Platforms Compute Management API
Oracle Platforms Database API
Oracle Platforms Data Science API
Oracle Platforms Integration Instance API
Oracle Platforms Oce Instance API
Oracle Platforms Virtual Network API
Where this information came from

This is an independent, third-party profile of Oracle Platforms Analytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.