Module crowdin_api.api_resources.reports.resource

Classes

class BaseReportSettingsTemplatesResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Ancestors

Subclasses

Methods

def add_report_settings_template(self, name: str, currency: Currency, unit: Unit, config: Union[PostEditingConfig, HourlyConfig, Config], isPublic: Optional[bool] = None, projectId: Optional[int] = None, isGlobal: Optional[bool] = None)
def delete_report_settings_template(self, reportSettingsTemplateId: int, projectId: Optional[int] = None)
def edit_report_settings_template(self, reportSettingsTemplateId: int, data: Iterable[ReportSettingsTemplatesPatchRequest], projectId: Optional[int] = None)
def get_report_settings_template(self, reportSettingsTemplateId: int, projectId: Optional[int] = None)
def get_report_settings_templates_path(self, projectId: int, reportSettingsTemplateId: Optional[int] = None)
def list_report_settings_template(self, projectId: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)
class BaseReportsResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Ancestors

Subclasses

Methods

def check_report_generation_status(self, reportId: str, projectId: Optional[int] = None)
def download_report(self, reportId: str, projectId: Optional[int] = None)
def generate_contribution_raw_data_by_task_report(self, mode: ContributionMode, task_id: int, project_id: Optional[int] = None, unit: Optional[Unit] = None, columns: Optional[Iterable[str]] = None, tm_ids: Optional[Iterable[int]] = None, mt_ids: Optional[Iterable[int]] = None, ai_prompt_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)
def generate_contribution_raw_data_report(self, mode: ContributionMode, projectId: Optional[int] = None, unit: Optional[Unit] = None, languageId: Optional[str] = None, userId: Optional[int] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, columns: Optional[Iterable[str]] = None, tmIds: Optional[Iterable[int]] = None, mtIds: Optional[Iterable[int]] = None, aiPromptIds: Optional[Iterable[int]] = None, fileIds: Optional[Iterable[int]] = None, directoryIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None)

Generate Report(Contribution Raw Data).

fileIds and directoryIds are available for file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_costs_estimation_post_editing_by_task_report(self, project_id: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, base_rates: Optional[BaseRates] = None, individual_rates: Optional[Iterable[IndividualRate]] = None, net_rate_schemes: Optional[NetRateSchemes] = None, calculate_internal_matches: Optional[bool] = None, include_pre_translated_strings: Optional[bool] = None, task_id: Optional[int] = None, task_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Report(Costs Estimation Post-Editing By Task).

task_id is deprecated by the API, use task_ids instead.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_costs_estimation_post_editing_general_report(self, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, project_id: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, calculate_internal_matches: Optional[bool] = None, include_pre_translated_strings: Optional[bool] = None, language_id: Optional[str] = None, file_ids: Optional[Iterable[int]] = None, directory_ids: Optional[Iterable[int]] = None, branch_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, label_ids: Optional[Iterable[int]] = None, label_include_type: Optional[ReportLabelIncludeType] = None, skip_archiving: Optional[bool] = None, workflow_step_id: Optional[int] = None)

Generate Report(Costs Estimation Post-Editing General).

workflow_step_id is available for Crowdin Enterprise only.

file_ids and directory_ids are available for file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_editor_issues_report(self, project_id: Optional[int] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, format: Optional[Format] = Format.XLSX, issue_type: Union[EditorIssueType, str, None] = None)
def generate_fuzzy_cost_estimate_report(self, projectId: Optional[int] = None, **kwargs)
def generate_fuzzy_translation_cost_report(self, projectId: Optional[int] = None, **kwargs)
def generate_pre_translate_accuracy_by_task_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, format: Optional[Format] = None, postEditingCategories: Optional[Iterable[str]] = None, taskId: Optional[int] = None, matchScoreCategories: Optional[Iterable[str]] = None, skipArchiving: Optional[bool] = None)

Generate Report(Pre-Translate Accuracy By Task).

