Manual
CLI
API
Log in Get started free

Project status

Returns how complete each language is on a branch.

Returns how complete each language is on a branch.

HTTP
GET /projects/{projectId}/status

Access: Session token, or an API key with the projects:read scope.

Role: Any role in the project.

Path parameters #

ParameterDescription
projectIdThe id of the project.

Query parameters #

ParameterRequiredDescription
branchnoThe branch name. Unknown or missing names fall back to the protected branch.

Response 200 #

The status.

JSON
{
  "branch": "main",
  "keys": 318,
  "languages": [
    { "code": "de-de", "status": "active", "translated": 120, "percent": 37 },
    { "code": "fr-fr", "status": "inactive", "translated": 0, "percent": 0 }
  ]
}

Response fields #

FieldTypeDescription
branchstringThe branch that was read.
keysintegerKeys with a source text.
languages[].codestringThe language code.
languages[].statusstringactive, review or inactive.
languages[].translatedintegerPublished translations.
languages[].percentintegerPercent translated, rounded down. 100 when there are no keys.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
404not_foundThe project does not exist in your organisation, you have no access to it, or projectId is not a UUID.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.