Pixies reference

Add Pixies to a report #

POST /v1/workspaces/{workspaceId}/reports/{reportId}/addPixies

Adds Pixies to the report, or updates the Pixies it has, with the workspace's saved tracking setup, exactly as the BI Pixie portal's Add Pixies does: the same job, the same tracked-item accounting, and the report then shows under Managed reports. The request has no body.

BI Pixie looks up the workspace and the report as the signed-in person before anything is counted. An id that person cannot see answers 404 or 403 and spends nothing. A report with no Pixies yet becomes a tracked item, and the operation's allowanceImpact says so; the account's tracked items and, on an account with more than one license, the license's own allocation are checked before anything is queued. A report already being worked on answers 409 OperationInProgress, naming the operation that holds it in parameters when that operation was started through this API, and a paused capacity 409 CapacityPaused.

The operation's state follows the job the portal's own progress bar follows, and its result is the report's outcome: Added or Updated. A report the job could not change fails the operation, and the operation's state says why.

When an administrator of the account has turned Add Pixies off in Account settings, the call answers 403 FeatureTurnedOff before anything is looked up or counted, and nothing is started. Removing Pixies still works.

The account has ten Add Pixies and Remove Pixies calls a minute, whoever makes them, a call over many reports counting as one; the eleventh answers 429 RequestBlocked with Retry-After, and nothing is started for it.

Scope

BIPixie.ReadWrite.All

Plan

Every plan

Counts against

Calls that start work, 30 a minute

Parameters

Responses

202. The work was started. The body carries the operation's id and address.

To follow the work this call started, see Follow a long-running operation.

Errors

Every refusal is an ErrorResponse with a stable errorCode. See Errors for what each HTTP status means and every code the API can return.

This is an example of a refusal. Every refusal has the same fields.

HTTP/1.1 404 Not Found
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "errorCode": "ItemNotFound",
  "message": "No item with this id is visible to the signed-in person in this workspace, or it is not of the type the route takes.",
  "isRetriable": false,
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa",
    "resourceType": "SemanticModel"
  },
  "parameters": [
    {
      "name": "itemId",
      "value": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa"
    }
  ],
  "requestId": "cbf21b6d-b661-4b52-88cb-d79712e504fc"
}

Example

curl -i -X POST \
  -H "Authorization: Bearer $TOKEN" \
  "https://api.bipixie.com/v1/workspaces/$WORKSPACE_ID/reports/$REPORT_ID/addPixies"

An example of what the call answers. The values are fictional.

HTTP/1.1 202 Accepted
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc
x-ms-operation-id: cd57b041-e44a-4dda-a4ff-02935ffb8c04
Location: https://api.bipixie.com/v1/operations/cd57b041-e44a-4dda-a4ff-02935ffb8c04
Retry-After: 5

{
  "operationId": "cd57b041-e44a-4dda-a4ff-02935ffb8c04",
  "location": "https://api.bipixie.com/v1/workspaces/e17c1b59-7a2e-491e-acdd-11434854bbb0/reports/da9c7604-a038-4f15-83b2-067e408dc0bf/addPixies"
}

Remove Pixies from a report #

POST /v1/workspaces/{workspaceId}/reports/{reportId}/removePixies

Removes the report's Pixies, as the BI Pixie portal's Remove Pixies does, and answers with the operation to ask about. The request has no body. The tracked item stays counted: removing Pixies does not lower the account's count, and the result says so with trackedItemReleased: false.

BI Pixie looks up the workspace and the report as the signed-in person first. A report already being worked on answers 409 OperationInProgress, naming the operation that holds it in parameters when that operation was started through this API. The result is the report's outcome, Removed. A report the job could not change fails the operation, and the operation's state says why. The call counts against the account's ten Add Pixies and Remove Pixies calls a minute (429 RequestBlocked past them).

Scope

BIPixie.ReadWrite.All

Plan

Every plan

Counts against

Calls that start work, 30 a minute

Parameters

Responses

202. The work was started. The body carries the operation's id and address.

To follow the work this call started, see Follow a long-running operation.

Errors

Every refusal is an ErrorResponse with a stable errorCode. See Errors for what each HTTP status means and every code the API can return.

