Crowdin Query Language (CroQL)

Crowdin Query Language (CroQL) is a tool for Crowdin Editor and Crowdin Enterprise Editor and Crowdin and Crowdin Enterprise API that allows you to retrieve needed localization resources based on specific conditions. Using CroQL, you can filter source strings and their translations for a specific target language, as well as TM segments.

You can use CroQL with the following API methods:

Operatorer

CroQL-hovedoperatorer er anført nedenfor. Benyt og kombinér dem for at opsætte særlige betingelser for at hente indhold fra Crowdin. Elementerne fra tabellerne nedenfor kan bruges til at danne CroQL-forespørgslen.

Aritmetiske operatorer

De aritmetiske operatorer bruges til at udføre matematiske operationer med enhver numeriske datatype.

Navn Symbol Eksempel
Addition + 1 + 9
Subtraktion - 11 - 1
Division / 20 / 2
Multiplikation * 2 * 5
Negation - -10

Sammenligningsoperatorer

Sammenligningsoperatorer bruges til at sammenligne værdier og returnere true eller false.

Navn Symbol Aliaser Eksempel
Mellem {{expression}} mellem {{expression}} og {{expression}} 5 mellem 1 og 10
Lig med = 10 = 10
Ikke lig med != 1 != 10; 1 ≠ 10
Større end > 10 > 1
Større end eller lig med >= 10 >= 1; 10 ≥ 1
Mindre end < 1 < 10
Mindre end eller lig med <= 1 <= 10; 1 ≤ 10;
Contains {{string}} contains {{string}} "Hello World" contains "Hello";
"Hello World" contains text;
text contains "Hello World";
context contains text;

Logiske operatorer

Logiske operatører bruges til at kombinere flere booleske udtryk/værdier og give et enkelt boolesk output.

Navn Symbol Eksempel
Og og 1 < 10 and 10 > 1
Eller eller 1 < 10 or 10 > 1
Xor xor 1 < 10 xor 10 > 1
Ikke ikke not 1 < 10

Filtreringsoperatorer

Filtreringsoperatorer anvendes til at filtrere objekter baseret på den angivne tilstand.

Navn Symbol Eksempel
Filter {{collection}} where {{predicate}} translations where (count of votes > 0)
Match {{object}} med {{predicate}} bruger med (login = "crowdin")

Betinget (ternær) operator

The ternary operator is used to check a condition specified in the first value, and if it’s true it returns the second value, but if it’s false it returns the third value.

Navn Symbol Eksempel
Ternær If {{condition}} then {{expression}} else {{expression}} If 1 < 10 then "less" else "greater"

Hent-operatorer

Hent-operatører bruges til at hente data fra objekterne.

Name Symbol Example
Nævn @user:{{string}}; @language:{{string}} @user:"crowdin"; @language:"en"
Medlem {{member}} of {{object}} antal af oversættelser
Identifikator {{identifier}} text; identifier

Skalaroperatorer

Skalaroperatorer bruges til at erklære værdier til videre behandling.

Navn Symbol Eksempel
Integer {{integer}} 10
Flydende {{float}} 10.01
Streng {{string}} “crowdin"
Datotid {{datetime}} 'i dag'; '2021-03-16 00:00:00'

Gruppeoperator

Gruppeoperatorer bruges til at fastlægge operatorers eksekveringssrækkefølge.

Navn Symbol Eksempel
Gruppér ( ) 1 < 10 and (20 > 10 or 10 > 5)

CroQL Query Examples

In this section, you can find practical examples of CroQL queries that will help you understand and use the querying capabilities within Crowdin. These examples can help you learn how to create your own queries to retrieve specific sets of data based on various criteria, such as translation status, user activity, and string properties.

Strings Queries

These queries are used to retrieve information about source strings.

  • Strings that have no Ukrainian translations with approvals or votes:
count of translations where ( language = @language:"uk" and ( count of approvals > 0 or count of votes > 0 ) ) = 0
  • Strings that have only one translation:
count of translations = 1
  • Strings that have translations from only one specific user:
count of translations > 0 and count of translations = count of translations where (user = @user:"crowdin")
  • Strings that have at least one translation not from specific users:
count of translations where (user != @user:"crowdin") > 0
  • Strings that have all translations not from specific users:
