# BI Connector

> Your Crowdin account data insights

URL: https://store.crowdin.com/bi-connector
Category: Manager Productivity
Type: App
Author: Awesome Crowdin

BI Connector comes with a set of comprehensive reports that cover a range of general project overview, target languages, issues created by translators, tasks created by you and other managers, users and translators, and even all the translations that have been done. All of the reports can be generated for a subset or for all of the projects in your Crowdin account.

## Reports
- **Projects Info**

Is a list of projects with quick summary of your projects progress. The following information is included in the report:
 > - Project ID and name
 > - Total strings and total words in projects
 > - Translation and approval progress between target languages
 > - Date of last activity
 > - Number of open issues
 > - Number of tasks, open tasks and tasks in progress
 > - Source and target languages
 
  - **Project Languages** 
  
This report is most useful when used as a pivot table. The report would allow you to have a list of your projects and their target language progress in one convenient dashboard. The report includes both translation and approval progress for each target language. Along with the information on total segments and words to be translated per language.
  
 - **Issues**
 
This report can be used for many purposes. One of them is to analyze translator requests and issues created during the translation process. It can be used as a data source for your dashboard of currently open issues that require your or your team's attention when integrated with the BI system.

 - **Users**
 
The report would include all project members of selected projects. You can use the data to track the number of linguists involved in each project, track linguists joining your projects over time and their time zones.
 
 - **Translations**
 
The report contains information about *every* translation made in your project. Information about how the translation was done is included in all records. Whether there was a TM match, whether the translator used an MT translation without making any changes, whether approved, and the dates of each event. If you want to track and graph your workload over time, this report can very useful.

**Note**: You may need to run this report multiple times for some of your projects if you have many large projects with many target languages and translations.

 - **Tasks**
 
Reports about your tasks are not part of this application. Please consider using the [Time-in-Status](https://store.crowdin.com/time-in-status) app to run and download reports on tasks in your Crowdin projects.

## Screenshot

![Crowdin BI Connector](https://developers.app.crowdin.net/api/media/file/787caea5-1c62-4dc7-9700-2a0bc3dc091c.png)

## API
This app offers an `/reports` endpoint that enables you to automate data refreshing when integrating the data into your BI system.

### Sample API call for crowdin.com

```bash
curl --request GET \
  --url 'https://crowdin.com/api/v2/applications/bi-connector/api/reports?report=raw&projects=31' \
  --header 'Authorization: Bearer 9c1d05d5e353x19078c84c73c4cf986ee1axee903462e7b07x384e3c474c5c1ex5bbcf6b6dbf7a8e' \
  --header 'Content-Type: application/json'
```

### Sample API call for Crowdin Enterprise
```bash
curl --request GET \
  --url 'https://acme.crowdin.com/api/v2/applications/bi-connector/api/reports?report=raw&projects=479&startDate=2023-06-01T06%3A32%3A01.048Z&endDate=2023-06-23T06%3A32%3A01.048Z' \
  --header 'Authorization: Bearer 9c1d05d5e353x19078c84c73c4cf986ee1axee903462e7b07x384e3c474c5c1ex5bbcf6b6dbf7a8e'
  ```
  
The `/reports` endpoint takes the query parameters `report` and `projects`. `report` can take one of the following values `languages`, `projects`, `raw`, `issues`, `users`. `projects` parameter is a comma-separated list of Crowdin project IDs. There are two other required parameters, `startDate` and `endDate`, in the `raw` report.

Set the `report` parameter to `list-projects` to get a list of all Crowdin projects. 
  
A valid Personal Crowdin API token or OAuth token is used for authorization.