Manage API Subscriptions for Data Exports

You can manage your Data Export Service API subscriptions in the Modeler.

In the Data Management screen, under the API Subscriptions tab, you can find a list of all the subscriptions of a model. It offers a visual interface to the Data Export Service for subscription management as part of the delta functionality.
Note
This section doesn't cover the delta functionality, and instead focuses on the subscriptions management capabilities available in the API Subscriptions tab within the Modeler. For more information on the delta functionality and subscriptions, please refer to the Data Export Service documentation.

Create a New Subscription

Context

You can create a subscription to a model to track data changes. The tracking starts as soon as you create a subscription and ends when you run a delta export. Within that time frame, every data change is monitored.

Procedure

  1. In the Modeler, go to the Data Management screen.
  2. Click the API Subscriptions tab.
    The subscriptions of your model are displayed here if there are any.
  3. To create a new subscription, click .
    The Create Subscription dialog displays.
  4. Give a name to the subscription.
  5. Specify the External ID.
  6. Click Filter Dimensions in the left panel of the Create Subscription dialog.
  7. Optional: Click next to a dimension to filter out members. For date dimensions, use the calendar widget to enter the start and end dates.
  8. Click Select Measures in the left panel of the Create Subscription dialog.
  9. Use the checkboxes to select the measures whose data you want to track with the subscription.
  10. Click Create to close the Create Subscription dialog, and click in the API Subscriptions tab to update the subcriptions list.

Results

The subscription you’ve created is now listed in the API Subscriptions tab.

Copy a Subscription Delta Link

Context

You can copy a subscription URL for future reuse in target systems to retrieve data.

Procedure

  1. In the Modeler, go to the Data Management screen.
  2. Click the API Subscriptions tab.
  3. Use the checkboxes to select a subscription.
  4. Click View Details.
  5. In the Subscription Detail dialog, click the chain icon.
    You can also select a subscription in the API Subscriptions tab, click and select Copy URL.

Delete a Subscription

Procedure

  1. In the Modeler, go to the Data Management screen.
  2. Click the API Subscriptions tab.
  3. Use the checkboxes to select one or multiple subscriptions.
  4. Click .
    You can also select a subscription in the API Subscriptions tab, click and select Delete.
  5. Click to refresh the subscriptions list.

Results

The subscription has been deleted and no longer appears in the subscriptions list.