Export Costs Estimation Report

Generate Costs Estimation report to have an insight on how to plan the budget. This report allows you to calculate the approximate translation cost of currently untranslated strings in the project.

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}/reports/costs-estimation/export?key={project-key}
POST https://api.crowdin.com/api/project/{project-identifier}/reports/costs-estimation/export?login={username}&account-key={account-key}

Parameters

Name Value Description
unit optional string Defines the report unit. Acceptable values are: 'strings', 'words' (by default), 'chars', 'chars_with_spaces'.
mode optional string Defines the report mode. Acceptable values are: 'simple' (by default), 'fuzzy'.
calculate_internal_fuzzy_matches optional bool Available for fuzzy mode only. It counts all the internal matches, to check how many strings can be added to TM and used if the strings are translated one by one as listed. Keep in mind that calculations are approximate because strings might be translated in a different order. Acceptable values are: 1 or 0.
language required string The language for which the report should be generated. For this use Сrowdin language codes.
date_from optional date Strings added from. Use the following ISO 8601 date format: YYYY-MM-DD±hh:mm
date_to optional date Strings added to. Use the following ISO 8601 date format: YYYY-MM-DD±hh:mm
regular_rates optional array Defines the regular rates for the specified categories.
Possible categories for a report in the simple mode are: 'default', 'tm', and 'approval'.
Possible categories for a report in the fuzzy mode are: 'aproval', 'translation', 'perfect', 'matched', and three customized ranges between 60% and 100% (for example: 99-90).
individual_rates optional array Defines individual rates for the specified languages in the specified categories. Each item must contain the language and the rate parameters. The possible rate categories are the same as for the 'regular_rates' parameter.
currency optional string Defines the currency for which the whole report is generated. Acceptable values are: '$' (by default), '€', '¥', '£', 'A$', 'C$', 'Fr', 'CN¥', 'kr', 'NZ$', 'MX$', 'S$', 'HK$', 'kr', '₩', '₺', '₽', '₹', 'R$', 'R'.
format optional string Defines the export file format. Acceptable values are 'csv' and 'xlsx' (by default).
json optional string May contain no value. Defines that the response should be in a JSON format.
jsonp optional string Callback function name. Defines that the response should be in a 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 the method is successful it responds with an XML structure, as it is shown below. 
<?xml version="1.0" encoding="ISO-8859-1"?>
<success>
  <hash>x1ff24323a2f6058382b31fbc237bcd74</hash>
</success>
Unsuccessful response sample: 
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Examples

  curl \
    -F "unit=chars" \
    -F "mode=simple" \
    -F "format=csv" \
    -F "language=uk" \
    -F "date_from=2017-01-01" \
    -F "date_to=2017-01-03" \
    -F "regular_rates[default]=1.05" \
    -F "regular_rates[tm]=1.00" \
    -F "regular_rates[approval]=2.00" \
    https://api.crowdin.com/api/project/{project-identifier}/reports/costs-estimation/export?key={project-key}
  
  curl \
    -F "unit=words" \
    -F "mode=fuzzy" \
    -F "format=xlsx" \
    -F "language=uk" \
    -F "date_from=2017-06-05+0200" \
    -F "regular_rates[translation]=2.05" \
    -F "regular_rates[perfect]=1.00" \
    -F "regular_rates[matched]=1.00" \
    -F "regular_rates[99-95]=1.03" \
    -F "regular_rates[94-90]=1.05" \
    -F "regular_rates[89-80]=1.20" \
    -F "regular_rates[approval]=3.00" \
    https://api.crowdin.com/api/project/{project-identifier}/reports/costs-estimation/export?key={project-key}
  
<?php
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/reports/costs-estimation/export?mode=words&key={project-key}&language=uk';

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

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

echo $result;

Was this article helpful?