Skip to main content
Español (Latinoamérica) Français 简体中文

Exporting a data source as a custom API

Rebecca Stewart
  • Updated

Make any data source in Horizon available as a custom API.

Note: Some parameters are not supported for more information, visit the Vista Developer Portal. 

Before you begin

Steps

Important! Data sources exported to custom APIs are removed from Horizon > Data sources. 

  1. In Horizon, go to Operations > Data sources.
  2. In the menu for your datasource, click Permissions.
  3. In the dropdown menu, select Public.
  4. Click Done.
  5. In the menu for your datasource, click Change category. 
  6. In the dropdown menu, select Custom API.
  7. Click Done.

You have added a new entry to Horizon > Custom APIs and your API is now available for developers in the custom API catalog. This is the final step in creating a custom API.

Note: Custom APIs listed here are executable as data sources, but not editable. 

See also:

 

Related articles

Comments

3 comments

Date Votes
  • Brett Shaffer
    • Edited

    I tried following this document recently and ran into some trouble. Here are the steps I followed with some help from support to get my endpoint to show on the catalog.

    • Create a new dashboard in Horizon. It will act as a placeholder for the data source. The category doesn't matter. 
    • Select the data source you wish to convert to a custom endpoint. Click Create.
    • Once you're in the dashboard builder, open the dashboard menu. Click "Export data source".
    • Select the data source. Name it something unique as it will be the source name in the API catalog. Click Export.
    • The source you just created will now show in the Data Sources section on the Horizon home page. 
    • Click the drop-down arrow to the right of the source, use the “Change share permissions” button to set visibility to “Everyone”.
    • Click the drop-down again and use the “Change category” button. Set the category to custom API. 
    • If done properly, the data source you exported from the dashboard will show under the Custom APIs section and be classified with the type “Data Source”. It will be available immediately in the custom API catalog. You can delete the placeholder dashboard that you created in step 1. 
    0
  • Chris Lovie-Tyler

    Thanks so much for the detailed comment, Brett! That's really helpful.

    I've put this on our to-do list so we remember to make improvements to the article when we get a chance.

    0
  • Brett Shaffer

    happy to help!

    0

Please sign in to leave a comment.