Reports

Generate Report

Required scopes: project.report (Read only).

post/projects/{projectId}/reports

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "name": "pre-translate-accuracy",
  "schema": {
    "unit": "words",
    "languageId": "ach",
    "dateFrom": "2025-09-23T07:00:14+00:00",
    "dateTo": "2025-09-27T07:00:14+00:00",
    "postEditingCategories": [
      "0-10"
    ],
    "matchScoreCategories": [
      "100-90"
    ],
    "fileIds": [
      138
    ],
    "directoryIds": [
      11
    ],
    "branchIds": [
      18
    ],
    "labelIds": [
      13
    ],
    "labelIncludeType": "strings_without_label"
  }
}

Response

Report generation was successfully started

Example response

{
  "data": {
    "identifier": "50fb3506-4127-4ba8-8296-f97dc7e3e0c3",
    "status": "finished",
    "progress": 100,
    "attributes": {
      "format": "xlsx",
      "reportName": "costs-estimation"
    },
    "createdAt": "2019-09-23T11:26:54+00:00",
    "updatedAt": "2019-09-23T11:26:54+00:00",
    "startedAt": "2019-09-23T11:26:54+00:00",
    "finishedAt": "2019-09-23T11:26:54+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.