Custom APIs

Our custom APIs are designed by you, providing tailored solutions to optimise your workflows. Custom APIs are optimised for simple data retrieval with a limited number of linked sources.

Creating a custom API

Custom APIs are created and then exported from Horizon. For detailed instructions and limitations, see Creating custom APIs on the Vista Help Centre.

Accessing custom APIs

Access your custom APIs in your Custom API catalog.

For information on gaining your API token and API key, see Security.

Limitations

• Custom APIs are optimised for simple data retrieval with a limited number of linked sources. API responses are limited to 50,000 records, so data sources returning large volumes of data may require you to implement custom pagination in your Horizon data source.
• Custom APIs that take longer than 30 seconds to execute are at risk of having their execution being terminated during infrastructure updates. You may wish to contact the owner of the data source to reduce the execution time. Additionally, we recommend following best practices around handling disconnects by retrying requests.

Example response

{
  "schema": {
    "Business Date": {
      "type": "date"
    },
    "Cinema": {
      "type": "string"
    }
  },
  "data": [
    {
      "Business Date": "2016-12-26T00:00:00",
      "Cinema": "ABC New York",
    },
    ...
  ],
  "dataTruncated": true
}