Actions5
- Translation Actions
- Import Actions
- Export Actions
Overview
The Tolgee node integrates with the Tolgee API to manage translations within projects. Specifically, the "Get Translations" operation retrieves translation keys and their corresponding translations from a specified Tolgee project. This is useful for synchronizing translation data, auditing translation statuses, or extracting localized content for further processing.
Common scenarios include:
- Fetching all or filtered translations for a project to display in an application.
- Auditing translation completeness or quality by filtering keys based on translation states or presence of screenshots.
- Exporting translation data for backup or migration purposes.
Example: A localization manager wants to retrieve all translated keys in English and Spanish for a project, filtering out keys without screenshots, to prepare a report on translation coverage.
Properties
| Name | Meaning |
|---|---|
| Project Name or ID | The identifier of the Tolgee project to query. Choose from a list of accessible projects or specify an ID via expression. |
| Language Names or IDs | Select one or more languages (by name or tag) from the project to filter translations. Only translations in these languages will be returned. |
| Search | A string to search for within key names or translation texts, allowing filtering of results containing this substring. |
| Filter Auto Translated In Language | Filters keys where the translation was automatically generated for specified languages (comma-separated). |
| Filter Has No Screenshot | If true, only keys without associated screenshots are selected. |
| Filter Has Screenshot | If true, only keys with associated screenshots are selected. |
| Filter Key IDs | Comma-separated list of specific key IDs to select. |
| Filter Key Names | Comma-separated list of specific key names to select. |
| Filter Namespace | Comma-separated list of namespaces; only keys within these namespaces are selected. |
| Filter No Namespace | Comma-separated list of namespaces; only keys outside these namespaces are selected. |
| Filter No Tag | Comma-separated list of tags; only keys without these tags are selected. |
| Filter Not Outdated Language | Comma-separated list of languages; selects keys where translations in these languages are not outdated. |
| Filter Outdated Language | Comma-separated list of languages; selects keys where translations in these languages are outdated. |
| Filter State | Translation state filter in the format languageTag,state (e.g., en,TRANSLATED) to select keys matching that state. |
| Filter Tag | Comma-separated list of tags; only keys with these tags are selected. |
| Filter Translated Any | If true, selects only keys that have translations provided in any language. |
| Filter Translated In Language | Selects only keys with translations provided in the specified language (e.g., en-US). |
| Filter Untranslated Any | If true, selects only keys missing translations in any returned language. |
| Filter Untranslated In Language | Selects only keys missing translations in the specified language (e.g., en-US). |
| Pagination - Page | Zero-based index of the page to return (default 0). |
| Pagination - Size | Number of items per page to return (default 20). |
| Pagination - Sort | Sorting criteria in the format `property,(asc |
Output
The node outputs JSON data representing the retrieved translation keys and their translations according to the applied filters and pagination. Each item typically includes:
- Key details such as ID, name, namespace, and tags.
- Translations for the requested languages, including text and metadata like translation state.
- Additional metadata such as whether the translation was auto-translated or has associated screenshots.
If binary data were involved (e.g., screenshots), it would be summarized accordingly, but this operation focuses on JSON translation data.
Dependencies
- Requires an API key credential for authenticating with the Tolgee API.
- Needs the Tolgee project domain URL configured in credentials.
- The node uses HTTP requests to Tolgee's REST API endpoints to fetch projects, languages, namespaces, and translations.
- Proper permissions on the Tolgee API key are necessary to access project translation data.
Troubleshooting
- Failed to load languages/projects/namespaces: Indicates issues fetching options for dropdowns, often due to invalid API credentials or network issues. Verify the API key and domain URL.
- Empty results despite valid inputs: Check filter parameters; overly restrictive filters may exclude all keys.
- Pagination issues: Ensure page and size values are within valid ranges; zero-based indexing applies.
- API rate limits or timeouts: Large queries might hit API limits; consider reducing page size or applying more selective filters.
- Invalid filter formats: Filters expecting comma-separated lists or specific formats must be correctly formatted to avoid errors.