1. Curator Styles

    2. Homepage

    3. Titles and Toolbars

    4. Group Overrides

    1. Pages Overview

    2. Tiles

    3. SSRS Embedding

    4. Explorer

    5. User Customized Metrics

    6. Error Pages

    1. Tutorials

    2. Search

    3. Managing Menus

    4. Menu Items

    5. Keywords

    6. Files

    7. Notices

    8. Loading Screens

    1. Embedded Tableau Server Views

    2. Thumbnails

    3. Tagged Workbooks

    4. Favorites

    5. Email Subscriptions

    6. Data Export

    7. Download Workbook

    8. Share Workbook

    9. Custom Views

    10. Pause/Resume Changes

    11. Dashboard Titles

    1. Filters

    2. Parameters

    3. Apply Button

    4. Filter Categories

    5. Hidden Sticky Filters/Parameters

    6. Specify Filter Sheet

    7. Mark Commenting

    8. URL Action Overrides (Link Target)

    9. Hidden Dashboards

    10. Replace Dashboard URLs

    11. Site Switcher

    12. Cache Filter/Parameter Options

    1. Data Manager Basics

    2. Web Data Connector (WDC)

    3. Connecting to Data Manager

    4. User Commenting

    5. Field Calculations

    1. Overview and Enabling

    2. Report Builder: Email Option

    3. Report Builder: Watermark Text

    4. Report Builder: Scheduled Reports Option

    1. Automatic License Provisioning

    2. Just-in-time (JIT) Provisioning

    3. Users and Groups

    4. Reset User's Password

    5. User Sync and Membership Sync Overview

    6. Custom Attributes

    1. Frontend User Permissions

    2. Password Change

    3. Password Reset

    4. Password Expiration and Complexity

    5. Bypass Link-preview Security

    1. E-mail Configuration

    2. System Notifications

    1. Force SSL

    2. Trusted Tickets

    3. Basic HTTP Authentication

    1. Import / Export

    2. Backend Users

    3. Frontend Users

    4. Updating License Key

    5. Linux: Cron Troubleshooting

    6. Filesystem Permissions

    7. Backend Administrator Password Reset

    8. Dependency Updates

    9. Updating Curator Logging

    10. Third Party Cookies

    11. Troubleshooting Load Times

    12. Manual Restoration of Curator Backup

    13. Curator Backup

    14. Taking a Manual Full Backup

    1. System Upgrade

    2. Disable Curator Upgrades

    3. Offline Upgrades (Airgapped)

    4. Troubleshooting Upgrades

    1. Scripts

    2. Commands

    3. Subscription Routing

    1. Curator API Overview

    2. Integration

    3. Curator API

    4. Tableau API

    5. Content

    6. User API

    1. Username Mapping

Documentation: API Docs

Curator API Overview

The Integration System gives you many options for interfacing programmatically with the backend. This API gives you access to the metadata behind your portal content as well as the ability to update content and run integration commands. Before you do, though, you'll need an API Key and the endpoint!

1. Obtaining an API Key

To access the API, you will need an API key. You can create an API Key in the /backend area of your portal. API Keys are managed in Settings -> API Keys

2. Accessing the API

Once you have an API Key, you can access the API through the "api" folder on your portal's URL. For example: https://yourportal.example.com/api/v1/portal/upgrade?apikey=my_api_key_here

3. API Response

All of the Integration System's APIs return JSON. You can convert this easily to an array in most languages. (json_decode, for example, in PHP)

Auto Generate API Links

You can also use Curator's backend to generate links to the various Curator API endpoints

  1. Login to the backend of your Curator instance (e.g. https://www.site.com/backend).
  2. Navigate to the Settings > Curator > API Keys section from the left-hand menu.
  3. Change the dropdowns in the REST API to the respective endpoint you would like to try.
  4. Use the preview link generated below the dropdowns to start using the endpoint. Note: Some variables may be missing from these preview links.