Reports

Generate Group Report

Required scopes: group (Read only).

post/groups/{groupId}/reports

Request

Path parameters

groupIdinteger required

Group Identifier. Get via List Groups

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "name": "group-translation-costs-pe",
  "schema": {
    "projectIds": [
      13
    ],
    "unit": "words",
    "currency": "USD",
    "baseRates": {
      "fullTranslation": 0.1,
      "proofread": 0.12
    },
    "individualRates": [
      {
        "languageIds": [
          "uk"
        ],
        "userIds": [
          1
        ],
        "fullTranslation": 0.1,
        "proofread": 0.12
      }
    ],
    "netRateSchemes": {
      "tmMatch": [
        {
          "matchType": "perfect",
          "price": 0.1
        }
      ],
      "mtMatch": [
        {
          "matchType": "100",
          "price": 0.1
        }
      ],
      "aiMatch": [
        {
          "matchType": "100",
          "price": 0.1
        }
      ],
      "suggestionMatch": [
        {
          "matchType": "100",
          "price": 0.1
        }
      ]
    },
    "groupBy": "user",
    "dateFrom": "2019-09-23T07:00:14+00:00",
    "dateTo": "2019-09-27T07:00:14+00:00",
    "userIds": [
      13
    ]
  }
}

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.