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

# Get product completeness score

> Returns the per-field completeness breakdown that powers the brand dashboard's data-quality widget. The same scoring formula drives the ``avg_completeness`` and ``complete_products`` counters on the stats endpoint, so callers can mix this and ``GET /stats/{organization_id}`` without normalizing. Caller must be a member of ``organization_id``; the product must be owned by that organization or a 404 is returned.



## OpenAPI

````yaml /openapi/openapi-dashboard.json get /dashboard/api/v1/trade-items/{organization_id}/{gtin}/completeness
openapi: 3.1.0
info:
  title: Brand Dashboard API (Internal)
  version: 1.0.0
  description: >
    Internal endpoints powering the brand dashboard UI. Not intended for
    external integrations — use the Products, Brands, and other public APIs
    instead.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /dashboard/api/v1/trade-items/{organization_id}/{gtin}/completeness:
    get:
      tags:
        - Completeness
      summary: Get product completeness score
      description: >-
        Returns the per-field completeness breakdown that powers the brand
        dashboard's data-quality widget. The same scoring formula drives the
        ``avg_completeness`` and ``complete_products`` counters on the stats
        endpoint, so callers can mix this and ``GET /stats/{organization_id}``
        without normalizing. Caller must be a member of ``organization_id``; the
        product must be owned by that organization or a 404 is returned.
      operationId: apps_dashboard_api_completeness_product_completeness
      parameters:
        - in: path
          name: organization_id
          schema:
            description: UUID of the organization that owns the product.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: UUID of the organization that owns the product.
        - in: path
          name: gtin
          schema:
            description: >-
              GTIN-8/12/13/14 of the product. Normalized to GTIN-14 by
              zero-padding before lookup.
            pattern: ^\d{8,14}$
            title: Gtin
            type: string
          required: true
          description: >-
            GTIN-8/12/13/14 of the product. Normalized to GTIN-14 by
            zero-padding before lookup.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompletenessOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - SessionAuth: []
components:
  schemas:
    CompletenessOut:
      description: Field-by-field completeness breakdown for a single product.
      examples:
        - fields:
            brand:
              score: 1
              weight: 0.05
            category:
              score: 1
              weight: 0.05
            certifications:
              score: 0
              weight: 0.1
            country:
              score: 1
              weight: 0.05
            description:
              score: 0.6
              weight: 0.1
            images:
              score: 0.66
              weight: 0.2
            name:
              score: 1
              weight: 0.15
            nutrition:
              score: 1
              weight: 0.15
            offers:
              score: 1
              weight: 0.15
          percentage: 78
      properties:
        percentage:
          description: >-
            Overall completeness percentage 0-100, rounded. Computed as
            ``sum(fields[k].score * fields[k].weight) * 100``.
          examples:
            - 78
          maximum: 100
          minimum: 0
          title: Percentage
          type: integer
        fields:
          additionalProperties:
            $ref: '#/components/schemas/FieldScore'
          description: >-
            Per-field score and weight, keyed by field group (``name``,
            ``description``, ``brand``, ``category``, ``images``, ``nutrition``,
            ``certifications``, ``offers``, ``country``). Stable keys safe for
            UI mapping.
          title: Fields
          type: object
      required:
        - percentage
        - fields
      title: CompletenessOut
      type: object
    FieldScore:
      description: Per-field contribution to a product's completeness percentage.
      examples:
        - score: 0.85
          weight: 1
      properties:
        score:
          description: >-
            Normalized fill score for this field, 0.0 (missing) to 1.0 (fully
            populated). Some fields use partial credit (e.g. images scale to 1.0
            at 3+ uploads).
          examples:
            - 0.85
          maximum: 1
          minimum: 0
          title: Score
          type: number
        weight:
          description: >-
            Relative weight of this field in the overall completeness
            calculation. Weights across all fields sum to 1.0.
          examples:
            - 1
          maximum: 1
          minimum: 0
          title: Weight
          type: number
      required:
        - score
        - weight
      title: FieldScore
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    SessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````