Documentation

ReportApi extends AbstractApi
in package

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.

Table of Contents

Methods

createReportSettingsTemplate()  : ReportSettingsTemplate|null
Add Report Settings Template
deleteReportSettingsTemplate()  : void
Delete Report Settings Template
download()  : DownloadFile|null
Download Report
generate()  : Report|null
Generate Report
get()  : Report|null
Check Report Generation Status
getReportSettingsTemplate()  : ReportSettingsTemplate|null
Get Report Settings Template
listReportSettingsTemplates()  : ModelCollection
List Report Settings Templates
updateReportSettingsTemplate()  : ReportSettingsTemplate|null
Edit Report Settings Template

Methods

createReportSettingsTemplate()

Add Report Settings Template

public createReportSettingsTemplate(int $projectId, array<string|int, mixed> $data) : ReportSettingsTemplate|null
Parameters
$projectId : int
$data : array<string|int, mixed>

string $data[name] required
string $data[currency] required
string $data[unit] required. Enum: "strings" "words" "chars" "chars_with_spaces"
array $data[config] required
boolean $data[isPublic]
boolean $data[isGlobal]

Tags
link

API Documentation
Return values
ReportSettingsTemplate|null

deleteReportSettingsTemplate()

Delete Report Settings Template

public deleteReportSettingsTemplate(int $projectId, int $reportSettingsTemplateId) : void
Parameters
$projectId : int
$reportSettingsTemplateId : int
Tags
link

API Documentation
On this page

Search results