> ## Documentation Index
> Fetch the complete documentation index at: https://developers.phrase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get analytics

> Returns aggregated evaluation analytics for the specified date range and optional Quality Profile filter.



## OpenAPI

````yaml /openapi/phrase-quality-evaluator.json get /v1/analytics
openapi: 3.1.2
info:
  title: Quality Evaluator API
  description: >
    The Quality Evaluator API enables you to evaluate the quality of translated
    segments using AI-powered checks.

    Create custom AI Checks with specific quality requirements, organize them
    into Quality Profiles, and run

    evaluations to identify translation issues automatically.
  version: 1.0.0
  termsOfService: https://phrase.com/terms/
  contact:
    name: Phrase Support
    url: https://support.phrase.com
servers:
  - url: https://eu.phrase.com/quality-evaluator
    description: Production EU
  - url: https://us.phrase.com/quality-evaluator
    description: Production US
security:
  - bearerAuth: []
tags:
  - name: AI Checks
    description: Create and manage AI Checks with custom quality requirements.
  - name: Analytics
    description: Retrieve aggregated evaluation analytics.
  - name: Evaluation
    description: Evaluate translation quality using AI Checks.
  - name: Quality Profiles
    description: Organize AI Checks into reusable Quality Profiles.
paths:
  /v1/analytics:
    get:
      tags:
        - Analytics
      summary: Get analytics
      description: >-
        Returns aggregated evaluation analytics for the specified date range and
        optional Quality Profile filter.
      operationId: getAnalytics
      parameters:
        - name: qualityProfileUid
          in: query
          description: Filter analytics by Quality Profile UID.
          schema:
            type: string
        - name: dayAfter
          in: query
          description: Start of the date range, inclusive (UTC).
          schema:
            type: string
            format: date
        - name: dayBefore
          in: query
          description: End of the date range, inclusive (UTC).
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Analytics data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsListResponse'
              example:
                items:
                  - qualityProfileUid: 6804b1c2d3e4f5a6b7c80123
                    day: '2024-03-20T00:00:00Z'
                    sumProcessed: 1250
                    sumLocked: 980
                    sumAiuConsumed: 3750
                  - qualityProfileUid: 6804b1c2d3e4f5a6b7c80123
                    day: '2024-03-19T00:00:00Z'
                    sumProcessed: 890
                    sumLocked: 710
                    sumAiuConsumed: 2670
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    AnalyticsListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AnalyticsResponse'
      required:
        - items
    AnalyticsResponse:
      type: object
      properties:
        qualityProfileUid:
          type: string
          example: 6804b1c2d3e4f5a6b7c80123
        day:
          type: string
          format: date-time
          example: '2024-03-20T00:00:00Z'
        sumProcessed:
          type: integer
          format: int64
          description: Total segments processed.
          example: 1250
        sumLocked:
          type: integer
          format: int64
          description: Total segments locked.
          example: 980
        sumAiuConsumed:
          type: integer
          format: int64
          description: Total AI units consumed.
          example: 3750
      required:
        - day
        - sumProcessed
        - sumLocked
        - sumAiuConsumed
    ProblemDetail:
      type: object
      description: Error response following RFC 9457.
      properties:
        type:
          type: string
          description: A URI reference identifying the problem type.
          example: urn:problem-type:unauthorized
        title:
          type: string
          description: A short, human-readable summary of the problem.
          example: Unauthorized
        status:
          type: integer
          description: The HTTP status code.
          example: 401
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence.
          example: Valid credentials were not supplied
        instance:
          type: string
          description: A URI reference identifying the specific occurrence.
  responses:
    UnauthorizedResponse:
      description: Authentication failed or credentials not provided.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: urn:problem-type:unauthorized
            title: Unauthorized
            status: 401
            detail: Valid credentials were not supplied
    ForbiddenResponse:
      description: >-
        Insufficient permissions. This operation requires the ADMIN or OWNER IDM
        role.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: urn:problem-type:forbidden
            title: Forbidden
            status: 403
            detail: Insufficient permissions to perform this action
    ErrorResponse:
      description: An error occurred.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use a Bearer token obtained from Phrase Platform authentication. See the
        Authentication guide for details on how to obtain a token.

````