Skip to main content

Export data

GET 
/v2/projects/:projectId/export

Export data

Request​

Path Parameters

    projectId int64required

Query Parameters

    languages string[]

    Languages to be contained in export.

    If null, all languages are exported

    Example: en
    format string

    Possible values: [JSON, JSON_TOLGEE, XLIFF, PO, APPLE_STRINGS_STRINGSDICT, APPLE_XLIFF, ANDROID_XML, FLUTTER_ARB, PROPERTIES, YAML_RUBY, YAML]

    Format to export to

    structureDelimiter string

    Delimiter to structure file content.

    e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure.

    When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), specific formats like YAML_RUBY don't honor this parameter.

    filterKeyId int64[]

    Filter key IDs to be contained in export

    filterKeyIdNot int64[]

    Filter key IDs not to be contained in export

    filterTag string

    Filter keys tagged by

    filterKeyPrefix string

    Filter keys with prefix

    filterState string[]

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

    Filter translations with state. By default, all states except untranslated is exported.

    filterNamespace string[]

    Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string.

    zip boolean

    If false, it doesn't return zip of files, but it returns single file.

    This is possible only when single language is exported. Otherwise it returns "400 - Bad Request" response.

    messageFormat string

    Possible values: [C_SPRINTF, PHP_SPRINTF, JAVA_STRING_FORMAT, APPLE_SPRINTF, RUBY_SPRINTF, ICU]

    Message format to be used for export.

    e.g. PHP_PO: Hello %s, ICU: Hello {name}.

    This property is honored only for generic formats like JSON or YAML. For specific formats like YAML_RUBY it's ignored.

    supportArrays boolean

    If true, for structured formats (like JSON) arrays are supported.

    e.g. Key hello[0] will be exported as {"hello": ["..."]}

Responses​

OK

Schema

    object

Loading...