FastSpring Connector for Power BI

In this article you will learn how to integrate FastSpring data in Power BI without coding in just a few clicks (live / bi-directional connection to FastSpring). Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding..

Using FastSpring Connector you will be able to connect, read, and write data from within Power BI. Follow the steps below to see how we would accomplish that.

Download Documentation

Video Tutorial - Integrate FastSpring data in Power BI

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download / install required driver for FastSpring integration in Power BI
  • How to configure connection for FastSpring
  • Features about API Driver (Authentication / Query Language / Examples / Driver UI)
  • Using FastSpring Connection in Power BI

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from FastSpring using Power BI we first need to create a DSN (Data Source) which will access data from FastSpring. We will later be able to read data using Power BI. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
  4. When the Configuration window appears give your data source a name if you haven't done that already, then select "FastSpring" from the list of Popular Connectors. If "FastSpring" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    FastspringDSN
    FastSpring
    ODBC DSN Template Selection

  5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Steps how to get and use FastSpring credentials : Http [Http]
    Here is how to obtain API Credentials. You might be able to use your Account Login UserId / Password but we do not reccomend using it. Instead of that use API credentials generated using the following way.
    1. In the FastSpring App, navigate to Developer Tools > APIs > API Credentials.
    2. Click Create. FastSpring will automatically generate your username and password. Use this on the API connection UI
    3. Securely store the credentials for future reference.
    4. If you reset your credentials, update each stored procedure that relies on API access to prevent failed requests.

    Fill in all required parameters and set optional parameters if needed:

    FastspringDSN
    FastSpring
    Http [Http]
    https://api.fastspring.com
    Optional Parameters
    UserName
    Password
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    Your Webstore URL https://YOUR-STORE.onfastspring.com
    ODBC DSN HTTP Connection Configuration

  6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Video instructions

Read FastSpring data in Power BI using ODBC

Importing FastSpring data into Power BI from table or view

  1. Once you open Power BI Desktop click Get Data to get data from ODBC:
    Power Bi Get Data

  2. A window opens, and then search for "odbc" to get data from ODBC data source:
    Power Bi ODBC Get Data

  3. Another window opens and asks to select a Data Source we already created. Choose FastspringDSN and continue:

    FastspringDSN
    Power Bi Select ZappySys Driver DSN

  4. Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:

    FastspringDSN
    Power Bi DSN Authenticaation

  5. Finally, you will be asked to select a table or view to get data from. Select one and load the data!
    Power Bi Load DSN Table Data

  6. Finally, finally, use extracted data from FastSpring in a Power BI report:
    Power Bi Extracted DSN Table Data

Importing FastSpring data into Power BI using SQL query

If you wish to import FastSpring data from SQL query rather than a table then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.

FastspringDSN
                SELECT
                    ProductID,
                    ProductName,
                    SupplierID,
                    CategoryID,
                    QuantityPerUnit,
                    UnitPrice
                FROM Products
                WHERE UnitPrice > 20
            
Get REST API data in Power BI Desktop using SQL query and ODBC
Consider using Custom Objects feature in ODBC data source to encapsulate SQL query in a Virtual Table. This way, you can see a virtual table in Power BI table list where you can import multiple objects using the same connection rather than creating a new connection for each custom SQL query.

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

  1. Open ODBC data source configuration and click Copy settings:
    ZappySys API Driver - FastSpring
    Read / write FastSpring data related to Orders, Subscriptions, Quotes, Products, Accounts and more without coding.
    FastspringDSN
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then just paste the connection string into your script:
    FastspringDSN
    DRIVER={ZappySys API Driver};ServiceUrl=https://api.fastspring.com;CredentialType=Basic;
    Use full connection string in Power BI Desktop to read API data
  4. You are good to go! The script will execute the same way as using a DSN.
The DSN defined in the Data source name (DSN) field will be ignored.

Have in mind that a full connection string has length limitations.

Proceed to the next step to find out the details.

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

  1. Open your ODBC data source.
  2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
  3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
  4. Continue by pasting the copied connection string into a newly created file and save it.
  5. Finally, the last step! Just construct a shorter ODBC connection string using this format:
    DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
  6. Our troubles are over! Now you should be able to use this connection string in Power BI with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.

