Module `crowdin_api.api_resources.reports.resource`

Classes

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

Ancestors

BaseResource

Subclasses

EnterpriseReportsResource
ReportsResource
UserReportSettingsTemplatesResource

Methods

def add_report_settings_template(self, name: str, currency: Currency, unit: Unit, config: Config, isPublic: Optional[bool] = None, projectId: Optional[int] = None): Add Report Settings Templates.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.post
def delete_report_settings_template(self, reportSettingsTemplateId: int, projectId: Optional[int] = None): Delete Report Settings Templates.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.settings-templates.delete
def edit_report_settings_template(self, reportSettingsTemplateId: int, data: Iterable[ReportSettingsTemplatesPatchRequest], projectId: Optional[int] = None): Edit Report Settings Templates.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.patch
def get_report_settings_template(self, reportSettingsTemplateId: int, projectId: Optional[int] = None): Get Report Settings Templates.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.get
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): List Report Settings Templates.

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

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

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

Ancestors

BaseResource

Methods

def check_report_generation_status(self, reportId: str, projectId: Optional[int] = None): Check Report Generation Status.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.get
def download_report(self, reportId: str, projectId: Optional[int] = None): Download Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.download.download
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): Generate Report(Contribution Raw Data).

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

Link to documentation for enterprise: https://developer.crowdin.com/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): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/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): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
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): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/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): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
def generate_report(self, request_data: Dict[~KT, ~VT], projectId: Optional[int] = None): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.download.download
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_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): Generate Report(Top Members).

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
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): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/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): Generate Report.

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

Link to documentation for enterprise: https://developer.crowdin.com/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://developer.crowdin.com/enterprise/api/v2/#tag/Reports

Ancestors

BaseReportsResource
BaseReportSettingsTemplatesResource
BaseResource

Static methods

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

Methods

def check_report_archive_export_status(self, archiveId: int, exportId: str): Check Report Archive Status

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.get
def delete_report_archive(self, archiveId: int): Delete Report Archive

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.delete
def download_report_archive(self, archiveId: int, exportId: str): Download Report Archive

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.download.get
def export_report_archive(self, archiveId: int, format: Optional[ExportFormat] = None): Export Report Archive

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.post
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://developer.crowdin.com/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://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
def generate_group_report(self, group_id: int, request_data: Dict[~KT, ~VT]): Generate Group Report.

Link to documentation for enterprise: https://developer.crowdin.com/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): Generate Group Report (General).

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.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): Generate Organization Report (General).

Link to documentation: https://developer.crowdin.com/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://developer.crowdin.com/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): Generate Report(Translation Cost).

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
def get_report_archive(self, archiveId: int): Get Report Archive

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.get
def get_report_archive_export_path(self, archiveId: int, exportId: Optional[str] = None)
def get_report_archive_path(self, archiveId: Optional[int] = None)
def list_report_archives(self, scopeType: Optional[ScopeType] = None, scopeId: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None): List Report Archives

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

Inherited members

BaseReportsResource:
BaseReportSettingsTemplatesResource:

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.

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

Ancestors

BaseReportsResource
BaseReportSettingsTemplatesResource
BaseResource

Methods

def check_report_archive_export_status(self, userId: int, archiveId: int, exportId: str): Check Report Archive Status

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.get
def delete_report_archive(self, userId: int, archiveId: int): Delete Report Archive

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.delete
def download_report_archive(self, userId: int, archiveId: int, exportId: str): Download Report Archive

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.download.get
def export_report_archive(self, userId: int, archiveId: int, format: Optional[ExportFormat] = None): Export Report Archive

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.reports.archives.exports.post
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://developer.crowdin.com/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://developer.crowdin.com/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://developer.crowdin.com/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://developer.crowdin.com/api/v2/#operation/api.projects.reports.post
def get_report_archive(self, userId: int, archiveId: int): Get Report Archive

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.get
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): List Report Archives

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.reports.archives.getMany

Inherited members

BaseReportsResource:
BaseReportSettingsTemplatesResource:

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. Link to documentation: https://developer.crowdin.com/api/v2/#tag/User-Report-Settings-Templates

Ancestors

BaseReportSettingsTemplatesResource
BaseResource

Methods

def add_user_report_settings_template(self, userId: int, name: str, currency: Currency, unit: Unit, config: Config): Add User Report Settings Template.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.settings-templates.post
def delete_user_report_settings_template(self, userId: int, reportSettingsTemplateId: int): Delete User Report Settings Template.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.settings-templates.delete
def edit_user_report_settings_template(self, userId: int, reportSettingsTemplateId: int, data: Iterable[ReportSettingsTemplatesPatchRequest]): Edit User Report Settings Template.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.settings-templates.patch
def get_user_report_settings_template(self, userId: int, reportSettingsTemplateId: int): Get User Report Settings Template.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.users.reports.settings-templates.get
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): List User Report Settings Templates.

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

Inherited members

BaseReportSettingsTemplatesResource: