Welcome Guest, you are in: Login

QVSource: The QlikView & Qlik Sense API Connector (Docs)

Adobe Analytics Connector For QlikView And Qlik Sense

RSS
Modified on 2016/03/24 20:42 by chrisb Categorized as connector

Usage

This connector is quite complex and in most cases will require the user to construct some JSON data defining the report to be generated.

It is useful to understand that the connector essentially connects to most of the end points explained (further explained and accessible from the Adobe Analytics API Explorer here) which we believe will be of use to QlikView and Qlik Sense users.

Most of our users use first use this gain an understanding and insight of the API and begin experimenting with test requests for data. The API Explorer will often give an initial example of a JSON template (which is needs for many of the initial requests to define report requirements. The API requests can then usually be translated directly to QVSource table requests. As you get more familiar with the API you should then be able to start building these requests on the fly in your QlikView and Qlik Sense load script.

This page on getting started with the API will also likely be of use.

We will also give some starting points below and hope to have more docs soon.

Please contact us if you are having any trouble using the connector and we will try to organise a screen share session with you to help you.

Image

DataWarehouse Report Description Template

In order to use the DWCheckRequest table you will need to edit the following JSON to enter in to the connector (or specify as a file for the DWCheckRequestFromFile table).

This is the full JSON template for submitting a report request as generated on the API Explorer.


{
	"Breakdown_List":[
		"(string)"
	],
	"Contact_Name":"(string)",
	"Contact_Phone":"(string)",
	"Date_From":"(string)",
	"Date_Granularity":"(string)",
	"Date_Preset":"(string)",
	"Date_To":"(string)",
	"Date_Type":"(string)",
	"Email_Subject":"(string)",
	"Email_To":"(string)",
	"FTP_Dir":"(string)",
	"FTP_Host":"(string)",
	"FTP_Password":"(string)",
	"FTP_Port":"(int)",
	"FTP_UserName":"(string)",
	"File_Name":"(string)",
	"File_Type":"(string)",
	"Metric_List":[
		"(string)"
	],
	"Report_Description":"(string)",
	"Report_Name":"(string)",
	"Segment_Id":"(int)",
	"rsid":"(string)"
}

However, as seen from the associated documentation, much of this is optional and not relevant when requesting data for QlikView or Qlik Sense.

We can remove all of the FTP related fields. We are then left with the following fields:




{
	"Breakdown_List":[
		"(string)"
	],
	"Contact_Name":"(string)",
	"Contact_Phone":"(string)",
	"Date_From":"(string)",
	"Date_Granularity":"(string)",
	"Date_Preset":"(string)",
	"Date_To":"(string)",
	"Date_Type":"(string)",
	"Email_Subject":"(string)",
	"Email_To":"(string)",
	"File_Name":"(string)",
	"File_Type":"(string)",
	"Metric_List":[
		"(string)"
	],
	"Report_Description":"(string)",
	"Report_Name":"(string)",
	"Segment_Id":"(int)",
	"rsid":"(string)"
}

Troubleshooting

Error Codes

You can see a list of error codes returned by version 1.4 of the API here.

Change Log

0.9.1 - 19/05/15
  • Fixed bug with ReportGetQueue table.

0.9.0 - 15/05/15
  • Added ReportQueueAndWait and ReportQueueFromFileAndWait tables. This means you no longer need to construct logic to check the queue and wait for the report to complete in your QlikView and Qlik Sense load script.
  • Expanded notes for some tables.
  • Fixed bug in ReportSuiteGetSegments table. Also, it now checks for both segments and sc_segments elements (a new element_name column specifies which).
  • DWCheckRequest table now always returns a single row, even in the case of an error message being returned from the API.

0.8.3 - 01/04/15
  • Flatten XML should now deal with repeated column names. e.g. if the response from ReportGet contains 2 count columns, the table should now show count and count_2.

0.8.2 - 03/02/15
  • ReportGet table should now flatten XML hierarchy into one large table.

0.8.1 - 21/01/15
  • Added ReportGetAsXml table.
  • Improved report parsing in ReportGet table.

0.8.0 - 21/01/15
  • Initial release.
  Name Size
- Adobe Analytics Connector.png 279.30 KB


(QVSource works with Qlik Sense as well as QlikView - See this page for notes.)
QVSource - The QlikView & Qlik Sense API Connector | © Copyright 2011 - 2016 Industrial CodeBox Ltd