postEditingCategories is deprecated by the API, use matchScoreCategories instead.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_pre_translate_accuracy_general_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, format: Optional[Format] = None, postEditingCategories: Optional[Iterable[str]] = None, languageId: Optional[str] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, matchScoreCategories: Optional[Iterable[str]] = None, fileIds: Optional[Iterable[int]] = None, directoryIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None, labelIds: Optional[Iterable[int]] = None, labelIncludeType: Optional[ReportLabelIncludeType] = None, skipArchiving: Optional[bool] = None)

Generate Report(Pre-Translate Accuracy General).

postEditingCategories is deprecated by the API, use matchScoreCategories instead.

fileIds and directoryIds are available for file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_project_members_report(self, project_id: Optional[int] = None, format: Optional[Format] = Format.XLSX, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)
def generate_qa_check_issues_report(self, project_id: Optional[int] = None, format: Optional[Format] = Format.XLSX, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, language_id: Optional[str] = None)
def generate_report(self, request_data: Dict[~KT, ~VT], projectId: Optional[int] = None)
def generate_saving_activity_report(self, project_id: Optional[int] = None, unit: Optional[Unit] = None, language_id: Optional[str] = None, format: Optional[Format] = Format.XLSX, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, mode: Optional[SavingActivityMode] = None, file_ids: Optional[Iterable[int]] = None, directory_ids: Optional[Iterable[int]] = None, branch_ids: Optional[Iterable[int]] = None, user_ids: Optional[Iterable[int]] = None)

Generate Report(Saving Activity).

file_ids and directory_ids are available for file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_simple_cost_estimate_report(self, projectId: Optional[int] = None, **kwargs)
def generate_simple_translation_cost_report(self, projectId: Optional[int] = None, **kwargs)
def generate_source_content_updates_report(self, project_id: Optional[int] = None, unit: Optional[Unit] = None, format: Optional[Format] = Format.XLSX, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)
def generate_time_spent_report(self, project_id: Optional[int] = None, format: Optional[Format] = None, group_by: Optional[GroupBy] = None, base_rates: Optional[HourlyBaseRates] = None, individual_rates: Optional[Iterable[HourlyIndividualRate]] = None, language_id: Optional[str] = None, user_ids: Optional[Iterable[int]] = None, type_tasks: Optional[TaskType] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, task_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None, workflow_step_id: Optional[int] = None)

Generate Report(Time Spent).

workflow_step_id is available for Crowdin Enterprise only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_top_members_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, languageId: Optional[str] = None, format: Optional[Format] = Format.XLSX, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None, userIds: Optional[Iterable[int]] = None)
def generate_translation_activity_report(self, project_id: Optional[int] = None, unit: Optional[Unit] = None, language_id: Optional[str] = None, format: Optional[Format] = Format.XLSX, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None)
def generate_translation_costs_post_editing_by_task_report(self, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, project_id: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, task_id: Optional[int] = None, task_ids: Optional[Iterable[int]] = None, use_category_based_proofread_rates: Optional[bool] = None, use_tm_edit_distance: Optional[bool] = None, skip_archiving: Optional[bool] = None)

Generate Report(Translation Costs Post-Editing By Task).

task_id is deprecated by the API, use task_ids instead.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_translation_costs_post_editing_general_report(self, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, project_id: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, group_by: Optional[GroupBy] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, language_id: Optional[str] = None, user_ids: Optional[Iterable[int]] = None, file_ids: Optional[Iterable[int]] = None, directory_ids: Optional[Iterable[int]] = None, branch_ids: Optional[Iterable[int]] = None, use_category_based_proofread_rates: Optional[bool] = None, use_tm_edit_distance: Optional[bool] = None, label_ids: Optional[Iterable[int]] = None, label_include_type: Optional[ReportLabelIncludeType] = None, skip_archiving: Optional[bool] = None, workflow_step_id: Optional[int] = None)

Generate Report(Translation Costs Post-Editing General).

workflow_step_id is available for Crowdin Enterprise only.

file_ids and directory_ids are available for file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_translator_accuracy_report(self, project_id: Optional[int] = None, unit: Optional[Unit] = None, format: Optional[Format] = None, match_score_categories: Optional[Iterable[str]] = None, language_id: Optional[str] = None, user_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, file_ids: Optional[Iterable[int]] = None, directory_ids: Optional[Iterable[int]] = None, branch_ids: Optional[Iterable[int]] = None, label_ids: Optional[Iterable[int]] = None, label_include_type: Optional[ReportLabelIncludeType] = None, skip_archiving: Optional[bool] = None)

