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

Index

Constructors

constructor

Methods

addReportSettingsTemplate checkGroupReportStatus checkOrganizationReportStatus checkReportStatus deleteReportSettingsTemplate downloadGroupReport downloadOrganizationReport downloadReport editReportSettingsTemplate generateGroupReport generateOrganizationReport generateReport getReportSettingsTemplate graphql listReportSettingsTemplates withFetchAll

Constructors

constructor

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

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:140

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:181

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:50

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:81

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:117

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:167

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:24

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:59

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:91

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:153

graphql

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

listReportSettingsTemplates

listReportSettingsTemplates(projectId, options?): Promise<ResponseList<ReportSettings>>
Parameters
- projectId: number
  project identifier
- Optional options: 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:127

withFetchAll

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

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

checkOrganizationReportStatus

Parameters

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

See

checkReportStatus

Parameters

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

See

deleteReportSettingsTemplate

Parameters

Returns Promise<void>

See

downloadGroupReport

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadOrganizationReport

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadReport

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editReportSettingsTemplate

Parameters

Returns Promise<ResponseObject<ReportSettings>>

See

generateGroupReport

Parameters

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

See

generateOrganizationReport

Parameters

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

See

generateReport

Parameters

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

See

getReportSettingsTemplate

Parameters

Returns Promise<ResponseObject<ReportSettings>>

See

graphql

Type Parameters

Parameters

Optional operationName?: string

query: string

Optional variables?: any

Returns Promise<ResponseObject<T>>

listReportSettingsTemplates

Parameters

Returns Promise<ResponseList<ReportSettings>>

See

withFetchAll

Parameters

Returns this

Settings

Member Visibility

Theme

On This Page

`Optional` operationName?: string

`Optional` variables?: any