Skynamo Reporting API and Power BI Connector

  • Updated

Welcome to the wonderful World of Skynamo Analytics!

Skynamo has a brand-new reporting API specifically designed to get your Skynamo data for the purpose of reporting. As well as a custom connector for Power BI specifically developed to use this new reporting API!

How to get access?

The good things in life are never free, and the same goes for access to the Skynamo Reporting API and the Skynamo Analytics Power BI Connector.

Log a request for access with Skynamo Support (support@skynamo.com) or your Customer Success Member. They will be able to provide you with a quote.

Please note that while the Reporting API and connector are in Beta no costing will be incurred

The following information will be required:

  • Customer Name
  • Skynamo Instance Name
  • Email address of contact person who will be working with the API connection.
  • Whether you will require access to the Skynamo Analytics Power BI Connector.

After the above has been done, approved, and paid you will be provided with:

  1. Credentials to access your Skynamo data through the reporting API (Client ID, Client Secret).
  2. The Skynamo Analytics Power BI custom connector file (SkynamoAnalytics.pqx). As well as the thumbprint to trust the provided connector.

I have access, now what?

 

1.Reporting API

For more information on using the Reporting API and examples go to the Swagger documentation:

https://analytics-api.svc.za.skynamo.me/swagger/index.htmlmceclip1.png

The provided credentials can be used in a CURL request (see below) to get an access token to Login by clicking on Authorize.

curl --request POST \

--url https://dev-9p75rrqx.eu.auth0.com/oauth/token \

--header 'content-type: application/json' \

--data '{"client_id":"<CLIENTID>","client_secret":"<CLIENTSECRET>","audience":"https://analytics.skynamo.com/","grant_type":"client_credentials"}'

 

2. Power BI Custom Connector

Have you heard of Power BI?

This connector was specifically created for Power BI. Therefore, to use it requires the Power BI Desktop app or a workspace with access to the connector on Power BI Service.

Power BI Desktop is easy to install, and no license is required if you are only developing reports for your own purposes.

For a team to be able to access and use the connector to develop, share, and edit reports will require that each user has, at least, a Power BI Pro license. Read more about the licensing options here.

Where to place the Skynamo Analytics Power BI Connector file?

The Skynamo Analytics Power BI Connector is still in development. Therefore, the connector is expected to be changed and updated in the future. We will strive to ensure that you always have the latest version of the connector.

The below once-off setup will need to be done on a personal computer if only required for personal use.

The below once-off setup will need to be done on the computer used for the Power BI On-Premises Data Gateway if it is to be used by a Team with workspaces on Power BI Service.

Once-off Setup

  1. Download and install Power BI Desktop
  2. Place the provided Skynamo Analytics Power BI Connector file (SkynamoAnalytics.pqx) in the below file path. Create the path if it does not exist.

C:\…\Documents\Power BI Desktop\Custom Connectors

image.png

  1. Trust the provided connector (Admin rights on the computer is required)
    1. Double click on the provided .reg file and follow the prompts.
    2. The above will add a registry entry (in the Registry Editor) to the following registry path as shown in the screenshot:

HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Power BI Desktop

mceclip0.png

How to use the connector?

  1. Open Power BI Desktop.
  2. Set CURRENT FILE settings to reduce stress on server:
    • Go to File > Options and settings > Options
    • Scroll down to the CURRENT FILE section and click on Data Load
    • De-select the following settings:
      • Background Data > Allow data preview to download in the background
      • Parallel loading of tables > Enable parallel loading of tables
    • Click OK

mceclip4.png

 

  1. Select the connector under Other using Get Data.
    mceclip5.png
  2. Connect to the Skynamo Reporting API.

The following inputs are requested:

  • Skynamo Instance Name (Required)
  • Client ID (Required) - Skynamo Reporting API credentials
  • Client Secret (Required) - Skynamo Reporting API credentials
  • Reporting Period (Optional) - Defaults to the last 30 days.
  • Financial Year start date - Defaults to 1 January.

mceclip6.png

mceclip7.png

  1. The Navigator Page shows 18 tables available for selection. To select the tables to include on Load/Transform Data:
    • Click on the radio button next to the relevant table.
    • A preview of the data in that table (Top 1000 rows) will be evaluated and shown.
    • Repeat the above for all the tables you want to include.
    • Click on Load to load the selected tables into Power BI Desktop or Transform Data to implement some transformations before loading the selected tables into Power BI Desktop.mceclip8.png
  2. Use the selected tables and Visualizations to create a report.
  3. If required publish the report to Power BI Services.

mceclip9.png

The Data

The Reporting API has four endpoints that returns data for 19 entities/tables.

The Skynamo Analytics Power BI custom connector makes the calls to the Skynamo API to get the data from the 19 entities. The data is then transformed and shown in 21 tables in the Navigational table. The 21 tables are shown in the below table.

Entity

Notes

Users End Point – Returns User and User related entity data

Users

User details on Skynamo.

Travel Claims

The travel claims logged per user per day on Skynamo app.

User Time Segments

The ‘on clock’ and driving time captured on Skynamo app per user per day.

Tasks

The activity_id field will only be populated if the task (Scheduled Visit or Task) has been completed on Skynamo.

User Targets

The sales target per user per month that has been loaded on Skynamo.

Activities End Point – Returns Activity and Activity related entity data

Activities

The activities captured on Skynamo, example Visits, Forms, Orders, etc.

Credit Requests

The credit requests captured by a user for a customer on Skynamo.

Quotes

The quotes captured by a user for a customer on Skynamo.

Orders

The orders captured by a user for a customer on Skynamo.

Surveys

The surveys captured by a user at a customer on Skynamo.

Forms

The forms completed by a user on Skynamo. Form details, questions and answers are returned in the json_view field.

Customers End Point – Returns Customer and Customer related entity data

Customers

Customer details on Skynamo. Custom field data is returned in the json_view field.

Customer Users

The customer user assignments on Skynamo.

Invoices

The invoices that have been imported from a financial system/ERP into Skynamo.

Customer Targets

The sales target per customer per month that has been loaded on Skynamo.

Products End Point – Returns Product and Product related entity data

Products

Product details on Skynamo. Custom field data is returned in the json_view field.

 

The columns returned per table have been limited to improve the efficiency of the connector. For example, the Travel Claims entity returned by the Reporting API has the user_id and display_name fields, the same table in the connector only shows the userid column. The displayname value can be retrieved from 01 Users, using the link between the userid column in both tables.

The following images show the entity relationship diagrams per Reporting API End Point for all the tables related to that end point as the tables appear in the Skynamo Analytics Power BI custom connector. The relationships between End Points are also indicated. The main table of each end point has a pink border.

mceclip1.png

ERD of Power BI Tables from Skynamo Reporting API Users End Point

mceclip3.png

ERD of Power BI Tables from Skynamo Reporting API Activities End Point

mceclip4.png

ERD of Power BI Tables from Skynamo Reporting API Customers End Point

mceclip5.png

ERD of Power BI Tables from Skynamo Reporting API Products End Point

 

 

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.