Class 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.

Hierarchy (view full)

CrowdinApi
- Reports

Constructors

constructor

new Reports(credentials, config?): Reports
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Reports
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:224

Methods

addReportSettingsTemplate

addReportSettingsTemplate(projectId, request): Promise<ResponseObject<ReportSettings>>
Parameters
- projectId: number
  project identifier
- request: Omit<ReportSettings, "id" | "createdAt" | "updatedAt">
  request body
Returns Promise<ResponseObject<ReportSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.post
- Defined in reports/index.ts:285

checkUserReportArchiveStatus

checkUserReportArchiveStatus(userId, archiveId, exportId): Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>
Parameters
- userId: number
  user identifier
- archiveId: number
  archive identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.get
- Defined in reports/index.ts:140

deleteOrganizationReportArchive

deleteOrganizationReportArchive(archiveId): Promise<void>
Parameters
- archiveId: number
  archive identifier
Returns Promise<void>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.delete
- Defined in reports/index.ts:45

deleteReportSettingsTemplate

deleteReportSettingsTemplate(projectId, reportSettingsTemplateId): Promise<void>
Parameters
- projectId: number
  project identifier
- reportSettingsTemplateId: number
  report settings template identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.settings-templates.delete
- Defined in reports/index.ts:326

deleteUserReportArchive

deleteUserReportArchive(userId, archiveId): Promise<void>
Parameters
- userId: number
  user identifier
- archiveId: number
  archive identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.delete
- Defined in reports/index.ts:115

downloadGroupReport

downloadGroupReport(groupId, reportId): Promise<ResponseObject<DownloadLink>>
Parameters
- groupId: number
  group identifier
- reportId: string
  report identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/enterprise/api/#operation/api.groups.reports.download.download
- Defined in reports/index.ts:195

downloadOrganizationReport

downloadOrganizationReport(reportId): Promise<ResponseObject<DownloadLink>>
Parameters
- reportId: string
  report identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/enterprise/api/#operation/api.reports.download.download
- Defined in reports/index.ts:226

downloadOrganizationReportArchive