This is an example of a refusal. Every refusal has the same fields.

HTTP/1.1 404 Not Found
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "errorCode": "ItemNotFound",
  "message": "No item with this id is visible to the signed-in person in this workspace, or it is not of the type the route takes.",
  "isRetriable": false,
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa",
    "resourceType": "SemanticModel"
  },
  "parameters": [
    {
      "name": "itemId",
      "value": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa"
    }
  ],
  "requestId": "cbf21b6d-b661-4b52-88cb-d79712e504fc"
}

Example

curl -i -X POST \
  -H "Authorization: Bearer $TOKEN" \
  "https://api.bipixie.com/v1/workspaces/$WORKSPACE_ID/reports/$REPORT_ID/removePixies"

An example of what the call answers. The values are fictional.

HTTP/1.1 202 Accepted
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc
x-ms-operation-id: cd57b041-e44a-4dda-a4ff-02935ffb8c04
Location: https://api.bipixie.com/v1/operations/cd57b041-e44a-4dda-a4ff-02935ffb8c04
Retry-After: 5

{
  "operationId": "cd57b041-e44a-4dda-a4ff-02935ffb8c04",
  "location": "https://api.bipixie.com/v1/workspaces/e17c1b59-7a2e-491e-acdd-11434854bbb0/reports/da9c7604-a038-4f15-83b2-067e408dc0bf/removePixies"
}

Add Pixies to many reports #

POST /v1/workspaces/{workspaceId}/reports/addPixies

Adds Pixies to the reports the body names, or updates the Pixies they have, in one job, as the BI Pixie portal's Add Pixies does for a selection. The body names at least one report and at most 100, all in this workspace. BI Pixie looks up the workspace and the reports as the signed-in person from one listing before anything is counted; a report that person cannot see answers 404 ItemNotFound naming every such report in parameters, and nothing is started.

When an administrator of the account has turned Add Pixies off in Account settings, the call answers 403 FeatureTurnedOff before anything is looked up or counted, and nothing is started. Removing Pixies still works.

The caps are checked once for the whole run: every report with no Pixies yet becomes a tracked item, and the operation's allowanceImpact says how many. A report already being worked on answers 409 OperationInProgress for the whole call, naming the operation that holds it in parameters when that operation was started through this API, and a paused capacity 409 CapacityPaused.

The operation's result lists each report's outcome with how many succeeded and how many failed. A report the job could not change is Failed with the reason in the API's own words; the operation itself fails only when no report was changed. The call counts as one of the account's ten Add Pixies and Remove Pixies calls a minute, however many reports it names (429 RequestBlocked past them).

Scope

BIPixie.ReadWrite.All

Plan

Every plan

Counts against

Calls that start work, 30 a minute

Parameters

Request body

JSON, PixiesBulkRequest. The body is required.

Responses

202. The work was started. The body carries the operation's id and address.

To follow the work this call started, see Follow a long-running operation.

Errors

Every refusal is an ErrorResponse with a stable errorCode. See Errors for what each HTTP status means and every code the API can return.

This is an example of a refusal. Every refusal has the same fields.

HTTP/1.1 404 Not Found
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "errorCode": "ItemNotFound",
  "message": "No item with this id is visible to the signed-in person in this workspace, or it is not of the type the route takes.",
  "isRetriable": false,
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa",
    "resourceType": "SemanticModel"
  },
  "parameters": [
    {
      "name": "itemId",
      "value": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa"
    }
  ],
  "requestId": "cbf21b6d-b661-4b52-88cb-d79712e504fc"
}

Example

curl -i -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reportIds": [
    "<uuid>"
  ]
}' \
  "https://api.bipixie.com/v1/workspaces/$WORKSPACE_ID/reports/addPixies"

An example of what the call answers. The values are fictional.

HTTP/1.1 202 Accepted
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc
x-ms-operation-id: cd57b041-e44a-4dda-a4ff-02935ffb8c04
Location: https://api.bipixie.com/v1/operations/cd57b041-e44a-4dda-a4ff-02935ffb8c04
Retry-After: 5

