Use this method to create an Excel report from segments.
(POST) /api/resources/segments/reports
The message body contains a JSON object.
reportid | The report to create. To get all available reports, see resources/segments/reports/items Examples:
Reports starting with an underscore (_) are pre-configured by Wordbee and cannot be customized. All other reports are fully customizable in the Business Report pages. | Mandatory, string | |
sloc | The source locale. A report is always for a source - target language couple. | Mandatory, string | |
tloc | The target locale. | Mandatory, string | |
scope | The scope of segments such as Project, Job, DocumentSet, etc. See Scope (Object). Example:
| Mandatory, object | |
query | An optional query object. To filter the segments of the scope. Example for drilling down on a single document:
Important:
| Optional, object |
This API method executes asynchronously.
{ "trm": { "requestid": 559, "status": "Finished", ... }, "custom": { "filetoken": "026171df25c641d0b04316a28cf3cca1", "filename": "report-16/12/2019-18:06.xlsx" } } |
When the operation has terminated, download the JSON report with the filetoken and this API method:
(GET) /api/media/get/{filetoken} |
N/A