Index Exchange Reports

The Index Exchange Reports connector provides automated access to aggregated reporting on all activity from Index Exchange via its IndexExchange Report API.

• Prerequisites
• Scheduling
• List Active Reports
  • Sample Switchboard Script
• Download Report File
  • Parameters
  • Sample Switchboard Script

Prerequisites

The Index Exchange Reports connector requires an IX App account. For more information see the Index Exchange API Login documentation.

Username

Your IX App username

Password

Your IX App password

Scheduling

The Index Exchange Reports connector can be scheduled to ingest data once per day at a user-defined hour and timezone. By default, the connector will run once at 6am PT.

See Daily Scheduling for more information.

List Active Reports

This connector type downloads list of all the files associated with the reports to which you have access.

Sample Switchboard Script

download t from {
            type: "index_exchange:list_report";
            key: "index_exchange_reporting_key";
 
            # Allows daily schedule
} using {*};

Download Report File

The connector type downloads a specific report based on a fileID that you provide.

Parameters

report_id

The unique ID associated to the file you are downloading. The fileID is included at the end of the downloadURL returned in the Index Exchange List available files route response.

Sample Switchboard Script

download t from {
            type: "index_exchange:get_reports";
            key: "index_exchange_reporting_key";
            
            # An integer value that represents the reportID that we would like to get from the API
            report_id: <integer>
            
            # Allows daily schedule
} using {*};