Bitrix24 Helpdesk

Debug BI Connector requests in Bitrix24

Request debugging helps you find and fix errors in BI Connector queries. Use it if your reports load slowly or show incorrect data.

In this article:


Send a BI Connector request in a browser

Use the following URL:

https://account_name.bitrix24.com/bitrix/tools/biconnector/pbi.php?token=key_bi-connector&table=crm_deal
  1. Replace account_name with your Bitrix24 account name.
  2. To view data in Microsoft Power BI, use pbi.php.
    For Looker Studio (formerly Google Data Studio), use gds.php?data&.
  3. Add your token from Analytics > BI Analytics > Key Management.
  4. Add the entity you want to retrieve data from.
    In this example, we use crm_deal, which returns the list of deals.
For more information, see Description of entity fields in BI Analytics.

After you run the request, Bitrix24 returns all entity fields and their values from your account. This helps you check which fields are available and what data they contain.


Send a BI Connector request in Postman

Large responses can be hard to review in a browser. We recommend using Postman instead.

Postman is an API tool that lets you send requests and inspect responses.

For more information, see the Postman documentation.

To create a request:

  1. Click Create new collection > Add a request.
  2. Select the POST method.
  3. Enter the request URL:
  4. https://account_name.bitrix24.com/bitrix/tools/biconnector/pbi.php?table=crm_deal

  5. Add the key to the request body.
  6. Click Send.

Postman shows how long the request takes and what data it returns.


Test queries before you create a report

Before you create a report or load data from leads, deals, or custom fields, test your queries in Postman.

For example, a monthly deals report may return a large amount of unnecessary data. Add filters to reduce the dataset and improve report performance.

If you need specific fields and want to filter deals by creation date, use the following request:

 { "dateRange": { "startDate": "2023-03-22", "endDate": "2023-03-23" }, "configParams": { "timeFilterColumn": "DATE_CREATE" }, "fields": [ { "name": "ID" }, { "name": "DATE_CREATE" }, { "name": "DATE_MODIFY" } ] } 

Parameter description:

  • dateRange sets the date range.
  • configParams uses the DATE_CREATE field to filter deals by creation date.
  • fields defines which fields to return.

In this example, the request returns:

  • Deal ID
  • Creation date
  • Modification date

Run the request and review the results. Update the query if needed.

To limit the returned data, add the dimentionsFilters parameter.

 { "dimensionsFilters": [ [ { "fieldName": "ID", "values": [581, 601], "type": "INCLUDE", "operator": "EQUALS" } ] ] } 

For more information about dimentionsFilters and other parameters, see the Looker Studio documentation.

In Looker Studio, filters are configured in the report settings, so you do not need to add them manually.

Microsoft Power BI also supports filters and parameters, but you must configure them in the Advanced Editor.

For more information, see Filter report data by different dates in Microsoft Power BI.

Was this information helpful?
Thank you for your feedback.
Get Implementation Help from a Partner
That's not what I'm looking for
Complicated and incomprehensible text
The information is outdated
It's too short. I need more information
I don't like the way this tool works
Get your Bitrix24 set up by local professionals
FIND BITRIX24 PARTNER NEAR ME
implementation_helper_man
Go to Bitrix24
Don't have an account? Create for free
Related articles
BI analytics settings Manage keys in BI analytics Time zone in Date/time fields in BI reports Combine deals with stage history in Google Looker Studio BI analytics in Bitrix24 Add custom deal types to BI analytics reports Limitations of BI Analytics for Bitrix24 On‑Premise Manage reports in BI analytics