Skip to content

Sign in to the BI Pixie API

Get an access token with your own Microsoft Entra account and make your first call. The API acts as you, with what you can see and do in BI Pixie.

Prerequisites

Send a Microsoft Entra access token for the BI Pixie application as a Bearer token. The token belongs to a person who is already a user of a BI Pixie account. Application and service principal tokens are not accepted. The token's audience is api://114a7e20-3796-4ddd-ab99-568a78b7759b, the BI Pixie application behind api.bipixie.com. With the Azure CLI, which is pre-authorized on it, any call is one command: az rest --method get --url https://api.bipixie.com/v1/account --resource api://114a7e20-3796-4ddd-ab99-568a78b7759b.

The API is included with every plan, Free included, for reads and for calls that start work. Each call meets the same limits as the BI Pixie portal: the plan's tracked items, allowances and fair usage. A feature the plan does not include is refused with 403 FeatureNotInPlan, and a used allowance with its own code.

Get a token with the Azure CLI

  1. Run az login and sign in with your Microsoft Entra account.
  2. Get a token for the BI Pixie API, and send it as a Bearer token.
Request 
az login
TOKEN=$(az account get-access-token --resource api://114a7e20-3796-4ddd-ab99-568a78b7759b --query accessToken -o tsv)
curl -H "Authorization: Bearer $TOKEN" https://api.bipixie.com/v1/account

Use your own app registration

  1. In your tenant, register a public client application.
  2. Under API permissions, add the BI Pixie API delegated permissions your application needs, from the scopes below.
  3. Sign a user in with the device code flow or interactive sign-in. The user consents once.

Scopes

Scopes of the BI Pixie API
Scope Grants
BIPixie.Read.All Read the signed-in person's BI Pixie account.
BIPixie.ReadWrite.All Read the account and start work, within the limits of the plan.

When BI Pixie reaches Fabric for you

A call that reads or changes something in Fabric does so as the signed-in person, with the permissions that person granted to BI Pixie when they selected Connect Power BI in the BI Pixie portal. BI Pixie asks Microsoft for a Fabric token on the person's behalf for that one call and keeps no token after it. A person who has not granted the permission is answered 403 with errorCode FabricConsentRequired, and the consentUrl parameter is the portal page where they grant it.

What's next