count of translations > 0 and count of translations = count of translations where (user != @user:"crowdin")
  • Strings filtered by identifier and numeric id of a file in your Crowdin project:
identifier = "key" and id of file = 777
  • Strings that have unresolved issues filtered by numeric id of a file in your Crowdin project:
id of file = 777 and count of comments where (has unresolved issue) > 0
  • Hidden strings that are not duplicates and have one or more translations:
is hidden and not is duplicate and count of translations > 0
  • Strings that have one or more approvals:
count of languages summary where (approvalsCount >= 1) > 0
  • Strings that have comments made by the user with a crowdin username:
count of comments where (user = @user:"crowdin") > 0
  • Strings that contain “ABC” in the source text but don’t contain “ABC” in their translations:
text contains "ABC" and (count of translations where (text contains "ABC") = 0)
Using String Queries in Crowdin API:
Use your query in the following Crowdin API endpoints:

Crowdin:
GET https://api.crowdin.com/api/v2/projects/{projectId}/strings?croql={croql}
Crowdin Enterprise:
GET https://{organization_domain}.api.crowdin.com/api/v2/projects/{projectId}/strings?croql={croql}
Note: Before executing the request, ensure to URL encode your CroQL expression.
{projectId}

Type: integer

Beskrivelse: Numerisk identifikator for Crowdin-projektet.

{croql}

Type: string

Beskrivelse: CroQL-udtryk.

Translation Queries

These queries are used to retrieve information about translations.

  • Translations made by the user with a crowdin username or ones with ≥ 100 upvotes:
user = @user:"crowdin" or count of votes where ( is up ) >= 100
Using Translation Queries in Crowdin API:
Use your query in the following Crowdin API endpoints:

Crowdin:
GET https://api.crowdin.com/api/v2/projects/{projectId}/languages/uk/translations?croql={croql}
Crowdin Enterprise:
GET https://{organization_domain}.api.crowdin.com/api/v2/projects/{projectId}/languages/uk/translations?croql={croql}
Note: Before executing the request, ensure to URL encode your CroQL expression.
{projectId}

Type: integer

Beskrivelse: Numerisk identifikator for Crowdin-projektet.

{croql}

Type: string

Beskrivelse: CroQL-udtryk.

Translation Memory Segment Queries

These queries are used to retrieve information about TM segments.

  • Translation memory segments containing at least one record used one or more times:
count of records where (usageCount > 0) > 0
  • Translation memory segments containing at least one record created by the user with a crowdin username:
count of records where (createdBy = @user:"crowdin") > 0
Using Translation Memory Segment Queries in Crowdin API:
Use your query in the following Crowdin API endpoints:

Crowdin:
GET https://api.crowdin.com/api/v2/tms/{tmId}/segments?croql={croql}
Crowdin Enterprise:
GET https://{organization_domain}.api.crowdin.com/api/v2/tms/{tmId}/segments?croql={croql}
Note: Before executing the request, ensure to URL encode your CroQL expression.
{projectId}

Type: integer

Description: Numeric identifier of your Crowdin project.

{croql}

Type: string

Description: CroQL expression.

CroQL Query Examples based on the Editor Advanced Filter Options

Note: To use the following queries in Crowdin API, ensure to specify the needed target language (e.g., count of languages summary where (language = @language:"uk" and is translated) > 0) in your CroQL query.
  • Strings added:
    added between '2023-12-06 13:44:14' and '2023-12-07 13:44:14'
    
  • Strings updated:
    updated between '2023-12-06 13:44:14' and '2023-12-07 13:44:14'
    
  • Translations updated:
    count of languages summary where ( translation updated between '2023-12-06 13:44:14' and '2023-12-07 13:44:14') > 0
    
  • Verbal Expressions: Not available
  • Verbal Expression Scope: Not available
  • Translations:
    • Untranslated:
        count of languages summary = 0
      
    • Partially translated (plurals):
        count of languages summary where (is partially translated) > 0
      
    • Translated:
        count of languages summary where (is translated) > 0
      
    • Same as source string:
        count of languages summary where (has translation as source) > 0
      
    • Modified source String:
        count of languages summary where (is source changed after translation) > 0
      
  • Duplicates:
    • Master strings:
        not is duplicate
      
    • Duplicates only:
        is duplicate
      
    • Duplicates with shared translations:
        is duplicate and count of languages summary where (has shared translation) > 0
      
    • Duplicates with own translations:
        is duplicate and count of languages summary where (not has shared translation and is translated) > 0
      
  • Approvals:
    • Translated, not approved:
        count of languages summary where (is translated and not is approved) > 0
      
    • Partially approved (plurals):
        count of languages summary where (is partially approved) > 0
      
    • Approved:
        count of languages summary where (is approved) > 0
      
    • Has translations after approval:
        count of languages summary where (has translation after approval) > 0
      
  • TM and MT:
    • Translated by MT:
        count of languages summary where (is translated by mt) > 0
      
    • Translated by TM:
        count of languages summary where (is translated by tm) > 0
      
    • Translated by TM or MT:
        count of languages summary where (is auto translated) > 0
      
  • Pre translation:
    • Used: Not available
    • Not used: Not available
  • Comments:
    count of comments > 0
    
  • Screenshots:
    count of screenshots > 0
    
  • QA Issues:
    count of languages summary where (has qa issues) > 0
    
  • String Type:
    type is plain or type is icu
    
  • Votes:
    count of languages summary where (rating > 0) > 0
    
  • Translated by:
    count of translations where (user = @user:"crowdin") > 0
    
  • Not Translated by:
    count of translations where (user != @user:"crowdin") > 0
    
  • Approved by:
    count of translations where (count of approvals where (user = @user:"crowdin") > 0) > 0
    
  • Not Approved by:
    count of translations where (count of approvals where (user != @user:"crowdin") > 0) > 0
    
  • Sort by: Not available

Context

CroQL can be used in the following contexts: source string context, translation context, and translation memory (TM) segment context. Use the following examples as a basis for building your CroQL queries.

Kildestrengskontekst

{
  "type is plain": true,
  "type is plural": false,
  "type is icu": false,
  "type is asset": false,
  "text": "Quick Start",
  "identifier": "quick_start",
  "context": "quick_start",
  "max length": 0,
  "is visible": true,
  "is hidden": false,
  "is duplicate": false,
  "isPassedWorkflow": true,
  "file": {
    "id": 32,
    "name": "sample.csv",
    "title": "Sample",
    "type": "csv",
    "context": "Some useful context information"
  },
  "comments": [
    {
      "has issue": false,
      "has unresolved issue": false,
      "user": 1
    }
  ],
  "screenshots": [],
  "translations": [
    {
      "text": "Швидкий старт",
      "plural form": "none",
      "is pre translated": true,
      "provider": "tm",
      "language": "uk",
      "user": 1,
      "votes": [
        {
          "is up": true,
          "is down": false,
          "user": 2,
          "added": "2021-04-09 13:44:14"
        }
      ],
      "approvals": [
        {
          "user": 2,
          "added": "2021-04-09 13:44:14"
        }
      ],
      "updated": "2021-04-09 10:23:17"
    }
  ],
  "languages summary": [
    {
      "language": "en",
      "is translated": false,
      "is partially translated": false,
      "is approved": false,
      "is partially approved": false,
      "translation updated": false,
      "is auto translated": false,
      "is translated by tm": false,
      "is translated by mt": false,
      "is source changed after translation": false,
      "has translation as source": false,
      "has translation after approval": false,
      "has shared translation": false,
      "has qa issues": false,
      "has empty translation qa issues": false,
      "has translation length qa issues": false,
      "has tags mismatch qa issues": false,
      "has spaces mismatch qa issues": false,
      "has variables mismatch qa issues": false,
      "has punctuation mismatch qa issues": false,
      "has character case mismatch qa issues": false,
      "has special characters mismatch qa issues": false,
      "has incorrect translation qa issues": false,
      "has spelling qa issues": false,
      "has icu syntax qa issues": false,
      "has terms qa issues": false,
      "has duplicate translation qa issues": false,
      "has ftl syntax qa issues": false,
      "has android syntax qa issues": false,
      "has custom qa issues": false,
      "rating": 1,
      "approvalsCount": 1
    }
  ],
  "labels": [
    {
      "id": 1,
      "title": "label title",
      "is system": false
    }
  ],
  "added": "2021-04-08 12:33:27",
  "updated": "2021-04-08 12:33:27"
}
type is plain

Type: boolean

Beskrivelse: Kildestreng med almindelig tekst.

type is plural

Type: boolean

