What's new in the REST API

MicroStrategy ONE (March 2024)

• Rename 'dossier' into 'dashboard'.
• Use MicroStrategy Bot APIs
• Support FFSQL cube and FFSQL IRR.

2021 Update 11

• Managing cluster startup membership configuration
• Update a table's physical table structure

2021 Update 10

• Manage Dashboard themes
• Retrieve, create, and update KPI objects and insights
• Change the owner of an object.
• Create a dashboard in memory based on a list of objects
• Retrieve a list of documents
• Retrieve the hierarchy of a document
• Enhancements for folder browsing
• License manager

2021 Update 9

• Retrieve gateway objects.
• Retrieve and update driver objects.
• Retrieve applicable properties for metrics.
• Execute a datamart.
• Advanced properties for attributes.
• Retrieve, create, and update warehouse / metadata partition mapping tables.
• Apply custom logos and colors to library.
• Manage mobile subscriptions.
• Edit migrations and migration groups

2021 Update 8

• Purge object and element caches.
• Delete a project in the project administration workflow.
• Retrieve, create, and update transaction report objects.
• Manage application customized emails.
• Advanced properties for database instances.
• Advanced properties for projects.
• Convert connection string from data source name(DSN) to DSN-less for a datasource.
• Manage Watch KPI and Insight service privileges.
• Manage quick search indices.
• Retrieve history lists.

2021 Update 7

• Object migration groups between environments.
• Upload and download migration packages.
• Retrieve, create, and update datamart objects.
• Retrieve, create, and update calendar objects.
• Retrieve, create, and update runtime objects.
• Retrieve, create, and update report objects.
• Ability to duplicate users.
• Configure and manage dynamic recipients lists for subscriptions.
• Ability to translate metadata objects.
• Retrieve, create, and update language objects.

2021 Update 6

• Create and edit user and workload fences
• Create and edit drill maps.
• Create and edit incremental refresh reports (IRR).
• Create and manage cube objects with advanced properties.
• Create and manage SAP HANA tables with input parameters using the modeling schema.
• Create and import migration packages just as in Workstation. This allows all packages to be managed by the MicroStrategy Storage Service so migration processes can be monitored in Workstation.

2021 Update 5

• Retrieve, create, and update metric objects.
• Retrieve, create, and update transformation objects.
• Retrieve, create, and update base formula objects.
• Retrieve, create, and update subtotal objects.
• Retrieve, create, and update cube objects.
• Create, edit, and delete history list subscriptions.

2021 Update 4

• Retrieve, create, and update content group objects.
• Retrieve, create, and update application objects.

2021 Update 3

• View a newly created migration package.
• View content from an uploaded migration package

2021 Update 2

• Create and manage user hierarchy objects through the Modeling service.
• Create and manage custom group objects through the Modeling service.
• Create and manage consolidation objects through the Modeling service.
• Create and import migration packages.
• Retrieve SQL statements and query details.

2021 Update 1

• Reload (update) the schema and manage the schema lock.
• Create and manage attribute objects and relationships through the Modeling service.
• Create and manage fact objects through the Modeling service.
• Create and manage table objects through the Modeling service, including user free-form SQL to create logic tables.
• Create and manage security filters through the Modeling service, including filter definition and user assignment.
• Create and manage derived elements through the Modeling service.
• Create and manage prompt objects through the Modeling service, including expression, object, attribute element, and value prompts.
• Dashboard API enhancements to enable interaction with filters and selectors.
• Create, update, and delete Distribution Services devices, events, transmitters, and contacts via APIs.
• Create, update, list, and delete devices for email and FTP device types.
• Create, update, list, and delete events.
• Create, update, list, and delete transmitters for email, FTP, file, print, iPhone/iPad, and Android.
• Create, update, list, and delete contacts.
• Schedule enhancement to support multiple days of the week or month, choosing first or last weekday of the week or month (excluding holidays), and choosing last day of the month.
• Update multi-content subscriptions.
• Datasource management API enhancements to configure job prioritization.

2021

• Identify applications to load on server startup.
• Manage filter objects through the Modeling service.
• Create and edit email subscriptions.
• List available recipients for a given user, including Shared List and Personal Addresses.
• Execute a single subscription on demand.
• Create, update, and delete schedules.
• Manage data sources with a complete set of REST APIs.
• Ability to request DateTime data to be returned from reports, cubes, and dashboards in the ISO 8601 format.
• Ability to update page-by selections for reports.
• Enhancement to APIs returning data from reports and cubes to allow the modification of attribute and metric template positioning.
• Enhancement to APIs that execute reports, cubes, and dashboards to allow the request for asynchronous executions.
• Monitor and manage cubes. This includes viewing and changing the status of a cube.
• Additional server and application level settings from MicroStrategy Developer are available in MicroStrategy Workstation.
• Ability to request object lineage information.
• Create, list, and delete multi-content subscriptions.

2020 Update 2

• Asynchronously extract data from reports, cubes. and dashboards.
• Exclude raw or formatted values to reduce the volume of data transferred when using report, cube, and dashboard data APIs.
• List available schedules and schedule metadata, such as schedule type and next delivery.
• List subscriptions and their recipients, content, and delivery information.
• Delete subscriptions.

2020 Update 1

• Manage server-level privileges
• Control the presence of subtotals in report data when consumed using REST.
• Generate report and cube instances asynchronously.

2020