Editing query for table in Power BI

There will be a time you need to change the initial query after importing data into Power BI. Don't worry, just right-click on your table and click Edit query menu item:

Edit query in Power BI to get REST API data
Refer to Power Query M reference for more information on how to use its advanced features in your queries.

Using parameters in Power BI (dynamic query)

In the real world, many values of your REST / SOAP API call may be coming from parameters. If that's the case for you can try to edit script manually as below. In below example its calling SQL Query with POST method and passing some parameters. Notice below where paraAPIKey is Power BI Parameter (string type). You can use parameters anywhere in your script just like the normal variable.

To use a parameter in Power BI report, follow these simple steps:

  1. Firstly, you need to Edit query of your table (see previous section)

  2. Then just create a new parameter by clicking Manage Parameters dropdown, click New Parameter option, and use it in the query:

    						
                                = Odbc.Query("dsn=FastspringDSN",
                                             "SELECT ProductID, ProductName, UnitPrice, UnitsInStock
                                              FROM Products
                                              WHERE UnitPrice > " & Text.From(MyParameter) & "
                                              ORDER BY UnitPrice")
                            
                    
    Use parameter in Power BI to get REST API data
    Refer to Power Query M reference for more information on how to use its advanced features in your queries.

Using DirectQuery Option rather than Import

So far we have seen how to Import FastSpring data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers.

Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for FastSpring data.

Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call FastSpring via ZappySys Data Gateway.

  1. First read this article carefully, How to query FastSpring API in SQL Server.
  2. Once linked server is configured we are ready to issue API query in Power BI.
  3. Click Get Data in Power BI, select SQL Server Database
  4. Enter your server name and any database name
  5. Select Mode as DirectQuery
  6. Click on Advanced and enter query like below (we are assuming you have created FastSpring Data Source in Data Gateway and defined linked server (Change name below).
    SELECT * FROM OPENQUERY([FASTSPRING_LINKED_SERVER], 'SELECT * FROM Customers')
    SELECT * FROM OPENQUERY([FASTSPRING_LINKED_SERVER], 'SELECT * FROM Customers')
    DirectQuery option for Power BI (Read FastSpring Data Example using SQL Server Linked Server and ZappySys Data Gateway)


    DirectQuery option for Power BI (Read FastSpring Data Example using SQL Server Linked Server and ZappySys Data Gateway)

  7. Click OK and Load data ... That's it. Now your FastSpring API data is linked rather than imported.

Publishing Power BI report to Power BI service

Here are the instructions on how to publish a Power BI report to Power BI service from Power BI Desktop application:

  1. First of all, go to Power BI Desktop, open a Power BI report, and click Publish button:

    Publish Power BI report to Power BI service
  2. Then select the Workspace you want to publish report to and hit Select button:

    Publish Power BI report to workspace
  3. Finally, if everything went right, you will see a window indicating success:

    Successful Power BI report publishing

    If you need to periodically refresh Power BI semantic model (dataset) to ensure data accuracy and up-to-dateness, you can accomplish that by using Microsoft On-premises data gateway. Proceed to the next section - Refreshing Power BI semantic model (dataset) using On-premises data gateway - and learn how to do that.

Refreshing Power BI semantic model (dataset) using On-premises data gateway

Power BI allows to refresh semantic models which are based on data sources that reside on-premises. This can be achieved using Microsoft On-premises data gateway. There are two types of On-premises gateways:

  • Standard Mode
  • Personal Mode

Standard Mode supports Power BI and other Microsoft Data Fabric services. It fits perfectly for Enterprise solutions as it installs as a Windows Service and also supports Direct Query feature.

Personal Mode, on the other hand, can be configured faster, but is designed more for home users (you cannot install it as a Windows Service and it does not support DirectQuery). You will find a detailed comparison in the link above.

We recommend to go with Personal Mode for a quick POC solution, but use Standard Mode in production environment.

Below you will find instructions on how to refresh semantic model using both types of gateways.

Refresh using On-premises data gateway (standard mode)

Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (standard mode):

  1. Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:

    Configure Power BI semantic model settings
  2. If you see this view, it means you have to install On-premises data gateway (standard mode):

    On-premises data gateway is not installed
  3. Install On-premises data gateway (standard mode) and sign-in:

    signing in into on-premises data gateway standard
    Use the same email address you use when logging in into Power BI account.
  4. Register a new gateway (or migrate an existing one):

    registering or migrating on-premises data gateway standard
  5. If you are creating a new gateway, name your gateway, enter a Recovery key, and click Configure button:

    naming on-premises data gateway standard
  6. Now, let's get back to your semantic model settings in Power BI portal. Refresh the page and you should see your newly created gateway. Click arrow icon and then click on Add to gateway link:

    ODBC{"connectionstring":"dsn=FastspringDSN"}
    Using On-premises Data Gateway Standard for Power BI Semantic Model
  7. Once you do that, you will create a new gateway connection. Give it a name, set Authentication method, Privacy level, and click Create button:

    dsn=FastspringDSN
    Create new connection in Power BI On-premises data gateway
    In this example, we used the least restrictive Privacy level.

    If your connection uses a full connection string you may hit a length limitation when entering it into the field. To create the connection, you will need to shorten it manually. Check the section about the limitation of a full connection string on how to accomplish it.

    On-premises data gateway (personal mode) does not have this limitation.

  8. Proceed by choosing the newly created connection:

    ODBC{"connectionstring":"dsn=FastspringDSN"}
    Selecting gateway connection in Power BI semantic model
  9. Finally, you are at the final step where you can refresh the semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Refresh using On-premises data gateway (personal mode)

Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (personal mode):

  1. Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:

    Configure Power BI semantic model settings
  2. If you see this view, it means you have to install On-premises data gateway (personal mode):

    On-premises data gateway is not installed
  3. Install On-premises data gateway (personal mode) and sign-in:

    Sign-in to On-premises data gateway personal
    Use the same email address you use when logging in into Power BI account.
  4. Again, go to your semantic model Settings, expand Data source credentials, click Edit credentials, select Authentication method together with Privacy level, and then click Sign in button:

    dsn=FastspringDSN
    Use On-premises data gateway personal for Power BI semantic model
  5. Finally, you are ready to refresh your semantic model:

    Refreshing Power BI semantic model using On-premises Data Gateway

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Actions supported by FastSpring Connector

FastSpring Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Get Product IDs
   [Read more...]
 Get Products
   [Read more...]
 Get Products Publish Status
   [Read more...]
 Get Product
   [Read more...]
Parameter Description
Product Id
 Create Product
   [Read more...]
 Update Product
   [Read more...]
 Get Product Prices
   [Read more...]
Parameter Description
Country Code
Currency Code
 Get Order Items
   [Read more...]
 Get Order Items by OrderId
   [Read more...]
Parameter Description
Order Id
 Get Orders
   [Read more...]
 Get Order by Id
   [Read more...]
Parameter Description
Order Id
 Get Accounts
   [Read more...]
 Get Account Orders (For all accounts)
   [Read more...]
 Get Account Charges
   [Read more...]
 Get Account Orders (For a single account)
   [Read more...]
Parameter Description
Account Id
 Get Account Charges by Id
   [Read more...]
Parameter Description
Account Id
 Get Account By Id
   [Read more...]
Parameter Description
Account Id
 Get Subscriptions Ids
   [Read more...]
 Get Subscriptions
   [Read more...]
 Get Subscription By Id
   [Read more...]
Parameter Description
Subscription Id
 Get Quote By Id
   [Read more...]
Parameter Description
Quote Id
 Get Quotes
   [Read more...]
 Get Subscription Report
   [Read more...]
Parameter Description
ReportColumns
Option Value
activations activations
arr arr
average_mrr average_mrr
buyer_email buyer_email
buyer_id buyer_id
cancellations cancellations
chargeback_true_false chargeback_true_false
company_id company_id
company_name company_name
country_iso country_iso
country_name country_name
coupon coupon
customer_churn customer_churn
discount discount
driving_offer_type driving_offer_type
driving_product_path driving_product_path
item_id item_id
lifetime_value lifetime_value
mrr mrr
mrr_decrease mrr_decrease
mrr_downgrade mrr_downgrade
mrr_growth_rate mrr_growth_rate
mrr_increase mrr_increase
mrr_paused mrr_paused
mrr_resumed mrr_resumed
mrr_upgrade mrr_upgrade
new_subscribers new_subscribers
occurred_date occurred_date
order_id order_id
product_display_name product_display_name
product_id product_id
product_name product_name
product_path product_path
purchase_type purchase_type
return_true_false return_true_false
revenue_churn revenue_churn
store_id store_id
store_name store_name
subscriber_loss subscriber_loss
subscribers subscribers
subscription_period subscription_period
subscription_period_end subscription_period_end
subscription_period_start subscription_period_start
subscription_start_date subscription_start_date
subscription_status subscription_status
subscription_true_false subscription_true_false
subscriptions subscriptions
sync_date sync_date
transaction_currency transaction_currency
transaction_date transaction_date
transaction_month transaction_month
transaction_type transaction_type
transaction_year transaction_year
GroupByColumns
Option Value
buyer_email buyer_email
buyer_id buyer_id
chargeback_true_false chargeback_true_false
company_id company_id
company_name company_name
country_iso country_iso
country_name country_name
coupon coupon
discount discount
driving_offer_type driving_offer_type
driving_product_path driving_product_path
item_id item_id
occurred_date occurred_date
order_id order_id
product_display_name product_display_name
product_id product_id
product_name product_name
product_path product_path
purchase_type purchase_type
return_true_false return_true_false
store_id store_id
store_name store_name
subscription_period subscription_period
subscription_period_end subscription_period_end
subscription_period_start subscription_period_start
subscription_start_date subscription_start_date
subscription_status subscription_status
subscription_true_false subscription_true_false
sync_date sync_date
transaction_currency transaction_currency
transaction_date transaction_date
transaction_month transaction_month
transaction_type transaction_type
transaction_year transaction_year
 Get Revenue Report
   [Read more...]
Parameter Description
ReportColumns
Option Value
Buyer_Email Buyer_Email
Buyer_ID Buyer_ID
Chargeback_True_False Chargeback_True_False
Company_ID Company_ID
Company_Name Company_Name
Country_ISO Country_ISO
Country_Name Country_Name
CouponDigital_Backup_Fulfillment_Fee CouponDigital_Backup_Fulfillment_Fee
Digital_Backup_Fulfillment_Fee_in_USD Digital_Backup_Fulfillment_Fee_in_USD
Digital_Fulfillment_Fee Digital_Fulfillment_Fee
Digital_Fulfillment_Fee_in_USD Digital_Fulfillment_Fee_in_USD
Discount Discount
Driving_Offer_TypeDriving_Product_Path Driving_Offer_TypeDriving_Product_Path
Fixed_FeeFixed_Fee_in_USDIncomeIncome_in_USDItem_ID Fixed_FeeFixed_Fee_in_USDIncomeIncome_in_USDItem_ID
Order_ID Order_ID
Physical_Backup_Fulfillment_Fee Physical_Backup_Fulfillment_Fee
Physical_Backup_Fulfillment_Fee_in_USD Physical_Backup_Fulfillment_Fee_in_USD
Product_Display_Name Product_Display_Name
Product_ID Product_ID
Product_Name Product_Name
Product_Path Product_Path
Purchase_Type Purchase_Type
Return_Fee Return_Fee
Return_Fee_in_USD Return_Fee_in_USD
Return_True_False Return_True_False
SegmentStore_Chargeback_Fee SegmentStore_Chargeback_Fee
Store_ID Store_ID
Store_Name Store_Name
Subscription_Period Subscription_Period
Subscription_Period_End Subscription_Period_End
Subscription_Period_Start Subscription_Period_Start
Subscription_Start_Date Subscription_Start_Date
Subscription_Status Subscription_Status
Subscription_True_False Subscription_True_False
Tax Tax
Tax_Fee Tax_Fee
Tax_Fee_in_USD Tax_Fee_in_USD
Tax_in_USD Tax_in_USD
Transaction_Amount Transaction_Amount
Transaction_Amount_in_USD Transaction_Amount_in_USD
Transaction_Currency Transaction_Currency
Transaction_Date Transaction_Date
Transaction_Fee Transaction_Fee
Transaction_Fee_in_USD Transaction_Fee_in_USD
Transaction_Item_Count Transaction_Item_Count
Transaction_Month Transaction_Month
Transaction_Rate Transaction_Rate
Transaction_Time_UTC Transaction_Time_UTC
Transaction_Type Transaction_Type
Transaction_Year Transaction_Year
Grand_Total_In_USD Grand_Total_In_USD
syncDatecountryISO syncDatecountryISO
Product_Count Product_Count
Product_Units Product_Units
GroupByColumns
Option Value
Buyer_Email Buyer_Email
Buyer_ID Buyer_ID
Chargeback_True_False Chargeback_True_False
Company_ID Company_ID
Company_Name Company_Name
Country_ISO Country_ISO
Country_Name Country_Name
Coupon Coupon
Discount Discount
Driving_Offer_Type Driving_Offer_Type
Driving_Product_Path Driving_Product_Path
Income Income
Item_ID Item_ID
Order_ID Order_ID
Product_Display_Name Product_Display_Name
Product_ID Product_ID
Product_Name Product_Name
Product_Path Product_Path
Purchase_Type Purchase_Type
Return_True_False Return_True_False
Segment Segment
Store_ID Store_ID
Store_Name Store_Name
Subscription_Period Subscription_Period
Subscription_Status Subscription_Status
Subscription_True_False Subscription_True_False
Transaction_Currency Transaction_Currency
Transaction_Date Transaction_Date
Transaction_Month Transaction_Month
Transaction_Type Transaction_Type
Transaction_Year Transaction_Year
countryISO countryISO
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Option Value
No filter
Example1 $.store.books[*]
Example2 (Sections Under Books) $.store.books[*].sections[*]
Example3 (Equals) $.store.books[?(@author=='sam')]
Example4 (Equals - Any Section) $..[?(@author=='sam')]
Example5 (Not Equals - Any Section) $..[?(@author!='sam')]
Example6 (Number less than) $.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )]
Example8 (Regular Expression - Does Not Contain Pattern) $.store.books[?(@author=~ /^((?!sam|bob).)*$/ )]
Example9 (Regular Expression - Exact Pattern Match) $.store.books[?(@author=~ /^sam|bob$/ )]
Example10 (Regular Expression - Starts With) $.store.books[?(@author=~ /^sam/ )]
Example11 (Regular Expression - Ends With) $.store.books[?(@author=~ /sam$/ )]
Example12 (Between) $.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )]
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
 Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair

FastSpring Connector Examples for Power BI Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Read orders    [Read more...]

Read all orders

SELECT * FROM Orders

Read a single order by id    [Read more...]

Read a single order by id

SELECT * FROM Orders Where Id='zzzzzzzzzz'

Read orders with date range    [Read more...]

Read all orders within specific date range

SELECT * FROM Orders WITH(StartDate='2020-01-01', EndDate='2021-12-31' ) --use function like today, yesterday, yearstart, monthstart, yearstart-1y

Read orders placed in last 30 days    [Read more...]

Read all orders placed in last 30 days. This hows how to use function like today, yesterday, yearstart, monthstart, yearstart-1y etc for date parameters

SELECT * FROM Orders 
--WHERE Currency='USD' and TotalInPayoutCurrency>=1599
WITH(StartDate='today-30day', EndDate='today') --try today, yesterday, yearstart, yearend, monthstart, monthend, yearstart-1y so on

Read product ids    [Read more...]

Read all orders

SELECT * FROM get_product_ids

Read product details    [Read more...]

Read all products

SELECT * FROM Products

Read a single product by id    [Read more...]

Read a single product by id

SELECT * FROM Products Where Id='some-product-id'

Read product prices    [Read more...]

List product prices for specified currency or country. If you do not pass Country or Currency Parameter then all prices for all countries listed

