For Project Managers

For Translators

For Developers

API Methods

Company

Translation Status

Track overall translation and proofreading progresses of each target language. Default response format is XML.

Request

Note: Either use the combination of project identifier and project key or combination of project identifier, username, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{project-identifier}/status?key={project-key}
POST https://api.crowdin.com/api/project/{project-identifier}/status?login={username}&account-key={account-key}

Parameters

Name Value Description
languages optional array Track overall translation and proofreading progresses for defined target languages. For this use Сrowdin language codes.
xml optional string May contain no value. Defines that response should be in XML format.
json optional string May contain no value. Defines that response should be in JSON format.
jsonp optional string Callback function name. Defines that response should be in JSONP format.
Variables
project-identifier string Project identifier.
project-key string Project API key. Either the project-key or combination of login and account-key are required.
login string Your username in Crowdin. Either the project-key or combination of login and account-key are required.
account-key string Your account API key. Either the project-key or combination of login and account-key are required.

Response

If successful, this method returns a XML structure, as it is shown below. 
<?xml version="1.0" encoding="UTF-8"?>
<status>
  <language>
    <name>French</name>
    <code>fr</code>
    <phrases>20</phrases>
    <translated>10</translated>
    <approved>5</approved>
    <words>50</words>
    <words_translated>35</words_translated>
    <words_approved>15</words_approved>
    <translated_progress>50</translated_progress>
    <approved_progress>25</approved_progress>
  </language>
  <language>
    <name>Romanian</name>
    <code>ro</code>
    <phrases>20</phrases>
    <translated>0</translated>
    <approved>0</approved>
    <words>50</words>
    <words_translated>35</words_translated>
    <words_approved>15</words_approved>
    <translated_progress>0</translated_progress>
    <approved_progress>0</approved_progress>
  </language>
  <!-- ............each project language............-->
</status>
If QA checks is enabled, this method returns the following XML structure: 
<?xml version="1.0" encoding="UTF-8"?>
<status>
  <language>
    <name>French</name>
    <code>fr</code>
    <phrases>20</phrases>
    <translated>10</translated>
    <approved>5</approved>
    <words>50</words>
    <words_translated>35</words_translated>
    <words_approved>15</words_approved>
    <translated_progress>50</translated_progress>
    <approved_progress>25</approved_progress>
    <qa_issues>10</qa_issues>
  </language>
  <!-- ............each project language............-->
</status>
Unsuccessful response sample: 
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Examples

curl https://api.crowdin.com/api/project/{project-identifier}/status?key={project-key}&jsonp=mycallback
<?php
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/status?key={project-key}&xml';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Was this article helpful?