Skip to main content

Get translations in project

GET 
/v2/projects/:projectId/translations

Get translations in project

Request​

Path Parameters

    projectId int64required

Query Parameters

    cursor string

    Cursor to get next data

    filterState string[]

    Translation state in the format: languageTag,state. You can use this parameter multiple times.

    When used with multiple states for same language it is applied with logical OR.

    When used with multiple languages, it is applied with logical AND.

    languages string[]

    Languages to be contained in response.

    To add multiple languages, repeat this param (eg. ?languages=en&languages=de)

    Example: en
    search string

    String to search in key name or translation text

    filterKeyName string[]

    Selects key with provided names. Use this param multiple times to fetch more keys.

    filterKeyId int64[]

    Selects key with provided ID. Use this param multiple times to fetch more keys.

    filterUntranslatedAny boolean

    Selects only keys for which the translation is missing in any returned language. It only filters for translations included in returned languages.

    filterTranslatedAny boolean

    Selects only keys, where translation is provided in any language

    filterUntranslatedInLang string

    Selects only keys where the translation is missing for the specified language. The specified language must be included in the returned languages. Otherwise, this filter doesn't apply.

    Example: en-US
    filterTranslatedInLang string

    Selects only keys, where translation is provided in specified language

    Example: en-US
    filterHasScreenshot boolean

    Selects only keys with screenshots

    filterHasNoScreenshot boolean

    Selects only keys without screenshots

    filterNamespace string[]

    Filter namespaces.

    To filter default namespace, set to empty string.

    filterTag string[]

    Selects only keys with provided tag

    filterOutdatedLanguage string[]

    Selects only keys, where translation in provided langs is in outdated state

    Example: en-US
    filterNotOutdatedLanguage string[]

    Selects only keys, where translation in provided langs is not in outdated state

    Example: en-US
    page integer

    Default value: 0

    Zero-based page index (0..N)

    size integer

    Possible values: >= 1

    Default value: 20

    The size of the page to be returned

    sort string[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses​

OK

Schema
    _embedded object
    keys object[]
  • Array [
    • keyId int64required

    Id of key record

    keyName stringrequired

    Name of key

    keyIsPlural booleanrequired

    Is this key a plural?

    keyPluralArgName string

    The placeholder name for plural parameter

    keyNamespaceId int64

    The namespace id of the key

    keyNamespace string

    The namespace of the key

    keyDescription string

    The namespace of the key

    keyTags object[]required

    Tags of key

  • Array [
    • id int64required
    name stringrequired
  • ]
    • screenshotCount int64required

    Count of screenshots provided for the key

    screenshots object[]

    Key screenshots. Not provided when API key hasn't screenshots.view scope permission.

  • Array [
    • id int64required
    filename stringrequired

    File name, which may be downloaded from the screenshot path.

    When images are secured. Encrypted timestamp is appended to the filename.

    thumbnail stringrequired

    Thumbnail file name, which may be downloaded from the screenshot path.

    When images are secured. Encrypted timestamp is appended to the filename.

    fileUrl stringrequired
    thumbnailUrl stringrequired
    createdAt date-time
    keyReferences object[]required
  • Array [
    • keyId int64required
    position object
    x int32required
    y int32required
    width int32required
    height int32required
    keyName stringrequired
    keyNamespace string
    originalText string
  • ]
    • location string
    width int32
    height int32
  • ]
    • contextPresent booleanrequired

    There is a context available for this key

    translations objectrequired

    Translations object

    property name* TranslationViewModel

    Translations object

    id int64required

    Id of translation record

    text string

    Translation text

    state stringrequired

    Possible values: [UNTRANSLATED, TRANSLATED, REVIEWED, DISABLED]

    State of translation

    outdated booleanrequired

    Whether base language translation was changed after this translation was updated

    auto booleanrequired

    Was translated using Translation Memory or Machine translation service?

    mtProvider string

    Possible values: [GOOGLE, AWS, DEEPL, AZURE, BAIDU, TOLGEE]

    Which machine translation service was used to auto translate this

    commentCount int64required

    Count of translation comments

    unresolvedCommentCount int64required

    Count of unresolved translation comments

    fromTranslationMemory booleanrequired

    Was translation memory used to translate this?

  • ]
    • page object
    size int64
    totalElements int64
    totalPages int64
    number int64
    selectedLanguages object[]required

    Provided languages data

  • Array [
    • id int64required
    name stringrequired

    Language name in english

    tag stringrequired

    Language tag according to BCP 47 definition

    originalName string

    Language name in this language

    flagEmoji string

    Language flag emoji as UTF-8 emoji

    base booleanrequired

    Whether is base language of project

  • ]
    • nextCursor string

    Cursor to get next data

Loading...