get https://api.textunited.com/segments/projects//progress
This endpoint shows the translation progress for a project, identified by its TextUnited ID, and offers an option to view progress by specific tasks. For a comprehensive guide on tracking translation progress, including how to interpret the data returned, see the Translation Progress guide.
Instructions
Ensure that your request includes the necessary headers. To test the request directly on the platform:
- Navigate to the HEADERS section below the Response Payload section.
- Enter the "Content-Type" header with the value "application/json".
- Include your "Authorization" token using either Basic Auth or JWT Access Token. For detailed instructions on obtaining these tokens, refer to the documentation on Obtaining your API key and company ID and Obtaining your JWT token.
- To test the functionality of your request with specific path and query parameters:
- Locate the input field designated for the
{id}parameter in the "PATH PARAMS" section, which is found under the "Response Payload" section. Enter your desired value for{id}in this input field.- Specify the
taskIdin the corresponding input field located in the "QUERY PARAMS" section.- Execute the test directly on the platform by clicking the "Try It!" button at the top-right of your screen to initiate the request and view your response.
Sample Response
To see a sample response, click the "EXAMPLES" dropdown at the top-right of your screen.
Response Payload
The following fields are returned after a successful request:
| Field | Type | Description |
|---|---|---|
total | Number | Represents overall progress at each level (project, task, language), indicating completion status. |
tasks.taskId | String | A unique identifier for the task. |
tasks.total | Number | The total count of items (e.g., words) processed in the task. |
tasks.targetLanguages.languageId | Number | A unique identifier for the language. |
tasks.targetLanguages.languageCode | String | The ISO 639-3 code for the language. |
tasks.targetLanguages.progress | Number | The percentage of items processed in the task. |
languages.languageId | Number | A unique identifier for the language. |
languages.languageCode | String | The ISO 639-3 code for the language. |
languages.progress | Number | The percentage of items processed in the language. |