SELECT 
 Product,
 Country,
 Currency,
 Price,
 PriceDisplay,
 
 Discount2DiscountPercent,
 Discount2DiscountValue,
 Discount2DiscountValueDisplay,
 Discount2UnitPrice,
 Discount2UnitPriceDisplay,
 
 Discount3DiscountPercent,
 Discount3DiscountValue,
 Discount3DiscountValueDisplay,
 Discount3UnitPrice,
 Discount3UnitPriceDisplay,
 
 Discount4DiscountPercent,
 Discount4DiscountValue,
 Discount4DiscountValueDisplay,
 Discount4UnitPrice,
 Discount4UnitPriceDisplay,
 
 Discount5DiscountPercent,
 Discount5DiscountValue,
 Discount5DiscountValueDisplay,
 Discount5UnitPrice,
 Discount5UnitPriceDisplay,
 
 DiscountReasonEn,
 DiscountPeriodCount,

 AvailableStart,
 AvailableEnd,
 SetupFeePrice,
 SetupFeePriceDisplay,
 SetupFeeReasonEn
 
FROM ProductPrices 
--WITH(Country='US') --//get prices for a specific country
--WITH(Currency='USD') --//get proces for a specific currency

Update Product    [Read more...]

Update product attributes by its ID

UPDATE Products
SET 
  Display='Product ABCD'