Beskrivelse: Kildestreng med flertalsformer.

type is icu

Type: boolean

Beskrivelse: Kildestreng med ICU.

type is asset

Type: boolean

Beskrivelse: Kildestreng er et aktiv.

text

Type: string

Beskrivelse: Kildestrengstekst.

identifier

Type: string

Beskrivelse: Kildestrengidentifikator (nøgle).

context

Type: string

Beskrivelse: Kildestrengskontekst.

max length

Type: integer

Description: The source string max.length.

is visible

Type: boolean

Beskrivelse: Kildestreng er synlig.

is hidden

Type: boolean

Beskrivelse: Kildestreng er skjult.

is duplicate

Type: boolean

Description: The source string is duplicate.

isPassedWorkflow

Type: boolean

Description: Crowdin Enterprise only. The source string passed through a project workflow.

file

Type: object

Description: The source string file.

comments

Type: array

Beskrivelse: Kildestrengskommentarer.

has issue

Type: boolean

Beskrivelse: Kildestreng med en problematik.

has unresolved issue

Type: boolean

Beskrivelse: Kildestreng med en uløst problematik.

user

Type: integer

Description: Numeric identifier of the user who added a comment.

screenshots

Type: array

Beskrivelse: Kildestrengsskærmfotos.

translations

Type: array

Oversættelse Kildestrengsoversættelse.

text

Type: string

Beskrivelse: Oversættelsestekst.

plural form

Type: string

Beskrivelse: Oversættelse i flertalsform.

is pre translated

Type: boolean

Description: Translation added via pre-translation.

provider

Type: string

Allowed values: tm, global_tm, google, google_automl, microsoft, crowdin, deepl, modernmt, amazon, watson, custom_mt

Description: Translation provided via translation memory or machine translation engine.

language

Type: string

Description: Language identifier specified as a string. Use the language codes, for example, "uk" for Ukrainian. To specify in queries, use the format: @language:"uk".

user

Type: integer

Description: Numeric identifier of the user who added a translation.

votes

Type: array

Beskrivelse: Rækken af stemmerne tilføjet oversættelsen.

is up

Type: boolean

Beskrivelse: Upvote.

is down

Type: boolean

Beskrivelse: Downvote.

user

Type: integer

Description: Numeric identifier of the user who added a vote for translation.

added

Type: datetime

Beskrivelse: Dato for, hvornår der blev stemt på en oversættelse.

approvals

Type: array

Beskrivelse: Rækken af de tilføjede oversættelsesgodkendelser.

user

Type: integer

Description: Numeric identifier of the user who approved a translation.

added

Type: datetime

Beskrivelse: Dato for, hvornår en oversættelse blev godkendt.

updated

Type: datetime

Beskrivelse: Dato for, hvornår en oversættelse blev opdateret.

languages summary

Type: array

Description: The source string top translations (the translations with the highest priority).

language

Type: string

Description: Language identifier specified as a string. Use the language codes, for example, "uk" for Ukrainian. To specify in queries, use the format: @language:"uk".

is translated

Type: boolean

Description: The source string is translated.

is partially translated

Type: boolean

Description: The source string is partially translated.

is approved

Type: boolean

Description: The source string is approved.

is partially approved

Type: boolean

Description: The source string is partially approved.

translation updated

Type: boolean

Description: The source string translation is updated.

is auto translated

Type: boolean

Description: The source string is translated by TM or MT.

is translated by tm

Type: boolean

Description: The source string is translated by TM.

is translated by mt

Type: boolean

Description: The source string is translated by MT.

is source changed after translation

Type: boolean

Description: The source string changed after translation.

has translation as source

Type: boolean

Description: The source string has translation equal to source text.

has translation after approval

Type: boolean

Description: The source string has translation after approval.

has shared translation

Type: boolean

Description: The source string duplicate has shared translations from a master string.

has qa issues

Type: boolean

Description: The source string has QA issues.

has empty translation qa issues

Type: boolean

Description: The source string has empty translation QA issues.

has translation length qa issues

Type: boolean

Description: The source string has translation length QA issues.

has tags mismatch qa issues

Type: boolean

Description: The source string has tags mismatch QA issues.

has spaces mismatch qa issues

Type: boolean

Description: The source string has spaces mismatch QA issues.

has variables mismatch qa issues

Type: boolean

