This endpoint displays the translation progress for a project via its custom ID, with an option to check progress for specific tasks using a task ID. For detailed instructions on getting translation progress by custom IDs, refer to the Translation Progress guide.
Note
For detailed instructions on making requests and viewing responses directly on the platform, including sample responses, please refer to the 'Step-by-Step Guide to Making Requests Directly on the Platform' section in the Quick Start Guide.
Instructions
Ensure that your request includes the necessary headers. To test the functionality of your request with specific path and query parameters, proceed as follows:
- 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 configure the path and query parameters:
- Locate the input field designated for the
{customId}parameter in the "PATH PARAMS" section, found under the "Response Payload" section. Enter your desired value for{customId}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 start your 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 | The total count of tasks or languages. |
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. |