, Sku='PRD-ABCD-01'
, Summary='Product Abcd **STD**'
, Description='This product can be used to call **API** supports markdown syntax'
, Action='**Action** supports markdown'
, TaxCode='DC010500'
, Image='https://zappysys.com/api/images/ZappySys-icon.png'
, FulfillmentInstructions='Thank you for shopping. **Activate** license by using our License App'
, Format='digital'
, PriceUSD='101.5'
, PriceEUR='102.5'
, PriceGBP='103.5'
, PriceCAD='104.5'
, PriceNZD='105.5'
, PriceCHF='106.5'
, PriceSEK='107.5'
, PriceCZK='108.5'
, PriceDKK='109.5'
, PricePLN='101.5'
, PriceSGD='102.5'
, PriceJPY='103.5'
, PriceCNY='104.5'
, PriceHKD='105.5'
, PriceINR='106.5'
, PriceBRL='107.5'
, PriceAUD='108.5'

, Badge='Badge-1'
, Rank=1
, Trial=14 --how many trial days
, TrialPriceUSD=10.5 

--, Renew=1 --not allowed for update : Only for create (enable subscription)
, Interval='year' --allowed values: adhoc, day, week, year, only needed if you are creating a subscription
, IntervalLength=1
, IntervalCount=0

, QuantityBehavior='allow' --allowed values: allow, lock, hide
, QuantityDefault=1
, Attributes = '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}'
--, Fulfillments='[ { fullfillment }, { fullfillment } ... ]' --JSON fragment 	
Where Id='abcd'

