Repository navigation
feat(reports): update reports API to the latest docs - #423
Merged
Merged
Conversation
Fixes:
- downloadReportArchive built "reports/archives{id}" without a slash;
listReportArchives used a trailing slash
- GroupQaCheckIssues/GroupTaskUsage/GroupTranslationActivity request
classes extended the project request base and could not be passed to
generateGroupReport/generateOrganizationReport: add matching schemas
to GenerateGroupReportRequest and deprecate the old classes;
group task usage `taskType` is sent as the documented `typeTasks`
- Javadoc operation links for deleteReportSettingsTemplate and
checkReportArchiveExportStatus
New report types and fields:
- project reports: time-spent and task-usage (Enterprise)
- group/organization reports: source content updates, time spent,
pre-translate accuracy (general and by task), translator accuracy,
saving activity, translation costs by task, QA check issues,
translation activity and task usage schemas
- matchScoreCategories, skipArchiving, file/directory/branch/label
filters, taskIds, userIds, useCategoryBasedProofreadRates,
useTmEditDistance and saving activity mode on existing schemas
- settings templates: baseRates, netRateSchemes and the remaining
post-editing/hourly config options; Unit.HOURS, Currency DDK/PLN,
GroupingParameter.PROJECT
- ReportArchive status/progress; listReportArchives(userId, params)
with scopeType, scopeId, userId, taskId, name, dateFrom, dateTo
Deprecations: postEditingCategories (use matchScoreCategories),
taskId (use taskIds), excludeApprovalsForEditedTranslations,
preTranslatedStringsCategorizationAdjustment, GroupTopMembersSchema.groupBy,
ReportSettingsTemplate regularRates/RegularRate/Mode.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
andrii-bodnar
approved these changes
Oct 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of updating the SDK to the current Crowdin API docs. This PR covers the Reports API.
Fixes
downloadReportArchivebuiltreports/archives{archiveId}/…with the slash missing, so it always failed.listReportArchivesused a trailing slash (reports/archives/).GroupQaCheckIssuesGenerateReportRequest,GroupTaskUsageGenerateReportRequestandGroupTranslationActivityGenerateReportRequestextended the project request base. They could not be passed togenerateGroupReportorgenerateOrganizationReport.GenerateGroupReportRequest, and the old classes are deprecated.taskTypeis now sent as the documentedtypeTasks.deleteReportSettingsTemplateandcheckReportArchiveExportStatusnow link the right operations.New report types
TimeSpentGenerateReportRequest(time-spent).TaskUsageGenerateReportRequest(task-usage, Enterprise), with workload, created-vs-resolved, performance, time and cost variants.GenerateGroupReportRequest:New fields
matchScoreCategories,skipArchiving.taskIds,userIds.useCategoryBasedProofreadRates,useTmEditDistance.mode.baseRates,netRateSchemes,calculateInternalMatches,includePreTranslatedStrings,useCategoryBasedProofreadRates,useTmEditDistance.Unit.HOURS,Currency.DDK/PLN,GroupingParameter.PROJECT.ReportArchive.status/progress.listReportArchives(userId, ListReportArchivesParams)withscopeType,scopeId,userId,taskId,name,dateFrom,dateTo.Deprecated (still working)
postEditingCategories: usematchScoreCategories.taskIdin the costs by-task schemas: usetaskIds.excludeApprovalsForEditedTranslationsandpreTranslatedStringsCategorizationAdjustment: deprecated in the API.GroupTopMembersSchema.groupBy: not part of the API.ReportSettingsTemplate.Config.regularRates,RegularRateandMode: usebaseRates/netRateSchemes.Backward compatibility
GroupTaskUsageGenerateReportRequest.Schema.setTaskType(x)now sends"typeTasks"instead of"taskType".switchstatements overUnit,CurrencyandGroupingParameterwill see new values.Open questions for review
Both questions were resolved after merge in #425:
MatchType:Matchnow keeps the rawmatchTypestring (matchTypeValue), so any documented range (100-82,100-74, …) is sent and read without loss. The enum accessors are unchanged.postEditingCategoriesin the new group accuracy schemas;excludeApprovalsForEditedTranslations/preTranslatedStringsCategorizationAdjustmentin the group costs by-task schema andReportSettingsTemplate.Config) were removed. They were never part of a release.Testing
./gradlew build: 661 tests, 0 failures, on both JDK 17 and JDK 8../gradlew javadocon JDK 8: no errors.typeTasksrequest JSON;ReportArchivefields.🤖 Generated with Claude Code