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
- download() : DownloadFile|null
- Download Report
- generate() : Report|null
- Generate Report
- get() : Report|null
- Check Report Generation Status
Methods
download()
Download Report
public
download(int $projectId, string $reportId) : DownloadFile|null
Parameters
- $projectId : int
- $reportId : string
Tags
Return values
DownloadFile|nullgenerate()
Generate Report
public
generate(int $projectId, array<string|int, mixed> $data) : Report|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[name]
array $data[schema]
Tags
Return values
Report|nullget()
Check Report Generation Status
public
get(int $projectId, string $reportId) : Report|null
Parameters
- $projectId : int
- $reportId : string