Our support site has moved to https://support.intuiface.com

For IntuiFace Version 5.1 or Earlier: Downloading analytic data using a REST-based query

    Introduction

    All analytic information is stored in a cloud-hosted database managed by IntuiLab. Logged events can be retrieved from this database for offline analysis in one of two ways:

    • (all IntuiFace accounts) Downloading an Excel spreadsheet using Management Console. This will be static data, meaning it will reflect the last known logs at the moment of download. To refresh the data you will need to download the file again.
    • (only accounts with at least one Composer Enterprise license) Running a custom HTML query to generate an XML or JSON-based response containing real-time logs. You can even create an Excel file on the fly using this query, then use the "Refresh" function in Excel to update the logs.


    Amount of data available:

    • IntuiFace accounts with at least one Composer Enterprise license: 365 days worth of data
    • Composer Free and Composer Pro accounts: 1 days worth of data

    For information about how to generate and store logged events, see this article.

    NOTE: Analytic records are buffered in memory and sent every 30 seconds to the IntuiFace server - so wait at least 30 seconds before downloading data. For more about the analytics buffer, see this article.

    Description of the Web Service

    The IntuiFace analytics Web service is available at the following endpoint: http://myintuiface.intuilab.com/node/analytics

    XML is returned by default. To get a JSON-based response, add Accept: application/json to the request header.

    Required parameter:

    All of the following parameters are optional:

    • xlsx=true: causes the XML response to be formatted in a way that makes it readable by Excel.
    • startDate=YYYY-MM-DDThh:mm:ss.000Z: a start date, using ISO 8601 date & time representation
    • endDate=YYYY-MM-DDThh:mm:ss.000Z: an end date using ISO 8601 date & time representation
    • deviceName: to get analytics for only the specified device
    • experienceName: to get analytics for only the specified experience
    • application: must be either Player or Composer
    • os: must be Windows, iOS or Android

    Example of a simple working request:

    http://myintuiface.intuilab.com/node/analytics?credentialKey={YourCredentialKeyHere}&xlsx=true

    This request will get all logs collected from all devices and for all experiences run on those devices over the time period your IntuiFace account is allotted. The result can be opened in Excel.

    Example of a more complex request:

    http://myintuiface.intuilab.com/node/analytics?credentialKey={YourCredentialKeyHere}&deviceName={YourDeviceName}&startDate=2014-10-28T14:00:00.000Z&xlsx=true

    This request will get you the logs for a specific device, for all experiences run on this device after October 28 2014 at 2pm UTC. The result can be opened in Excel.

    We recommend you use a tool like Postman to build and test your request.

    Use the REST request in an Excel file

    You can connect an Excel file to our analytic database using this REST web service as an Excel data source. By doing so you will be able to refresh the logs dynamically.

    Here are the steps:

    • in Excel's Data tab, click on - depending on your version of Excel - Get External Data From Web or From Web
    • Enter the Web query. You should build and test it using a tool like Postman before using it in Excel (see above).
    • Click on the Import button

    That's it!

    You can then create Pivot tables and your own dashboards.


    excel-1.png


    excel-2.png


    excel-3.png

    Update an existing connection in Excel

    You can download this sample Excel file and just insert your credential key in the request.

    • in Excel's Data tab, expand the Refesh All button and select Connection Properties
    • Select the Definition tab
    • Click on Edit query
    • Enter your credential key in the placeholder

    You can build Pivot tables and diagrams from this raw table which will contains all available logs, on all devices attached to your account.
    If you don't see anything, that's probably because you don't have log data to visualize. Visit this article to learn how to create logs of events in your IntuiFace experiences.


    excel-update.png

    Structure of Log Data

    Every logged action - through use of the Report interaction action - is stored as a "record" with additional information to facilitate fine-tuned filtering of data.

    Each record contains the following information. Starred items are automatically filled out.

    • *Timestamp: The time at which the logged event occurred. Time is measured in UTC, which means all events from all devices can be ordered chronologically even if those devices are located in different time zones.
    • *Device Name: Name of the device on which the experience was running.
    • *Application: Version of Player used to run the experience.
    • *OS: Operating system on the device.
    • *Experience Name
    • *Scene Name
    • Key
    • Value
    • Comment