Skip to main content

Setup Guide

This page provides step-by-step instructions for enabling and using BI Connections to query ArborXR Insights data from external BI tools such as Power BI and Tableau. Each token is tied to your organization and will be scoped specifically for Insights data.

Step-by-Step Instructions​

1. Get an Access Token​

Help center article here for additional reference.

  1. Log in to the ArborXR Portal
  2. Go to Organization Settings → Access Tokens → Create Access Token
  3. Select "Insights API" as the scope
    • This is a paid feature - please contact us via email to discuss pricing. If you do not have a point of contact, reach out at support@arborxr.com
      • Otherwise, this option will not display
  4. Copy and save your token securely
warning

The token is only displayed once, so make sure to copy and save it immediately.

2. Use the API Docs​

Explore our Insights API using the OpenAPI documentation.

You'll find a set of HTTP endpoints and usage instructions to help you access and utilize the data effectively.

3. Connect Your BI Tool​

  • Use your token to connect Power BI, Tableau, or another BI tool to the Insights API
  • Find your specific tool's documentation for instructions
  • Build dashboards or reports with the data you pull

Getting Started​

Base URL​

https://insights-api.xrdm.app

Prepend this to all endpoint paths when making requests.

Authentication​

All endpoints require access token authentication using the Bearer token format:

Authorization: Bearer 1|62uEa...8390b

Access tokens are organization-scoped and provide access only to your organization's data.

Main Endpoint​

Use the /v1/insights/bi/data endpoint to retrieve your Insights data.

Supported BI Tools​

  • Power BI: Use Web connector with custom headers
  • Tableau: Web Data Connector with Bearer authentication
  • Excel: Power Query with Web source
  • Custom Applications: Any HTTP client supporting Bearer tokens

Power BI Integration​

Setup Steps​

  1. In Power BI, select "Get Data" → "Web"
  2. Enter the full endpoint URL with your query parameters
  3. Add the HTTP header Authorization: Bearer <token>
  4. Configure incremental refresh using start_date/end_date parameters as needed

Examples​

Minimal example:

https://insights-api.xrdm.app/v1/insights/bi/data?application_ids=<YOUR_APP_ID>

With page size (use & to add additional parameters after the first ?):

https://insights-api.xrdm.app/v1/insights/bi/data?application_ids=<YOUR_APP_ID>&page_size=2000

Multiple applications and collection override:

https://insights-api.xrdm.app/v1/insights/bi/data?application_ids=<APP_ID_1>&application_ids=<APP_ID_2>&collection=telemetry&page=1&page_size=5000

Support​

For API support, please contact your ArborXR administrator or visit support@arborxr.com.