Update multiple Products (read from CSV file)    [Read more...]

Update multiple products from CSV file or other external source (e.g. Microsoft SQL Server, MySQL, Postgresql, ODBC)

UPDATE Products
SOURCE('ODBC',

--File input example (use as to match Column name allowed in Products Table to write)
--'Driver={ZappySys CSV Driver};DataPath=c:\data\products.csv',
--'select P_ID as Id,P_TAXCODE as TaxCode From $'

--Direct input example
'Driver={ZappySys CSV Driver}',
'select ''abcd'' as Id, ''DC010500'' as TaxCode UNION
 select ''xyz'' as Id, ''DC010500'' as TaxCode UNION
 select ''zzz'' as Id, ''DC010500'' as TaxCode 
'
)

Create or Update Product (Upsert)    [Read more...]

Create or Update product (Upsert)

--Insert or Update
--UPSERT INTO Products 

--Insert or Update
UPSERT INTO Products
(     [Id]	, [Display]	, [Summary]
	, [Description]	, [Action]	, [Format]
	, [Sku]	, [TaxCode]	, [Image]
	, [Renew]	, [Interval]	, [IntervalLength]
	, [IntervalCount]	, [QuantityBehavior]	, [QuantityDefault]
	, [PriceUSD]	, [PriceEUR]	, [PriceGBP]
	, [PriceCAD]	, [PriceNZD]	, [PriceCHF]
	, [PriceSEK]	, [PriceCZK]	, [PriceDKK]
	, [PricePLN]	, [PriceSGD]	, [PriceJPY]
	, [PriceCNY]	, [PriceHKD]	, [PriceINR]	, [PriceBRL]	, [PriceAUD]
	, [Trial]	
	, [TrialPriceUSD]	, [TrialPriceEUR]	, [TrialPriceGBP]
	, [PaymentCollected]	, [PaidTrial]
	, [FulfillmentInstructions]
	, [DateLimitsEnabled]	, [CancellationInterval]	, [CancellationIntervalLength]	
	, [SetupFeeTitle]	
	, [SetupFeePriceUSD]	, [SetupFeePriceEUR]	, [SetupFeePriceGBP]	
	, [Badge]	, [Rank]	
	, [Attributes]		
	)