• Obtain elements for answering attribute element prompts
• Obtain elements for answering object prompts
• New attribute qualification, [hierarchy qualificcommon-workflows/data-api/use-prompts-objects/prompt-types/hierarchy-qualification-prompts.mdmpts.md), [metricommon-workflows/data-api/use-prompts-objects/prompt-types/metric-expression-prompts.mdion-prompts.md)common-workflows/data-api/use-prompts-objects/prompt-types/level-prompts.mdvel-prompts.md) prompts.
• Improve performance by working with partial resources.
• Object prompt requests and responses use string values for attributes and metrics (attribute and metric) instead of integers (12 and 4).
• New Monitors API family, providing monitors for user connections, database connections, projects, and Intelligence Server Cluster.
• Add and remove nodes from the Intelligence Server Cluster.
• Manage projects by loading and unloading across the nodes in a cluster.
• New Security Role management APIs that allow you to create and assign privileges and manage memberships.
• View and disconnect database connections.
• The following settings are being retired beginning with MicroStrategy 2020 Update 1. While still exposed, the settings will not take effect if set below the default value for the setting. See, Server-Side Behavior Changes for Cache Settings for more information.

Setting Name	Corresponding REST API key	Default Value
Dataset - Maximum Number of Caches	maxReportCacheCount	100000
Formatted Documents - Maximum Number of Caches	maxRWDCacheCount	100000
Maximum number of cubes	maxCubeCount	100000

2019

• Push Data API has been enhanced.

The ability to make external data available to MicroStrategy—often referred to as the Push Data API—has been enhanced. The newest version of the Push Data API supports complex scenarios where a large number of columns/metrics need to be managed at a different update/load/refresh schedule. This is accomplished by separating dataset definition, data upload, and dataset creation, using multiple requests to incrementally add data before publication.

Performance was significantly improved for Data import using the Push Data API (with multiple requests), and issues were addressed for stability improvements.

• Filtering data has been enhanced

The REST API has been enhanced to support the ability to pass filters into the REST API endpoints.

• Support for prompts has been enhanced.

The REST API has been enhanced to support the ability to programmatically view, answer (with specific values, no answers, or default answers), and reset prompts on reports, dashboards, and documents.

• Exporting data has been enhanced.

The REST API now supports the export of cross-tabbed reports and report sub-totals. Additionally, the REST API has been enhanced to allow for greater scalability, so users can consume larger datasets in less time.

11.0

• Filtering data has been enhanced.

The REST API has been enhanced to support the ability to pass filters into the REST API endpoints.

• A new sample has been added to React user manager sample.

10.11

• The stand-alone JSON Data API Server has been removed.

The JSON Data API is made up of four different MicroStrategy API families. All of these families are part of the MicroStrategy REST Server, which is shipped inside the MicroStrategyLibrary.war web application.

10.10

• The REST API supports sorting for cubes and reports.
• The JSON Data API supports fetching data from a visualization inside an existing dashboard which can leverage advanced capabilities, such as the data blending engine and other complex analytics.
• The Cube API supports DDA cubes and MDX cubes, in addition to Intelligent cubes.

10.9

• The MicroStrategy REST API has been unified and expanded to include the following REST API families:
  • Authentication API
  • Browsing API
  • Cubes API
  • Datasets API
  • Datasource Management API
  • Dashboards and Documents API
  • Emails API
  • Library API
  • Object Management API
  • Projects API
  • Reports API
  • Security Roles API
  • System Administration API
  • User Management API
• The /reports endpoint accepts the requestedObjects parameter, allowing the caller to dynamically decide which objects to include on the template when the data is returned. Previously, only the /cubes endpoint accepted the requestedObjects parameter. However ,there is a difference in the implementation for reports and cubes. When requestedObjects is null for the /reports endpoint, the result of the original template is returned and nothing is done; for the /cubes endpoint, all attributes and metrics in the working set are added to the template and the result is run.
• You can view and use all of the MicroStrategy REST API endpoints in the MicroStrategy REST API Explorer.
• Quick Start Guides illustrate how to use the MicroStrategy REST API for common workflows, including folder browsing, [searcommon-workflows/modeling/object-discovery/search-for-objects.mdects.md), creating and modifying datasets, and exporting a document to PDF.
• The JSON Data API and Push Data API are part of the unified MicroStrategy REST platform. This platform is contained within the MicroStrategyLibrary war file, which can be deployed to application servers.
• The current packaging of the JSON Data API (jar deployment) has been deprecated. It will be supported until the next platform release.
• X-MSTR-ProjectID has been added for every endpoint to provide context. The X-MSTR-AuthToken stores a reference to all of the user's sessions in memory on the MicroStrategy REST Server, abstracting project session creation and management from the end user.
• The result format for error cases has been changed. This information is available in the MicroStrategy REST API Explorer.
• The version information included in the contentType and Accept headers has been removed.

10.8

There were no significant changes from the previous version.

10.7

• The JSON Data API content has been moved from the Web SDK and is part of the new REST API.
• A new RESTful Dataset API lets you modify a dataset that was created using the Dataset API. You can add new data and modify existing data in the dataset.

10.6

REST SDK content was included in the Web SDK, under the JSON Data API section, until 10.7.

• A new RESTful Dataset API lets you upload external data directly to the Intelligence Server.
• A new endpoint was added to the Cube API to get the cube definition and to the Report API to get the report definition.

10.5

REST SDK content was included in the Web SDK, under the JSON Data API section, until 10.7.

• A new RESTful View filter API lets you refine the data returned from a report or cube using a variety of operators.