Reported Issues

Get a list of issues reported in the Editor.

Request

POST https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-key}

Parameters

Name Value Description
type optional string Defines the issue type.
Acceptable values are:
  • "general_question" — general question
  • "translation_mistake" — current translation is wrong
  • "context_request" — lack of contextual information
  • "source_mistake" — mistake in the source string
  • "all" — all the issue types listed above (default value)
status optional string Defines the issue resolution status.
Acceptable values are:
  • "unresolved" — unresolved issues
  • "resolved" — resolved issues
  • "all" — all the issue resolution statuses listed above (default value)
file optional string Defines the path of the file issues are associated with.
If the file path is not specified the method will get issues associated with all the project files.
language optional string Defines the language issues are associated with. If the language is not specified the method will get issues associated with all the project languages.
Crowdin language codes.
date_from optional string Issues added from. Use the following ISO 8601 format: YYYY-MM-DD±hh:mm
date_to optional string Issues added to. Use the following ISO 8601 format: YYYY-MM-DD±hh:mm
json optional string May contain no value. Defines that the response should be in JSON.
jsonp optional string Callback function name. Defines that the response should be in JSONP.
Variables
project-identifier required string Should contain the project identifier.
project-key required string Project API key.

Response

If the method is successful it returns an XML structure, as it's shown below:
<?xml version="1.0" encoding="ISO-8859-1"?>
<issues>
    <issue>
        <source_string>Project name</source_string>
        <context>Headline 3 XPath: /html/body/div/div/h3</context>
        <comment>Source string mistake</comment>
        <created>2017-12-18T14:19:05+0000</created>
        <type>source_mistake</type>
        <status>unresolved</status>
        <file>/crowdin_sample_webpage.html</file>
        <language>
            <name>French</name>
            <code>fr</code>
        </language>
        <string_url>https://crowdin.com/translate/project-issues/3624/en-uk#14342648</string_url>
        <user>John Doe</user>
    </issue>
    <issue>
        <source_string>Current Password</source_string>
        <context>current_password</context>
        <comment>wrong translation</comment>
        <created>2017-12-18T14:18:29+0000</created>
        <type>translation_mistake</type>
        <status>unresolved</status>
        <file>/crowdin_sample_android.xml</file>
        <language>
            <name>French</name>
            <code>fr</code>
        </language>
        <string_url>https://crowdin.com/translate/project-issues/3625/en-uk#14342682</string_url>
        <user>John Doe</user>
    </issue>
    <issue>
        <source_string>Quick Start</source_string>
        <context>quick_start</context>
        <comment>Need more context</comment>
        <created>2017-12-18T14:18:01+0000</created>
        <type>context_request</type>
        <status>unresolved</status>
        <file>/crowdin_sample_android.xml</file>
        <language>
            <name>French</name>
            <code>fr</code>
        </language>
        <string_url>https://crowdin.com/translate/project-issues/3625/en-uk#14342693</string_url>
        <user>John Doe</user>
    </issue>
</issues>
Unsuccessful response example:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
    <code>1</code>
    <message>The requested project does not exist or the API key is not valid.</message>
</error>

Examples

  curl \
    -F "type=general_question" \
    -F "status=unresolved" \
    -F "date_from=2017-01-01" \
    https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-key}';
$post_params['type'] = 'general_question';
$post_params['status'] = 'unresolved';
$post_params['date_from'] = '2017-01-01';

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

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

echo $result;

Was this article helpful?