Statistics

TagmeClientAdvanced.export_org_stats(from_date: Tuple[int, int, int] | str, to_date: Tuple[int, int, int] | str, types: List[ExportTypes | str] = None, file_format: ExportFormat = ExportFormat.CSV, organization_id: str | None = None, hourly: bool | None = None, ) → Tuple[List[TasksStatistic], List[MarkersStatistic]]

Export organization statistics to file.

Parameters

* from_date – start of statistics period.

* to_date – end of statistics period.

* types – types of data to export (MARKERS or TASKS).

* file_format – file format to export. Defaults to CSV.

* organization_id – optional organization identifier. Defaults to None.

* hourly – if True, export hourly statistics. By default, exports daily statistics.

Returns

list of organization statistics items.

TagmeClientAdvanced.export_project_stats(project_id: str, from_date: Tuple[int, int, int] | str, to_date: Tuple[int, int, int] | str, types: List[ExportTypes | str] = None, file_format: ExportFormat = ExportFormat.CSV, organization_id: str | None = None, ) → Tuple[List[TasksStatistic], List[MarkersStatistic]]

Export project statistics to file.

Parameters

* project_id – id of project to export.

* from_date – start of statistics period.

* to_date – end of statistics period.

* types – types of data to export (MARKERS or TASKS).

* file_format – file format to export. Defaults to CSV.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of project statistics items.

TagmeClientAdvanced.get_list_tasks_statistics(task_ids: List[str], update_date_from: str | None = None, organization_id: str | None = None, ) → List[TaskStatisticsItem]

Get statistics for selected tasks.

Parameters

* task_ids – task ids to get statistics for.

* update_date_from – filter by update date, return tasks whose statistics changed on or after that day

* organization_id – optional organization identifier. Defaults to None.

Returns

task statistics.

TagmeClientAdvanced.get_marker_project_stats(project_id: str, from_date: Tuple[int, int, int] | str, to_date: Tuple[int, int, int] | str, types: Iterable[str] = ('markers',), stats_format: str = 'csv', organization_id: str | None = None, ) → AsyncGenerator[Tuple[str, TextIOWrapper], None]

Get statistics for marker in project.

Parameters

* project_id – project id.

* from_date – minimal date of statistics collection.

* to_date – maximal date of statistics collection.

* types – type of statistics (‘markers’, ‘tasks’).

* stats_format – format of statistics (‘csv’ or ‘xlsx’). Defaults to ‘csv’.

* organization_id – optional organization identifier. Defaults to None.

Returns

marker statistics.

TagmeClientAdvanced.get_marker_stats(date_from: str, date_to: str, types: Iterable[str] = ('markers',), stats_format: str = 'csv', organization_id: str | None = None, ) → AsyncGenerator[Tuple[str, TextIOWrapper], None]

Get statistics for marker in organization.

Parameters

* date_from – minimal date of statistics collection.

* date_to – maximal date of statistics collection.

* types – type of statistics (‘markers’, ‘tasks’).

* stats_format – format of statistics (‘csv’ or ‘xlsx’). Defaults to ‘csv’.

* organization_id – optional organization identifier. Defaults to None.

Returns

marker statistics.

TagmeClientAdvanced.get_markup_marker_statistics(page: int | None = None, size: int | None = None, query: str | None = None, start_date: date | None = None, end_date: date | None = None, sort_field: MarkupMarkerStatisticsSortField | None = None, sort_order: SortOrder | None = None, ) → MarkupMarkerStatistics

Get marker statistics.

Parameters

* page – optional page number for pagination.

* size – optional page size for pagination.

* query – filter by project name.

* start_date – filter by statistics start date.

* end_date – filter by statistics end date.

* sort_field – field to sort results by.

* sort_order – sort order (‘asc’, ‘desc’).

Returns

marker statistics.

TagmeClientAdvanced.get_project_stats(project_id: str, organization_id: str | None = None, ) → ProjectStatistic

Get project statistics.

Parameters

* project_id – project id.

* organization_id – optional organization identifier. Defaults to None.

Returns

project statistics.

TagmeClientAdvanced.get_quality_stats(organization_id: str, output: StatsOutputType, task_ids: Tuple[str] | None = None, project_ids: Tuple[str] | None = None, ) → List[TaskQuality | List[ItemQuality]]

Get quality statistics for tasks.

Parameters

* organization_id – optional organization identifier. Defaults to None.

* output – type of statistics returned (TASK or ITEM).

* task_ids – optional task identifiers. Defaults to None.

* project_ids – optional project identifiers. Defaults to None.

Returns

list of quality statistics items. If output is TASK, returns list of TaskQuality. If output is ITEM, returns list of ItemQuality.

TagmeClientAdvanced.get_task_stats(task_id: str, organization_id: str | None = None, ) → TaskStats

Get statistics for task.

Parameters

* task_id – task id to get statistics for.

* organization_id – optional organization identifier. Defaults to None.

Returns

task statistics.

TagmeClientAdvanced.get_task_stats_advanced(task_id: str, organization_id: str | None = None, ) → TaskStatsAdvanced

Get estimation date and number of assignments in progress for task.

Parameters

* task_id – task id to get statistics for.

* organization_id – optional organization identifier. Defaults to None.

Returns

task statistics.