VALUES('test-std-id'
	, '3Year **standard** subscription edition'
	, 'summary **standard edition** _some italic_ ' -- markdown syntax allowed
	
	, 'long description **test STD** and many more lines' --markdown syntax allowed
	, 'action text with **markdown** '
	, 'digital' -- e.g. digital OR physical OR digital-and-physical
	
	, 'TEST-STD-001'
	, 'DC010500'
	, 'https://zappysys.com/api/images/ZappySys-icon.png'
	
	, true	, 'year'	, 1
	, 1 	, 'allow' -- e.g. allow Or lock Or hide
	, 3	--stop renewal after 3 periods
	, 10.12	, 11.12	, 12.12	
	, 13.12	, 14.12	, 15.12	
	, 16.12	, 17.12	, 18.12	
	, 19.12	, 20.12	, 21.12	
	, 22.12	, 23.12	, 24.12	, 25.12	, 26.12	
    , 14 --how many days trial allowed
    , 10.12	, 11.12	, 12.12	
    , 'true', true
	, 'Thank you for shopping, **here are** license instructions' --markdown supported
	, false, 'day', 5
	, 'Setup title'	
	--setup fees in common currencies
	, 10.50	, 11.50	, 12.50	
	, 'badge-1'	, 1
	, '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}' --JSON fragment 
	--, '[... fullfillments.. ]' --JSON fragment 	
)

List / Search Quotes    [Read more...]

List or Search quotes. This example lists Open and Completed Quotes

SELECT * FROM Quotes 
WITH(
	  Statuses='OPEN~COMPLETED',
	  --SearchFor='Test' --quote contains word "Test" in Name or blling information
	  -- query more status like below
	  --Statuses='OPEN~COMPLETED~CANCELED~EXPIRED',
	  
)

List Product Publish Status - Public=200, Private=404    [Read more...]

List product publish status (200=Published, 404=Private)

select * from get_products_visibility

List all orders for a specific subscription    [Read more...]

List all orders for a specific subscription

SELECT * FROM Orders 
WHERE SubscriptionId_1='iBPfMFS6TZSxrLzSOrq8PQ' 
	OR SubscriptionId_2='iBPfMFS6TZSxrLzSOrq8PQ'
	OR SubscriptionId_3='iBPfMFS6TZSxrLzSOrq8PQ' 
ORDER BY OrderDate

Generate Subscription Report by Date, Product, Group By    [Read more...]

Generate subscription report for selected group by columns, date range, products and more

SELECT *
FROM get_subscription_report
Order by transaction_date
WITH(
	  Country='AL~UA~US'
	, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
	, StartDate='monthstart-1m' --or  2022-01-01
	, EndDateDate='monthend+2d' --or  2022-01-01
	, ReportColumns='transaction_date~transaction_month~transaction_year~activations~average_mrr~cancellations~mrr~new_subscribers~subscriptions'
	, GroupByColumns='transaction_date~transaction_month~transaction_year'
)

Generate Revenue Report by Date, Product, Group By    [Read more...]

Generate revenue report for selected group by columns, date range, products and more

