Analyze Short.io Data in Infragistics Reveal

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Short.io data. The CData API Server generates an OData API for Short.io, which is natively consumable in Reveal. In this article, we walk through connecting to Short.io in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to Short.io from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Open API Server and click Settings -> Connection -> Add Connection
2. Select "Short.io"
3. Enter the necessary authentication properties to connect to Short.io.

   Using API Key Authentication

   Short.io uses API Key authentication. To obtain your API key:

   1. Log in to your Short.io account
   2. Navigate to Settings > Integrations & API > API
   3. Click Create API Key and copy your API key

   After obtaining the API key, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

   Example connection string:

   Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

   Available Tables

   The Short.io profile provides access to the following tables:

   • Domains - Short.io domains associated with the authenticated account
   • Links - Short links for a domain
   • LinkExpand - Expand a short link by domain and path
   • LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
   • Folders - Link folders within a specific domain
   • LinkPermissions - Permission records for a specific link within a domain
   • CountryTargeting - Country-based redirect targeting rules for a specific short link
   • RegionTargeting - Region-based redirect targeting rules for a specific short link
   • Regions - List of available regions/states for a given country code
   • DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
   • LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link
   

Add Short.io Resource Definitions in API Server

After connecting to Short.io, create Resources, which represent API endpoints for Short.io data.

1. Click Settings -> Resources -> Add Resource
2. Select the Short.io connection
3. Select the table you wish to retrieve and click Next
4. (Optional) Edit the resource to select specific fields and more
5. Save the settings

Add an API Server User

Create a User to connect to Short.io from Reveal through API Server.

1. Click Settings -> Users
2. Click Add
3. Configure a User with access to the Short.io Connection and Resource(s)

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

• Enable cross-origin resource sharing (CORS): ON
• Allow all domains without '*': ON
• Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
• Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Create a Dashboard in Reveal

With the API Server configured, we can visualize Short.io data in Reveal.

1. Log into Reveal and click Dashboards -> New
2. Click Data Source -> OData Feed
3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
4. Select Generic Credentials and specify the API Server username and authentication token
5. Select the entity you wish to visualize
6. Select fields and choose a chart type

More Information & Free Trial

At this point, you have created a simple dashboard from live Short.io data. For more information on creating OData feeds from Short.io (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Short.io data in tools that consume OData APIs.