Skip to content

Create a BI Access Token

BI Access Tokens allow external reporting and business intelligence tools to securely access your organization's FieldOps data through the FieldOps BI API.

You can use a BI Access Token when connecting tools such as:

  • Power BI
  • Tableau
  • Custom dashboards
  • Internal reporting applications
  • Data pipelines
  • Other systems that can make authenticated HTTP requests

Each BI Access Token belongs to your FieldOps organization and provides access only to BI data available within that organization.

Before you begin

You need:

  • Access to your FieldOps organization
  • Permission to manage BI Access Tokens
  • A FieldOps plan that includes BI access

Note

The number of BI Access Tokens your organization can create may depend on your FieldOps plan.

Step 1: Open BI Access Tokens

Sign in to FieldOps and open BI Access Tokens from the application navigation.

This page shows the BI Access Tokens created for your active organization.

Step 2: Create a new token

Select the action to create a new BI Access Token.

Enter a descriptive name for the token.

For example:

  • Power BI Production
  • Tableau Reporting
  • Executive Dashboard
  • Monitoring Data Pipeline

Use a name that clearly identifies where the token will be used.

Tip

Create a separate token for each external reporting tool or integration. This makes it easier to manage or revoke access without affecting other systems.

Step 3: Create the token

Select Create to generate the BI Access Token.

FieldOps will generate a secure token for your organization.

A FieldOps BI Access Token begins with:

fldops_bi_

The complete token contains additional secure characters after this prefix.

For example, a token will have a structure similar to:

fldops_bi_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Warning

The example above is not a valid token. Never include a real BI Access Token in documentation, screenshots, support messages, or public code.

Step 4: Copy and store the token securely

Copy the generated token and store it in a secure location.

You will need the token when connecting Power BI, Tableau, another reporting tool, or an application to the FieldOps BI API.

Important

Copy the complete token when it is generated and store it securely.

Warning

Treat your BI Access Token like a password.

Do not:

  • Share it publicly
  • Include it in screenshots
  • Commit it to Git or another source control system
  • Place it in public frontend code
  • Include it in support messages
  • Store it in an unsecured document

If a token is exposed, remove or revoke it and create a new one.

How the token works

When an external system sends a request to the FieldOps BI API, the BI Access Token is used to:

  1. Authenticate the request
  2. Identify the FieldOps organization associated with the token
  3. Restrict access to BI data belonging to that organization

The token determines the organization context automatically.

You do not need to provide an Organization ID to access your organization's BI data.

Important

BI Access Tokens are organization-scoped. A token created for one FieldOps organization cannot be used to access another organization's BI data.

Using the token with the BI API

Send the BI Access Token as a Bearer token in the HTTP Authorization header.

The header follows this format:

Authorization: Bearer YOUR_BI_ACCESS_TOKEN

For example:

Authorization: Bearer fldops_bi_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Replace the example value with your actual BI Access Token.

Warning

Never publish a request example containing your real BI Access Token.

Use separate tokens for separate integrations

Where possible, create a separate token for each external system.

For example:

Token name Used for
Power BI Production Production Power BI reports
Tableau Analytics Tableau dashboards
Executive Dashboard Internal management dashboard
Data Pipeline Automated data processing

This makes token management easier.

If one integration is no longer required, you can remove its token without affecting the others.

Token security

Follow these practices when using BI Access Tokens:

  • Store tokens securely
  • Use a separate token for each integration
  • Do not share tokens unnecessarily
  • Do not commit tokens to source control
  • Do not expose tokens in browser-side code
  • Remove tokens that are no longer required
  • Replace a token immediately if you believe it has been exposed

Warning

Anyone with access to a valid BI Access Token may be able to access the FieldOps BI datasets available to the organization associated with that token.

Token limits

Your organization may have a maximum number of BI Access Tokens based on its FieldOps plan.

If you cannot create another token:

  • Review your existing tokens
  • Remove tokens that are no longer required
  • Check your organization's plan limits

Removing access

If an external system should no longer have access to FieldOps BI data, remove or revoke the BI Access Token used by that system.

Requests using a token that is no longer valid will not be able to access the FieldOps BI API.

Tip

Use descriptive token names so that you can identify which external system will be affected before removing a token.

Common problems

I cannot create a BI Access Token

Check that:

  • You have permission to manage BI Access Tokens
  • Your organization has BI access available
  • Your organization has not reached its BI token limit
  • You are working in the correct FieldOps organization

The token is not accepted by the BI API

Check that:

  • You copied the complete token
  • There are no extra spaces before or after the token
  • The token has not been removed or revoked
  • You included the Bearer prefix in the Authorization header
  • You are connecting to the correct FieldOps BI API endpoint

The authorization header should follow this format:

Authorization: Bearer YOUR_BI_ACCESS_TOKEN

I lost the token

If the complete token is no longer available, create a new BI Access Token and update the external reporting tool or integration to use the new token.

Remove the old token if it is no longer required.

I think a token has been exposed

Remove or revoke the affected token immediately.

Then:

  1. Create a new BI Access Token
  2. Store the new token securely
  3. Update the affected reporting tool or integration
  4. Confirm that the old token can no longer access the BI API

What to do next

After creating a BI Access Token, use it to access the FieldOps BI API.

The next guide explains:

  • How to discover the datasets available to your organization
  • How to request data from a dataset
  • How to authenticate requests
  • How to use filters
  • How to request grouped or aggregated data

Access the BI API