GET /v1/translation-analytics/games/{gameId}/download-translation-analytics-report — openapi

Download translation analytics report after the report is ready

Endpoint

Method: GET

Path: /v1/translation-analytics/games/{gameId}/download-translation-analytics-report

Servers:

https://gameinternationalization.roblox.com

Parameters

Name	Location	Required	Description
gameId	path	true	The game's id
startDateTime	query	true	The inclusive start dateTime of report in UTC
endDateTime	query	true	The exclusive end dateTime of report in UTC
reportType	query	true	The report type
reportSubjectTargetId	query	true	The translator group id

[
  {
    "in": "path",
    "name": "gameId",
    "description": "The game's id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "startDateTime",
    "description": "The inclusive start dateTime of report in UTC",
    "required": true,
    "schema": {
      "type": "string",
      "format": "date-time"
    }
  },
  {
    "in": "query",
    "name": "endDateTime",
    "description": "The exclusive end dateTime of report in UTC",
    "required": true,
    "schema": {
      "type": "string",
      "format": "date-time"
    }
  },
  {
    "in": "query",
    "name": "reportType",
    "description": "The report type",
    "required": true,
    "schema": {
      "type": "string",
      "enum": [
        "GameTranslationStatus",
        "GameTranslationStatusForTranslator",
        "GameTranslationStatusForTranslatorGroup",
        "Test"
      ]
    }
  },
  {
    "in": "query",
    "name": "reportSubjectTargetId",
    "description": "The translator group id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

Status	Description
200	OK
400	14: Invalid game id 56: You need to provide a valid translator group id to get report. 58: Start datetime or end datetime is invlaid. 59: Report type is invalid
401	0: Authorization has been denied for this request.
403	57: You do not have permission to request translation analytics report.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "type": "object"
        }
      },
      "text/json": {
        "schema": {
          "type": "object"
        }
      }
    }
  },
  "400": {
    "description": "14: Invalid game id\r\n56: You need to provide a valid translator group id to get report.\r\n58: Start datetime or end datetime is invlaid.\r\n59: Report type is invalid"
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "57: You do not have permission to request translation analytics report."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Localization",
    "Universes"
  ],
  "summary": "Download translation analytics report after the report is ready",
  "parameters": [
    {
      "in": "path",
      "name": "gameId",
      "description": "The game's id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "startDateTime",
      "description": "The inclusive start dateTime of report in UTC",
      "required": true,
      "schema": {
        "type": "string",
        "format": "date-time"
      }
    },
    {
      "in": "query",
      "name": "endDateTime",
      "description": "The exclusive end dateTime of report in UTC",
      "required": true,
      "schema": {
        "type": "string",
        "format": "date-time"
      }
    },
    {
      "in": "query",
      "name": "reportType",
      "description": "The report type",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "GameTranslationStatus",
          "GameTranslationStatusForTranslator",
          "GameTranslationStatusForTranslatorGroup",
          "Test"
        ]
      }
    },
    {
      "in": "query",
      "name": "reportSubjectTargetId",
      "description": "The translator group id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object"
          }
        },
        "text/json": {
          "schema": {
            "type": "object"
          }
        }
      }
    },
    "400": {
      "description": "14: Invalid game id\r\n56: You need to provide a valid translator group id to get report.\r\n58: Start datetime or end datetime is invlaid.\r\n59: Report type is invalid"
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "57: You do not have permission to request translation analytics report."
    }
  },
  "servers": [
    {
      "url": "https://gameinternationalization.roblox.com"
    }
  ],
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/localization#gameinternationalization_get_v1_translation_analytics_games__gameId__download_translation_analytics_report"
  }
}