{
  "operationId": "cd57b041-e44a-4dda-a4ff-02935ffb8c04",
  "location": "https://api.bipixie.com/v1/workspaces/e17c1b59-7a2e-491e-acdd-11434854bbb0/reports/addPixies"
}

Remove Pixies from many reports #

POST /v1/workspaces/{workspaceId}/reports/removePixies

Removes the Pixies of the reports the body names, at least one and at most 100, all in this workspace, in one job. BI Pixie looks up the workspace and the reports as the signed-in person from one listing first; a report that person cannot see answers 404 ItemNotFound naming every such report, and nothing is started. A report already being worked on answers 409 OperationInProgress for the whole call, naming the operation that holds it in parameters when that operation was started through this API. The tracked items stay counted, and each report's result says so.

The operation's result lists each report's outcome with how many succeeded and how many failed; the operation itself fails only when no report was changed. The call counts as one of the account's ten Add Pixies and Remove Pixies calls a minute, however many reports it names (429 RequestBlocked past them).

Scope

BIPixie.ReadWrite.All

Plan

Every plan

Counts against

Calls that start work, 30 a minute

Parameters

Request body

JSON, PixiesBulkRequest. The body is required.

Responses

202. The work was started. The body carries the operation's id and address.

To follow the work this call started, see Follow a long-running operation.

Errors

Every refusal is an ErrorResponse with a stable errorCode. See Errors for what each HTTP status means and every code the API can return.

This is an example of a refusal. Every refusal has the same fields.

HTTP/1.1 404 Not Found
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "errorCode": "ItemNotFound",
  "message": "No item with this id is visible to the signed-in person in this workspace, or it is not of the type the route takes.",
  "isRetriable": false,
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa",
    "resourceType": "SemanticModel"
  },
  "parameters": [
    {
      "name": "itemId",
      "value": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa"
    }
  ],
  "requestId": "cbf21b6d-b661-4b52-88cb-d79712e504fc"
}

Example

curl -i -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reportIds": [
    "<uuid>"
  ]
}' \
  "https://api.bipixie.com/v1/workspaces/$WORKSPACE_ID/reports/removePixies"

An example of what the call answers. The values are fictional.

HTTP/1.1 202 Accepted
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc
x-ms-operation-id: cd57b041-e44a-4dda-a4ff-02935ffb8c04
Location: https://api.bipixie.com/v1/operations/cd57b041-e44a-4dda-a4ff-02935ffb8c04
Retry-After: 5

{
  "operationId": "cd57b041-e44a-4dda-a4ff-02935ffb8c04",
  "location": "https://api.bipixie.com/v1/workspaces/e17c1b59-7a2e-491e-acdd-11434854bbb0/reports/removePixies"
}

List the reports in a workspace #

GET /v1/workspaces/{workspaceId}/reports

The Power BI reports in the workspace that you can see, each with the semantic model it is built on and whether it has Pixies, so you can add Pixies to a report without looking up its id elsewhere. With semanticModelId, only the reports built on that semantic model. Paginated reports are not listed, because Pixies are not added to them.

BI Pixie reads the reports from Power BI as you, so it needs your Fabric permission, and a missing one answers FabricConsentRequired with the page that grants it. Whether each report has Pixies comes from the account's own record, as in GET .../reports/{reportId}/pixies. Ordered by name and paged. Reading the list spends nothing.

Scope

BIPixie.Read.All

Plan

Every plan

Counts against

Calls that read, 300 a minute

Parameters

Responses

200. The reports.

Errors

Every refusal is an ErrorResponse with a stable errorCode. See Errors for what each HTTP status means and every code the API can return.

This is an example of a refusal. Every refusal has the same fields.

HTTP/1.1 404 Not Found
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "errorCode": "ItemNotFound",
  "message": "No item with this id is visible to the signed-in person in this workspace, or it is not of the type the route takes.",
  "isRetriable": false,
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa",
    "resourceType": "SemanticModel"
  },
  "parameters": [
    {
      "name": "itemId",
      "value": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa"
    }
  ],
  "requestId": "cbf21b6d-b661-4b52-88cb-d79712e504fc"
}

Example