Generate Report(Translator Accuracy).

file_ids and directory_ids are available for file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def get_reports_path(self, projectId: int, reportId: Optional[str] = None)
class EnterpriseReportsResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Enterprise Reports.

Reports help to estimate costs, calculate translation costs, and identify the top members.

Use API to generate Cost Estimate, Translation Cost, and Top Members reports. You can then export reports in .xlsx or .csv file formats. Report generation is an asynchronous operation and shall be completed with a sequence of API methods.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Reports

Ancestors

Static methods

def get_group_reports_path(group_id: int, report_id: Optional[str] = None)
def get_organization_report_settings_templates_path(reportSettingsTemplateId: Optional[int] = None)
def get_organization_reports_path(report_id: Optional[str] = None)

Methods

def add_organization_report_settings_template(self, name: str, currency: Currency, unit: Unit, config: Union[PostEditingConfig, HourlyConfig], project_id: Optional[int] = None, group_id: Optional[int] = None, is_public: Optional[bool] = None)

Add Organization Report Settings Template.

project_id and group_id can't be used together.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.settings-templates.post

def add_report_settings_template(self, name: str, currency: Currency, unit: Unit, config: Union[PostEditingConfig, HourlyConfig, Config], isPublic: Optional[bool] = None, projectId: Optional[int] = None, isGlobal: Optional[bool] = None)

Add Report Settings Templates.

Deprecated: use add_organization_report_settings_template instead.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.settings-templates.post

def check_group_report_generation_status(self, group_id: int, report_id: str)

Check Group Report Generation Status.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.get

def check_organization_report_generation_status(self, report_id: str)

Check Organization Report Generation Status.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.get

def check_report_archive_export_status(self, archiveId: int, exportId: str)
def delete_organization_report_settings_template(self, reportSettingsTemplateId: int)
def delete_report_archive(self, archiveId: int)
def delete_report_settings_template(self, reportSettingsTemplateId: int, projectId: Optional[int] = None)

Delete Report Settings Templates.

Deprecated: use delete_organization_report_settings_template instead.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.settings-templates.delete

def download_group_report(self, group_id: int, report_id: str)
def download_organization_report(self, report_id: str)
def download_report_archive(self, archiveId: int, exportId: str)
def edit_organization_report_settings_template(self, reportSettingsTemplateId: int, data: Iterable[ReportSettingsTemplatesPatchRequest])
def edit_report_settings_template(self, reportSettingsTemplateId: int, data: Iterable[ReportSettingsTemplatesPatchRequest], projectId: Optional[int] = None)

Edit Report Settings Templates.

Deprecated: use edit_organization_report_settings_template instead.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.settings-templates.patch

def export_report_archive(self, archiveId: int, format: Optional[ExportFormat] = None)
def generate_fuzzy_cost_estimate_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, languageId: Optional[str] = None, fileIds: Optional[Iterable[int]] = None, format: Optional[Format] = Format.XLSX, stepTypes: Optional[Iterable[StepTypes]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Cost Estimate Fuzzy Mode).