Description: The source string has variables mismatch QA issues.

has punctuation mismatch qa issues

Type: boolean

Description: The source string has punctuation mismatch QA issues.

has character case mismatch qa issues

Type: boolean

Description: The source string has character case mismatch QA issues.

has special characters mismatch qa issues

Type: boolean

Description: The source string has special characters mismatch QA issues.

has incorrect translation qa issues

Type: boolean

Description: The source string has incorrect translation QA issues.

has spelling qa issues

Type: boolean

Description: The source string has spelling QA issues.

has icu syntax qa issues

Type: boolean

Description: The source string has ICU syntax QA issues.

has terms qa issues

Type: boolean

Description: The source string has terms QA issues.

has duplicate translation qa issues

Type: boolean

Description: The source string has duplicate translation QA issues.

has ftl syntax qa issues

Type: boolean

Description: The source string has FTL syntax QA issues.

has android syntax qa issues

Type: boolean

Description: The source string has Android syntax QA issues.

has custom qa issues

Type: boolean

Description: The source string has Custom QA issues.

rating

Type: integer

Description: The source string translation rating.

approvalsCount

Type: integer

Description: The number of translation approvals.

labels

Type: array

Description: The source string labels.

id

Type: integer

Description: Numeric identifier of the label.

title

Type: string

Description: Label title.

is system

Type: boolean

Description: System label (label with source file name that is automatically added to strings in string-based projects).

added

Type: datetime

Beskrivelse: Dato for, hvornår en kildestreng blev tilføjet.

updated

Type: datetime

Beskrivelse: Dato for, hvornår en kildestreng blev opdateret.

Translation Context

{
  "text": "Швидкий старт",
  "plural form": "none",
  "is pre translated": true,
  "provider": "tm",
  "user": 1,
  "votes": [
    {
      "is up": true,
      "is down": false,
      "user": 2,
      "added": "2021-04-09 13:44:14"
    }
  ],
  "approvals": [
    {
      "user": 2,
      "added": "2021-04-09 13:44:14"
    }
  ],
  "updated": "2021-04-09 10:23:17"
}
text

Type: boolean

Beskrivelse: Oversættelsestekst.

plural form

Type: string

Beskrivelse: Oversættelse i flertalsform.

is pre translated

Type: boolean

Description: Translation added via pre-translation.

provider

Type: string

Allowed values: tm, global_tm, google, google_automl, microsoft, crowdin, deepl, modernmt, amazon, watson, custom_mt

Description: Translation provided via translation memory or machine translation engine.

user

Type: integer

Description: Numeric identifier of the user who added a translation.

votes

Type: array

Beskrivelse: Rækken af stemmerne tilføjet oversættelsen.

is up

Type: boolean

Beskrivelse: Upvote.

is down

Type: boolean

Beskrivelse: Downvote.

user

Type: integer

Description: Numeric identifier of the user who added a vote for translation.

added

Type: datetime

Beskrivelse: Dato for, hvornår der blev stemt på en oversættelse.

approvals

Type: array

Beskrivelse: Rækken af de tilføjede oversættelsesgodkendelser.

user

Type: integer

Description: Numeric identifier of the user who approved a translation.

added

Type: datetime

Beskrivelse: Dato for, hvornår en oversættelse blev godkendt.

updated

Type: datetime

Beskrivelse: Dato for, hvornår en oversættelse blev opdateret.

Translation Memory (TM) Segment Context

{
  "records": [
    {
      "id": 1,
      "text": "Перекладений текст",
      "usageCount": 77,
      "createdBy": 1,
      "updatedBy": 1,
      "createdAt": "2027-09-16T13:48:04+00:00",
      "updatedAt": "2027-09-16T13:48:04+00:00"
    }
  ]
}
records

Type: array

Description: Array of translation memory segment records.

id

Type: integer

Description: Numeric identifier of a record.

text

Type: string

Description: Translation text of a record.

usageCount

Type: integer

Description: The number of times a translation memory record has been used.

createdBy

Type: integer

Description: Numeric identifier of the user who created a translation memory record.

updatedBy

Type: integer

Description: Numeric identifier of the user who updated a translation memory record.

createdAt

Type: datetime

Description: Date when a translation memory record was created.

updatedAt

Type: datetime

Description: Date when a translation memory record was updated.

Var denne artikel nyttig?