About the REST APIs

Use the REST APIs for Oracle Analytics Cloud to automate processes and programmatically access features and functionality in Oracle Analytics Cloud.

API Version

The base path of the endpoint includes the API version (for example, 20210901). Here's an example POST request to create a new snapshot:

POST https://<myOACinstance>.analytics.ocp.oraclecloud.com/api/20210901/snapshots

API Breaking Changes Policy

Oracle will provide 12 months advance notice prior to the date of removing or changing an existing API that you have deployed which would require you to update your code.

Authentication

To access Oracle Analytics Cloud REST APIs, you need an OAuth 2.0 access token. See Authenticate.

Referencing Objects

When you reference objects using the REST API URI you must encode their ID values with Base64URL. See Base64URL Standards.

For example, if you want to reference a dataset with the object ID 'john.smith@mycompany.com'.'MySalesDataset' you must encode the object ID value with Base64URL (J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw) before referencing it:

/api/20210901/catalog/datasets/{ID encoded as Base64URL}.

You can view a list of all REST endpoints in this API.