Links to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_fuzzy_translation_cost_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = Format.XLSX, groupBy: Optional[GroupBy] = None, stepTypes: Optional[Iterable[StepTypes]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Translation Cost Fuzzy Mode).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def generate_group_pre_translate_accuracy_by_task_report(self, group_id: int, unit: Optional[Unit] = None, format: Optional[Format] = None, match_score_categories: Optional[Iterable[str]] = None, task_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Group Report (Pre-Translate Accuracy By Task).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_pre_translate_accuracy_general_report(self, group_id: int, unit: Optional[Unit] = None, language_id: Optional[str] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, match_score_categories: Optional[Iterable[str]] = None, project_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Group Report (Pre-Translate Accuracy General).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_qa_check_issues_report(self, group_id: int, project_ids: Optional[Iterable[int]] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)

Generate Group Report (Qa Check Issues).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_report(self, group_id: int, request_data: Dict[~KT, ~VT])

Generate Group Report.

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_saving_activity_report(self, group_id: int, unit: Optional[Unit] = None, project_ids: Optional[Iterable[int]] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, language_id: Optional[str] = None, mode: Optional[SavingActivityMode] = None)

Generate Group Report (Saving Activity).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_source_content_updates_report(self, group_id: int, unit: Optional[Unit] = None, format: Optional[Format] = None, project_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)

Generate Group Report (Source Content Updates).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_task_usage_report(self, group_id: int, format: Optional[Format] = None, type: Optional[TaskUsageReportType] = None, project_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, group_by: Optional[GroupBy] = None, type_task: Optional[TaskType] = None, language_id: Optional[str] = None, creator_id: Optional[int] = None, assignee_id: Optional[int] = None, words_count_from: Optional[int] = None, words_count_to: Optional[int] = None, statuses: Optional[Iterable[TaskUsageStatus]] = None)

Generate Group Report (Task Usage).

words_count_from and words_count_to are used only with time type, statuses only with cost type. type_task is sent as typeTasks.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_time_spent_report(self, group_id: int, format: Optional[Format] = None, group_by: Optional[GroupBy] = None, base_rates: Optional[HourlyBaseRates] = None, individual_rates: Optional[Iterable[HourlyIndividualRate]] = None, language_id: Optional[str] = None, user_ids: Optional[Iterable[int]] = None, type_tasks: Optional[TaskType] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, project_ids: Optional[Iterable[int]] = None, task_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)
def generate_group_top_members_report(self, group_id: int, project_ids: Optional[Iterable[int]] = None, unit: Optional[Unit] = None, language_id: Optional[str] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None)

Generate Group Report (Top Members).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_translation_activity_report(self, group_id: int, unit: Optional[Unit] = None, project_ids: Optional[Iterable[int]] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None)

Generate Group Report (Translation Activity).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_translation_costs_post_editing_by_task_report(self, group_id: int, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, task_ids: Optional[Iterable[int]] = None, use_category_based_proofread_rates: Optional[bool] = None, use_tm_edit_distance: Optional[bool] = None, skip_archiving: Optional[bool] = None)

Generate Group Report (Translation Costs Post-Editing By Task).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_translation_costs_post_editing_general_report(self, group_id: int, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, project_ids: Optional[Iterable[int]] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, group_by: Optional[GroupBy] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None, use_category_based_proofread_rates: Optional[bool] = None, use_tm_edit_distance: Optional[bool] = None, skip_archiving: Optional[bool] = None)

Generate Group Report (Translation Costs Post-Editing General).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_group_translator_accuracy_report(self, group_id: int, unit: Optional[Unit] = None, format: Optional[Format] = None, language_id: Optional[str] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, match_score_categories: Optional[Iterable[str]] = None, user_ids: Optional[Iterable[int]] = None, project_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Group Report (Translator Accuracy).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.groups.reports.post

def generate_organization_pre_translate_accuracy_by_task_report(self, unit: Optional[Unit] = None, format: Optional[Format] = None, match_score_categories: Optional[Iterable[str]] = None, task_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Organization Report (Pre-Translate Accuracy By Task).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_pre_translate_accuracy_general_report(self, unit: Optional[Unit] = None, language_id: Optional[str] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, match_score_categories: Optional[Iterable[str]] = None, project_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Organization Report (Pre-Translate Accuracy General).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_qa_check_issues_report(self, project_ids: Optional[Iterable[int]] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)

Generate Organization Report (Qa Check Issues).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_report(self, request_data: Dict[~KT, ~VT])
def generate_organization_saving_activity_report(self, unit: Optional[Unit] = None, project_ids: Optional[Iterable[int]] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, language_id: Optional[str] = None, mode: Optional[SavingActivityMode] = None)

Generate Organization Report (Saving Activity).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_source_content_updates_report(self, unit: Optional[Unit] = None, format: Optional[Format] = None, project_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None)

Generate Organization Report (Source Content Updates).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_task_usage_report(self, format: Optional[Format] = None, type: Optional[TaskUsageReportType] = None, project_ids: Optional[Iterable[int]] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, group_by: Optional[GroupBy] = None, type_tasks: Optional[TaskType] = None, language_id: Optional[str] = None, creator_id: Optional[int] = None, assignee_id: Optional[int] = None, words_count_from: Optional[int] = None, words_count_to: Optional[int] = None, statuses: Optional[Iterable[TaskUsageStatus]] = None)

Generate Organization Report (Task Usage).

words_count_from and words_count_to are used only with time type, statuses only with cost type.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_time_spent_report(self, format: Optional[Format] = None, group_by: Optional[GroupBy] = None, base_rates: Optional[HourlyBaseRates] = None, individual_rates: Optional[Iterable[HourlyIndividualRate]] = None, language_id: Optional[str] = None, user_ids: Optional[Iterable[int]] = None, type_tasks: Optional[TaskType] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, project_ids: Optional[Iterable[int]] = None, task_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Organization Report (Time Spent).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_top_members_report(self, project_ids: Optional[Iterable[int]] = None, unit: Optional[Unit] = None, language_id: Optional[str] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None)

Generate Organization Report (Top Members).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_translation_activity_report(self, unit: Optional[Unit] = None, project_ids: Optional[Iterable[int]] = None, format: Optional[Format] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None)

Generate Organization Report (Translation Activity).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_translation_costs_post_editing_by_task_report(self, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, task_ids: Optional[Iterable[int]] = None, use_category_based_proofread_rates: Optional[bool] = None, use_tm_edit_distance: Optional[bool] = None, skip_archiving: Optional[bool] = None)

Generate Organization Report (Translation Costs Post-Editing By Task).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_translation_costs_post_editing_general_report(self, base_rates: BaseRates, individual_rates: Iterable[IndividualRate], net_rate_schemes: NetRateSchemes, project_ids: Optional[Iterable[int]] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = None, group_by: Optional[GroupBy] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, user_ids: Optional[Iterable[int]] = None, use_category_based_proofread_rates: Optional[bool] = None, use_tm_edit_distance: Optional[bool] = None, skip_archiving: Optional[bool] = None)

Generate Organization Report (Translation Costs Post-Editing General).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_organization_translator_accuracy_report(self, unit: Optional[Unit] = None, format: Optional[Format] = None, language_id: Optional[str] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, match_score_categories: Optional[Iterable[str]] = None, user_ids: Optional[Iterable[int]] = None, project_ids: Optional[Iterable[int]] = None, skip_archiving: Optional[bool] = None)

Generate Organization Report (Translator Accuracy).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.post

def generate_simple_cost_estimate_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, languageId: Optional[str] = None, fileIds: Optional[Iterable[int]] = None, format: Optional[Format] = Format.XLSX, stepTypes: Optional[Iterable[StepTypes]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Cost Estimate schema).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

def generate_simple_translation_cost_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = Format.XLSX, groupBy: Optional[GroupBy] = None, stepTypes: Optional[Iterable[StepTypes]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)
def generate_task_usage_report(self, project_id: Optional[int] = None, format: Optional[Format] = None, type: Optional[TaskUsageReportType] = None, date_from: Optional[datetime.datetime] = None, date_to: Optional[datetime.datetime] = None, group_by: Optional[GroupBy] = None, type_tasks: Optional[TaskType] = None, language_id: Optional[str] = None, creator_id: Optional[int] = None, assignee_id: Optional[int] = None, words_count_from: Optional[int] = None, words_count_to: Optional[int] = None, statuses: Optional[Iterable[TaskUsageStatus]] = None)

Generate Report(Task Usage).

words_count_from and words_count_to are used only with time type, statuses only with cost type.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.reports.post

def get_organization_report_settings_template(self, reportSettingsTemplateId: int)
def get_report_archive(self, archiveId: int)
def get_report_archive_export_path(self, archiveId: int, exportId: Optional[str] = None)
def get_report_archive_path(self, archiveId: Optional[int] = None)
def get_report_settings_template(self, reportSettingsTemplateId: int, projectId: Optional[int] = None)

Get Report Settings Templates.

Deprecated: use get_organization_report_settings_template instead.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.settings-templates.get

def list_organization_report_settings_templates(self, project_id: Optional[int] = None, group_id: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)
def list_report_archives(self, scopeType: Optional[ScopeType] = None, scopeId: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None, userId: Optional[int] = None, taskId: Optional[int] = None, name: Optional[str] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)
def list_report_settings_template(self, projectId: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Report Settings Templates.

Deprecated: use list_organization_report_settings_templates instead.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.reports.settings-templates.getMany

Inherited members

class ReportsResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Reports.

Reports help to estimate costs, calculate translation costs, and identify the top members.

Use API to generate Cost Estimate, Translation Cost, and Top Members reports. You can then export reports in .xlsx or .csv file formats. Report generation is an asynchronous operation and shall be completed with a sequence of API methods.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Reports

Ancestors

Methods

def check_report_archive_export_status(self, userId: int, archiveId: int, exportId: str)
def delete_report_archive(self, userId: int, archiveId: int)
def download_report_archive(self, userId: int, archiveId: int, exportId: str)
def export_report_archive(self, userId: int, archiveId: int, format: Optional[ExportFormat] = None)
def generate_fuzzy_cost_estimate_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, languageId: Optional[str] = None, fileIds: Optional[Iterable[int]] = None, format: Optional[Format] = Format.XLSX, calculateInternalFuzzyMatches: Optional[bool] = None, regularRates: Optional[Iterable[FuzzyRegularRate]] = None, individualRates: Optional[Iterable[FuzzyIndividualRate]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Cost Estimate Fuzzy Mode).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

def generate_fuzzy_translation_cost_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = Format.XLSX, groupBy: Optional[GroupBy] = None, regularRates: Optional[Iterable[FuzzyRegularRate]] = None, individualRates: Optional[Iterable[FuzzyIndividualRate]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Translation Fuzzy Cost).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

def generate_simple_cost_estimate_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, languageId: Optional[str] = None, fileIds: Optional[Iterable[int]] = None, format: Optional[Format] = Format.XLSX, regularRates: Optional[Iterable[SimpleRegularRate]] = None, individualRates: Optional[Iterable[SimpleIndividualRate]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Cost Estimate Schema).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

def generate_simple_translation_cost_report(self, projectId: Optional[int] = None, unit: Optional[Unit] = None, currency: Optional[Currency] = None, format: Optional[Format] = Format.XLSX, groupBy: Optional[GroupBy] = None, regularRates: Optional[Iterable[SimpleRegularRate]] = None, individualRates: Optional[Iterable[SimpleIndividualRate]] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Generate Report(Translation Cost).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.reports.post

def get_report_archive(self, userId: int, archiveId: int)
def get_report_archive_export_path(self, userId: int, archiveId: int, exportId: Optional[str] = None)
def get_report_archive_path(self, userId: int, archiveId: Optional[int] = None)
def list_report_archives(self, userId: int, scopeType: Optional[str] = None, scopeId: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None, taskId: Optional[int] = None, name: Optional[str] = None, dateFrom: Optional[datetime.datetime] = None, dateTo: Optional[datetime.datetime] = None)

Inherited members

class UserReportSettingsTemplatesResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for User Report Settings Templates API.

Supporting the endpoints for managing user report settings templates.

These methods are also available on ReportsResource and EnterpriseReportsResource (both platforms support /users/{userId}/reports/settings-templates).

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/User-Report-Settings-Templates

Ancestors

Subclasses

Methods

def add_user_report_settings_template(self, userId: int, name: str, currency: Currency, unit: Unit, config: Union[PostEditingConfig, HourlyConfig, Config])
def delete_user_report_settings_template(self, userId: int, reportSettingsTemplateId: int)
def edit_user_report_settings_template(self, userId: int, reportSettingsTemplateId: int, data: Iterable[ReportSettingsTemplatesPatchRequest])
def get_user_report_settings_template(self, userId: int, reportSettingsTemplateId: int)
def get_user_report_settings_templates_path(self, userId: int, reportSettingsTemplateId: Optional[int] = None)
def list_user_report_settings_template(self, userId: int, offset: Optional[int] = None, limit: Optional[int] = None)

Inherited members