IBM Support

QuickGuide #20: API (Excel & Digital Analytics)

Question & Answer


Question

QuickGuide #20: API (Excel & Digital Analytics)

Answer

API: Excel API and Digital Analytics API

Business Benefits:
a)?? ?Excel API facilitates IBM Digital Analytics Reporting without interfacing with the web UI
b)?? ?DA API facilitates an offline copy of your processed IBM DA data in a supported format
c)?? ?DA API allows other members of your organization to extract IBM DA data without the need for IBM DA credentials

Key Details:

  • Excel API allows a login to IBM DA with your credentials from within Excel. Generate one-time reports into Excel; or create and run a template to place multiple reports into an Excel notebook.
  • IBM DA API allows the generation of API Request URLs which can be used to download processed report data that is available within IBM DA.
  • IBM DA API Requests can return data in one of four supported formats ? XLS CSV XML JSON
  • The userAuthKey is a random string generated by our system and must be treated confidentially like your IBM DA password; allowing sharing of DA API Request URLs to people without access to IBM DA. It is not necessary to be logged in to IBM DA to download data via the API request.
  • The maximum number of rows returned is 20000 for both IBM DA API and Excel API.
  • To return more than 20000 rows within DA API you can create a script that submits the API request multiple times until the full report is returned. For each subsequent request in your script add the startRow parameter to return the next 20000 rows. For ex for rows 20001 - 400 add startRow=20001 to the request.


Process (DA API):
1.?? ?IBM DA API can be accessed from Analytics -> Manage -> Distribution -> API
2.?? ?In the below screen configure the Report Category Format Report Name View Name and Language as necessary

3.?? ?Select the date range(s) for the report ? Period A and Period B
4.?? ?Click on the button ?Generate API URL and Copy to Clipboard?
5.?? ?Open an existing API feed or click Create New API Feed.
6.?? ?Copy this url in a browser window to download the report or share with others as per discretion.
Note: It is also possible to manually edit the API URL to obtain a Topline Trend using the API URL form - https://welcome.coremetrics.com/analyticswebapp/api/1.0/toplinetrend-da…;


Process (Excel API):
1.?? ?Excel API can be downloaded from Analytics -> Manage -> Installations -> Excel API
2.?? ?Open the file input your credentials and login.
3.?? ?In the below screen select a report type:



4.?? ?Specify the report settings (example shown below for ?Single Report?)


5.?? ?Click ?Run Report?

"
[{"Business Unit":{"code":"BU055","label":"Cognitive Applications"},"Product":{"code":"SSPG9M","label":"IBM Digital Analytics"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"","label":""}}]

Document Information

More support for:
IBM Digital Analytics

Software version:
All Versions

Document number:
773673

Modified date:
08 December 2018

UID

ibm10773673

Manage My Notification Subscriptions