downloadOrganizationReportArchive(archiveId, exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- archiveId: number
  archive identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.download.get
- Defined in reports/index.ts:80

downloadReport

downloadReport(projectId, reportId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- reportId: string
  report identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.download.download
- Defined in reports/index.ts:262

downloadUserReportArchive

downloadUserReportArchive(userId, archiveId, exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- archiveId: number
  archive identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.download.get
- Defined in reports/index.ts:155

editReportSettingsTemplate

editReportSettingsTemplate(projectId, reportSettingsTemplateId, request): Promise<ResponseObject<ReportSettings>>
Parameters
- projectId: number
  project identifier
- reportSettingsTemplateId: number
  report settings template identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<ReportSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.patch
- Defined in reports/index.ts:312

exportOrganizationReportArchive

exportOrganizationReportArchive(archiveId, request?): Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>
Parameters
- archiveId: number
  archive identifier
- request: {
  format?: ReportsModel.Format;
  } = {}
  - Optionalformat?: ReportsModel.Format
Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.post
- Defined in reports/index.ts:54

exportUserReportArchive

exportUserReportArchive(userId, archiveId, request?): Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>
Parameters
- userId: number
  user identifier
- archiveId: number
  archive identifier
- request: {
  format?: ReportsModel.Format;
  } = {}
  - Optionalformat?: ReportsModel.Format
Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.reports.archives.exports.post
- Defined in reports/index.ts:125

generateGroupReport

generateGroupReport(groupId, request): Promise<ResponseObject<Status<ReportStatusAttributes<GroupReportSchema>>>>
Parameters
- groupId: number
  group identifier
- request: GenerateGroupReportRequest
  request body
Returns Promise<ResponseObject<Status<ReportStatusAttributes<GroupReportSchema>>>>
See
https://support.crowdin.com/enterprise/api/#operation/api.groups.reports.post
- Defined in reports/index.ts:169

generateOrganizationReport

generateOrganizationReport(request): Promise<ResponseObject<Status<ReportStatusAttributes<OrganizationReportSchema>>>>
Parameters
- request: GenerateOrganizationReportRequest
  request body
Returns Promise<ResponseObject<Status<ReportStatusAttributes<OrganizationReportSchema>>>>
See
https://support.crowdin.com/enterprise/api/#operation/api.reports.post
- Defined in reports/index.ts:204

generateReport

generateReport(projectId, request): Promise<ResponseObject<Status<ReportStatusAttributes<ReportSchema>>>>
Parameters
- projectId: number
  project identifier
- request: GenerateReportRequest
  request body
Returns Promise<ResponseObject<Status<ReportStatusAttributes<ReportSchema>>>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.post
- Defined in reports/index.ts:236

getOrganizationReportArchive

getOrganizationReportArchive(archiveId): Promise<ResponseObject<ReportArchive>>
Parameters
- archiveId: number
  archive identifier
Returns Promise<ResponseObject<ReportArchive>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.get
- Defined in reports/index.ts:36

getReportSettingsTemplate

getReportSettingsTemplate(projectId, reportSettingsTemplateId): Promise<ResponseObject<ReportSettings>>
Parameters
- projectId: number
  project identifier
- reportSettingsTemplateId: number
  report settings template identifier
Returns Promise<ResponseObject<ReportSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.get
- Defined in reports/index.ts:298

getUserReportArchive

getUserReportArchive(userId, archiveId): Promise<ResponseObject<ReportArchive>>
Parameters
- userId: number
  user identifier
- archiveId: number
  archive identifier
Returns Promise<ResponseObject<ReportArchive>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.get
- Defined in reports/index.ts:105

graphql

graphql<T>(req): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:258

listOrganizationReportArchives

listOrganizationReportArchives(options?): Promise<ResponseList<ReportArchive>>
Parameters
- Optionaloptions: ListReportArchiveParams
  optional parameters for the request
Returns Promise<ResponseList<ReportArchive>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.getMany
- Defined in reports/index.ts:23

listReportSettingsTemplates

listReportSettingsTemplates(projectId, options?): Promise<ResponseList<ReportSettings>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<ReportSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.getMany
- Defined in reports/index.ts:272

listUserReportArchives

listUserReportArchives(userId, options?): Promise<ResponseList<ReportArchive>>
Parameters
- userId: number
  user identifier
- Optionaloptions: ListReportArchiveParams
  optional parameters for the request
Returns Promise<ResponseList<ReportArchive>>
See
https://developer.crowdin.com/api/v2/#operation/api.reports.archives.getMany
- Defined in reports/index.ts:90

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:313

Class Reports

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Reports

Methods

addReportSettingsTemplate

Parameters

Returns Promise<ResponseObject<ReportSettings>>

See

checkGroupReportStatus

Parameters

Returns Promise<ResponseObject<Status<ReportStatusAttributes<GroupReportSchema>>>>

See

checkOrganizationReportArchiveStatus

Parameters

Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>

See

checkOrganizationReportStatus

Parameters

Returns Promise<ResponseObject<Status<ReportStatusAttributes<OrganizationReportSchema>>>>

See

checkReportStatus

Parameters

Returns Promise<ResponseObject<Status<ReportStatusAttributes<ReportSchema>>>>

See

checkUserReportArchiveStatus

Parameters

Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>

See

deleteOrganizationReportArchive

Parameters

Returns Promise<void>

See

deleteReportSettingsTemplate

Parameters

Returns Promise<void>

See

deleteUserReportArchive

Parameters

Returns Promise<void>

See

downloadGroupReport

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadOrganizationReport

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadOrganizationReportArchive

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadReport

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadUserReportArchive

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editReportSettingsTemplate

Parameters

Returns Promise<ResponseObject<ReportSettings>>

See

exportOrganizationReportArchive

Parameters

Optionalformat?: ReportsModel.Format

Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>

See

exportUserReportArchive

Parameters

Optionalformat?: ReportsModel.Format

Returns Promise<ResponseObject<Status<ReportArchiveStatusAttribute>>>

See

`Optional`format?: ReportsModel.Format

`Optional`format?: ReportsModel.Format

`Optional`operationName?: string

`Optional`variables?: any