SELECT *
FROM get_revenue_report
Order by transaction_date
WITH(
	  Country='AL~UA~US'
	, ProductPaths='odbc-pp-ent-sub~odbc-pp-pro-sub~odbc-pp-std~ssis-pp-pro-sub~ssis-pp-std-sub~ssis-pp-ent-sub'
	, StartDate='monthstart-1m' --or  2022-01-01
	, EndDateDate='monthend+2d' --or  2022-01-01
	, ReportColumns='Transaction_Year~Transaction_Month~Transaction_Date~Company_Name~Product_Path~Product_Units~Tax_in_USD~Transaction_Amount_in_USD~Grand_Total_In_USD'
	, GroupByColumns='transaction_date~transaction_month~transaction_year'
)

Get all accounts    [Read more...]

Get all accounts for your store

SELECT *
FROM Accounts	

SELECT "Id"
	, "ContactFirst"
	, "ContactLast"
	, "ContactEmail"
	, "ContactCompany"
	, "ContactPhone"
	, "ContactSubscribed"
	, "AddressLine1"
	, "AddressLine2"
	, "City"
	, "Region"
	, "RegionCustom"
	, "PostalCode"
	, "AddressCompany"
	, "Language"
	, "Country"
	, "LookupGlobal"
	, "Url"
	, "PaymentMethods"
	, "PaymentActive"
	, "Orders"
	, "Subscriptions"
	, "Charges"
	, "Subscribed"
	, "TaxExemptionData"
FROM Accounts

--Use WITH clause --OR-- Key column(s) in WHERE clause
--WHERE [Id] = 'abcd'

--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

Get all accounts with specific product orders    [Read more...]

Use below query to search accounts who placed orders for specific products

SELECT * from Accounts WITH(Products='ssis-pp-pro,ssis-pp-pro-sub,ssis-pp-ent,ssis-pp-ent-sub')

Get account charges    [Read more...]

Use below query to search account charges

SELECT * from AccountCharges 

--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

Get account orders by email id    [Read more...]

Use below query to search for accounts and orders with search criteria

SELECT * from AccountOrders
WITH(
	  Email='bob@abc.com'
)
	  
--search by one or more parameters below
/*
WITH(
	  Email='X'
	, CustomKey='X'
	, GlobalKey='X'
	, OrderID='X'
	, OrderReference='X'
	, SubscriptionId='X'
	, Products='PROD-1,PROD-2,PROD-3'
	, Refunds='true'
	, SubscriptionStatus='active'
)
*/

Get specific order by reference number (rather than Id)    [Read more...]

Search by Order by reference (fast way). If you have less rows then use Select * FROM Orders where Reference='BIX-123' it can be faster than below appproach

SELECT * from AccountOrders WHERE Reference='BIN240202-9666-28133' WITH(OrderReference='BIN240202-9666-28133')	
--or for handful rows use below way
--SELECT * from Orders WHERE Reference='BIN240202-9666-28133'

Conclusion

In this article we discussed how to connect to FastSpring in Power BI and integrate data without any coding. Click here to Download FastSpring Connector for Power BI and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download FastSpring Connector for Power BI Documentation 

More integrations

Other application integration scenarios for FastSpring

Other connectors for Power BI


Download FastSpring Connector for Power BI Documentation

  • How to connect FastSpring in Power BI?

  • How to get FastSpring data in Power BI?

  • How to read FastSpring data in Power BI?

  • How to load FastSpring data in Power BI?

  • How to import FastSpring data in Power BI?

  • How to pull FastSpring data in Power BI?

  • How to push data to FastSpring in Power BI?

  • How to write data to FastSpring in Power BI?

  • How to POST data to FastSpring in Power BI?

  • Call FastSpring API in Power BI

  • Consume FastSpring API in Power BI

  • FastSpring Power BI Automate

  • FastSpring Power BI Integration

  • Integration FastSpring in Power BI

  • Consume real-time FastSpring data in Power BI

  • Consume real-time FastSpring API data in Power BI

  • FastSpring ODBC Driver | ODBC Driver for FastSpring | ODBC FastSpring Driver | SSIS FastSpring Source | SSIS FastSpring Destination

  • Connect FastSpring in Power BI

  • Load FastSpring in Power BI

  • Load FastSpring data in Power BI

  • Read FastSpring data in Power BI

  • FastSpring API Call in Power BI