Skip to content
SnugnutdocsContactPublic preview

I18n

GET/api/v1/i18n/projects

List_projects

GET
/api/v1/i18n/projects

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Query Parameters

filter?

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

q?string

Full-text search over this list's searchable fields.

Length1 <= length <= 200
sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: name, active_version, updated_at, created_at. Default: -created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100
cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value
total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

application/json

curl -X GET "https://example.com/api/v1/i18n/projects"
{  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "projects": [    {      "active_version": 0,      "approval_required": true,      "base_locale": "string",      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "fallback_policy": {        "default_chain": [          "string"        ],        "locale_overrides": {          "property1": [            "string"          ],          "property2": [            "string"          ]        },        "mode": "recursive"      },      "name": "string",      "project_id": "string",      "translator_roles": [        "string"      ],      "updated_at": "2019-08-24T14:15:22Z"    }  ]}
POST/api/v1/i18n/projects

Create_project

POST
/api/v1/i18n/projects

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects" \  -H "Content-Type: application/json" \  -d '{    "base_locale": "string",    "name": "string"  }'
{  "active_version": 0,  "approval_required": true,  "base_locale": "string",  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "fallback_policy": {    "default_chain": [      "string"    ],    "locale_overrides": {      "property1": [        "string"      ],      "property2": [        "string"      ]    },    "mode": "recursive"  },  "name": "string",  "project_id": "string",  "translator_roles": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z"}
GET/api/v1/i18n/projects/{project_id}

Get_project

GET
/api/v1/i18n/projects/{project_id}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Response Body

application/json

curl -X GET "https://example.com/api/v1/i18n/projects/string"
{  "active_version": 0,  "approval_required": true,  "base_locale": "string",  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "fallback_policy": {    "default_chain": [      "string"    ],    "locale_overrides": {      "property1": [        "string"      ],      "property2": [        "string"      ]    },    "mode": "recursive"  },  "name": "string",  "project_id": "string",  "translator_roles": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z"}
POST/api/v1/i18n/projects/{project_id}/experiments

Create_experiment

POST
/api/v1/i18n/projects/{project_id}/experiments

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/experiments" \  -H "Content-Type: application/json" \  -d '{    "experiment_id": "string",    "key": "string",    "variants": [      {        "experiment_id": "string",        "value": "string",        "variant": "string",        "weight": 0      }    ]  }'
{  "experiment_id": "string",  "key": "string",  "record_id": "string",  "variant_count": 0}
GET/api/v1/i18n/projects/{project_id}/locales

List_locales

GET
/api/v1/i18n/projects/{project_id}/locales

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Query Parameters

filter?

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: created_at, updated_at. Default: -updated_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100
cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value
total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

application/json

curl -X GET "https://example.com/api/v1/i18n/projects/string/locales"
{  "locales": [    {      "active_version": 0,      "coverage": {        "fallback_hits_24h": 0,        "missing_keys": 0,        "translated_keys": 0      },      "display_name": "string",      "fallback_chain": [        "string"      ],      "locale": "string",      "locale_id": "string",      "plural_rules": "string",      "project_id": "string",      "status": "draft",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "project_id": "string"}
POST/api/v1/i18n/projects/{project_id}/locales

Create_locale

POST
/api/v1/i18n/projects/{project_id}/locales

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/locales" \  -H "Content-Type: application/json" \  -d '{    "display_name": "string",    "locale": "string"  }'
{  "active_version": 0,  "coverage": {    "fallback_hits_24h": 0,    "missing_keys": 0,    "translated_keys": 0  },  "display_name": "string",  "fallback_chain": [    "string"  ],  "locale": "string",  "locale_id": "string",  "plural_rules": "string",  "project_id": "string",  "status": "draft",  "updated_at": "2019-08-24T14:15:22Z"}
GET/api/v1/i18n/projects/{project_id}/locales/{locale}/bundle

Get_bundle

GET
/api/v1/i18n/projects/{project_id}/locales/{locale}/bundle

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string
locale*string

Query Parameters

include_fallback?boolean

Include fallback-resolved values for missing keys

Response Body

application/json

curl -X GET "https://example.com/api/v1/i18n/projects/string/locales/string/bundle"
{  "etag": "string",  "locale": "string",  "project_id": "string",  "published_at": "2019-08-24T14:15:22Z",  "strings": {    "property1": "string",    "property2": "string"  },  "version": 0}
POST/api/v1/i18n/projects/{project_id}/publish

Publish

POST
/api/v1/i18n/projects/{project_id}/publish

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/publish" \  -H "Content-Type: application/json" \  -d '{}'
{  "active_version": 0,  "project_id": "string",  "published_locales": [    {      "key_count": 0,      "locale": "string",      "version": 0    }  ]}
GET/api/v1/i18n/projects/{project_id}/report/missing

Missing_report

GET
/api/v1/i18n/projects/{project_id}/report/missing

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Query Parameters

locale?string

Filter by locale

namespace?string

Filter by namespace

caller?string

Filter by caller

Response Body

application/json

curl -X GET "https://example.com/api/v1/i18n/projects/string/report/missing"
{  "events": [    {      "caller": "string",      "count": 0,      "fallback_used": "string",      "first_seen_at": "2019-08-24T14:15:22Z",      "key": "string",      "last_seen_at": "2019-08-24T14:15:22Z",      "locale": "string",      "namespace": "string"    }  ],  "project_id": "string"}
GET/api/v1/i18n/projects/{project_id}/resolve

Resolve

GET
/api/v1/i18n/projects/{project_id}/resolve

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Query Parameters

locale*string

Locale to resolve for

key*string

Translation key to resolve

count?integer

Optional plural count for pluralized keys

Formatint64
var?array<string>

Variable values as repeated name:value pairs

context?array<string>

Context selectors as repeated name:value pairs

subject_id?string

Subject id used for deterministic A/B bucketing

Response Body

application/json

curl -X GET "https://example.com/api/v1/i18n/projects/string/resolve?locale=string&key=string"
{  "resolved": {    "experiment_id": "string",    "fallback_path": [      "string"    ],    "key": "string",    "rich_text_markdown": true,    "source_locale": "string",    "tone": null,    "value": "string",    "variant": "string",    "version": 0  }}
POST/api/v1/i18n/projects/{project_id}/resolve-batch

Resolve_batch

POST
/api/v1/i18n/projects/{project_id}/resolve-batch

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/resolve-batch" \  -H "Content-Type: application/json" \  -d '{    "keys": [      "string"    ],    "locale": "string"  }'
{  "missing": [    "string"  ],  "resolved": [    {      "experiment_id": "string",      "fallback_path": [        "string"      ],      "key": "string",      "rich_text_markdown": true,      "source_locale": "string",      "tone": null,      "value": "string",      "variant": "string",      "version": 0    }  ]}
POST/api/v1/i18n/projects/{project_id}/rollback

Rollback

POST
/api/v1/i18n/projects/{project_id}/rollback

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/rollback" \  -H "Content-Type: application/json" \  -d '{    "locale": "string",    "version": 0  }'
{  "locale": "string",  "project_id": "string",  "restored_version": 0}
POST/api/v1/i18n/projects/{project_id}/telemetry/missing

Record_missing

POST
/api/v1/i18n/projects/{project_id}/telemetry/missing

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/telemetry/missing" \  -H "Content-Type: application/json" \  -d '{    "caller": "string",    "key": "string",    "locale": "string"  }'
{  "count": 0,  "key": "string",  "locale": "string"}
POST/api/v1/i18n/projects/{project_id}/translations/approve

Approve_translations

POST
/api/v1/i18n/projects/{project_id}/translations/approve

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/translations/approve" \  -H "Content-Type: application/json" \  -d '{    "locale": "string"  }'
{  "approved": 0,  "locale": "string",  "project_id": "string"}
POST/api/v1/i18n/projects/{project_id}/translations/upload

Upload_translations

POST
/api/v1/i18n/projects/{project_id}/translations/upload

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/i18n/projects/string/translations/upload" \  -H "Content-Type: application/json" \  -d '{    "locale": "string",    "strings": {      "property1": {},      "property2": {}    }  }'
{  "created": 0,  "locale": "string",  "project_id": "string",  "updated": 0,  "upload_id": "string",  "validation_errors": [    {      "key": "string",      "message": "string"    }  ]}

Human approval

Human escalation and approval workflows

Inbox

Persistent user notifications with read state and actions

On this page

List_projectsCreate_projectGet_projectCreate_experimentList_localesCreate_localeGet_bundlePublishMissing_reportResolveResolve_batchRollbackRecord_missingApprove_translationsUpload_translations