Reports Module

The module allows the creation and insertion of a new report within the Crowdin or Crowdin Enterprise project. You can find it in the Reports section.

To add a report to the Reports of a Crowdin Enterprise organization or group, use the Organization Reports module.

Access

You can grant access to this module to one of the following user categories:

For Crowdin:

• Only me (i.e., project owner)
• All project members
• Selected users

For Crowdin Enterprise:

• Only organization admins
• All users in the organization projects
• Selected users

Structure

manifest.json

{
  "modules": {
    "project-reports": [
      {
        "key": "your-module-key",
        "name": "Module name",
        "description": "Module description",
        "logo": "/logo.png",
        "url": "/reports-page"
      }
    ]
  }
}

Properties

key	Type: string Required: yes Description: Module identifier within the Crowdin app.
name	Type: string Required: yes Description: The human-readable name of the module.
description	Type: string Description: The human-readable description of what the module does. The description will be visible in the Crowdin Enterprise UI.
logo	Type: string Required: yes Description: The relative URL to the tool’s logo that will be displayed in the Crowdin Enterprise UI. The recommended resolution is 48x48 pixels.
url	Type: string Required: yes (self-hosted apps only) Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI.
environments	Type: string Allowed values: crowdin, crowdin-enterprise Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.