github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/quality_performance_score/index.yaml (about)

     1  ---
     2  summary: Get Translation Quality
     3  description: Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
     4  operationId: projects/quality_performance_score
     5  tags:
     6  - Quality performance score
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  responses:
    11    '200':
    12      description: OK
    13      content:
    14        application/json:
    15          schema:
    16            "$ref": "../../schemas/quality_performance_score.yaml#/quality_performance_score"
    17      headers:
    18        X-Rate-Limit-Limit:
    19          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    20        X-Rate-Limit-Remaining:
    21          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    22        X-Rate-Limit-Reset:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    24    '400':
    25      "$ref": "../../responses.yaml#/400"
    26    '401':
    27      "$ref": "../../responses.yaml#/401"
    28    '404':
    29      "$ref": "../../responses.yaml#/404"
    30    '422':
    31      "$ref": "../../responses.yaml#/422"
    32    '429':
    33      "$ref": "../../responses.yaml#/429"
    34    '504':
    35      "$ref": "../../responses.yaml#/504"
    36  x-code-samples:
    37  - lang: Curl
    38    source: |-
    39      curl "https://api.phrase.com/v2/projects/:project_id/quality_performance_score" \
    40        -X POST \
    41        -u USERNAME_OR_ACCESS_TOKEN \
    42        -d '{"translation_ids":["translation_id_1", "translation_id_2"]}' \
    43        -H 'Content-Type: application/json'
    44  - lang: CLI v2
    45    source: |-
    46      phrase projects quality_performance_score \
    47      --project_id <project_id> \
    48      --data '{"translation_ids":["translation_id_1", "translation_id_2"]}' \
    49      --access_token <token>
    50  requestBody:
    51    required: true
    52    content:
    53      application/json:
    54        schema:
    55          type: object
    56          properties:
    57            translation_ids:
    58              description: Translation ids you want to get the quality performance score for
    59              type: array
    60              items:
    61                type: string
    62                example: translation_id_1
    63  x-cli-version: '2.20'