curl -i -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://api.bipixie.com/v1/workspaces/$WORKSPACE_ID/reports"

An example of what the call answers. The values are fictional.

HTTP/1.1 200 OK
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "value": [
    {
      "reportId": "da9c7604-a038-4f15-83b2-067e408dc0bf",
      "reportName": "Contoso Sales Overview",
      "semanticModelId": "f1fdc461-3ca1-4702-ae48-afc3522409fc",
      "semanticModelWorkspaceId": "1dd2174c-13d9-4799-aa78-2122f3b5d027",
      "hasPixies": true,
      "pixiesStatus": "HasPixies",
      "lastChangedUtc": "2026-09-14T09:42:17Z",
      "trackedItem": true
    }
  ],
  "continuationToken": "eyJza2lwIjoxMDB9",
  "continuationUri": "https://api.bipixie.com/v1/workspaces/e17c1b59-7a2e-491e-acdd-11434854bbb0/reports?continuationToken=eyJza2lwIjoxMDB9"
}

Get what a report has #

GET /v1/workspaces/{workspaceId}/reports/{reportId}/pixies

Whether the report has Pixies, the pages and visuals they track, when they last changed, and the newest operation this account started on it. From the account's own record, the row the BI Pixie portal's Managed reports shows, and for a report with Pixies from the record BI Pixie kept of its pages and visuals when Pixies were last added. Spends nothing. A report this account never added Pixies to answers status NeverAdded.

Fabric is asked only for the name of a report the account keeps no record of, as the signed-in person. When that lookup fails, reportName is null and the read still answers.

The version of Pixies written into a report is not recorded, so pixieVersion is always null. Each field that is null for a reason a caller could not tell from the rest of the answer is named in unavailableReasons, with the reason in a sentence.

The tracking setup the Pixies were added with is not offered through the API. Pixies are always added with the workspace's saved tracking setup, which is chosen and changed in the BI Pixie portal.

Scope

BIPixie.Read.All

Plan

Every plan

Counts against

Calls that read, 300 a minute

Parameters

Responses

200. What the account's record says the report has.

Errors

Every refusal is an ErrorResponse with a stable errorCode. See Errors for what each HTTP status means and every code the API can return.

This is an example of a refusal. Every refusal has the same fields.

HTTP/1.1 404 Not Found
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "errorCode": "ItemNotFound",
  "message": "No item with this id is visible to the signed-in person in this workspace, or it is not of the type the route takes.",
  "isRetriable": false,
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa",
    "resourceType": "SemanticModel"
  },
  "parameters": [
    {
      "name": "itemId",
      "value": "d972b3f5-a2fa-47ec-94ff-0403a4d159fa"
    }
  ],
  "requestId": "cbf21b6d-b661-4b52-88cb-d79712e504fc"
}

Example

curl -i -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://api.bipixie.com/v1/workspaces/$WORKSPACE_ID/reports/$REPORT_ID/pixies"

An example of what the call answers. The values are fictional.

HTTP/1.1 200 OK
Content-Type: application/json
x-ms-request-id: cbf21b6d-b661-4b52-88cb-d79712e504fc

{
  "reportId": "da9c7604-a038-4f15-83b2-067e408dc0bf",
  "workspaceId": "e17c1b59-7a2e-491e-acdd-11434854bbb0",
  "reportName": "Contoso Sales Overview",
  "hasPixies": true,
  "status": "HasPixies",
  "pixieVersion": null,
  "pagesTracked": 3,
  "visualsTracked": 3,
  "lastChangedUtc": "2026-09-14T09:42:17Z",
  "trackedItem": true,
  "lastOperation": {
    "id": "3f4bc9c2-b27e-49df-9de1-a78801b93655",
    "operationType": "AddPixies",
    "status": "NotStarted",
    "createdTimeUtc": "2026-06-03T14:12:00Z",
    "lastUpdatedTimeUtc": "2026-09-14T09:42:17Z",
    "error": {
      "errorCode": "AssessmentTimedOut",
      "message": "The semantic model could not be read."
    }
  },
  "unavailableReasons": {
    "pixieVersion": "BI Pixie does not record which version of Pixies it wrote into a report, so the version is not given."
  }
}