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

# Shop performance score

> Returns TikTok's Shop Performance Score (SPS) overview: the overall `score`, `tier`, `peerPercentile`, per-dimension scores and statuses in `dimensions`, the seller `benefits` and which ones the shop has earned, and the `topIssues` to fix with TikTok's `topIssuesSummary` (null when absent).

TikTok serves SPS for US shops only. Pass `locale` (for example `en-US`) to localize names and text; TikTok picks a default otherwise. Use Performance score metrics to drill into individual metrics.



## OpenAPI

````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/shop_health
openapi: 3.0.3
info:
  title: 'Growi API: TikTok Shop'
  version: 1.0.0
  description: >-
    Generated by scripts/gen_tik_tok_shop.rb from Growi's TikTok Shop route
    table.
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /tik_tok_shop/shop_health:
    get:
      summary: Shop performance score
      description: >-
        Returns TikTok's Shop Performance Score (SPS) overview: the overall
        `score`, `tier`, `peerPercentile`, per-dimension scores and statuses in
        `dimensions`, the seller `benefits` and which ones the shop has earned,
        and the `topIssues` to fix with TikTok's `topIssuesSummary` (null when
        absent).


        TikTok serves SPS for US shops only. Pass `locale` (for example `en-US`)
        to localize names and text; TikTok picks a default otherwise. Use
        Performance score metrics to drill into individual metrics.
      parameters:
        - name: locale
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$
            example: en-US
          description: >-
            Passed to TikTok to localize names and texts. Absent = TikTok picks
            the default.
        - name: organization_id
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Use the TikTok Shop of this child brand (organization id) of your
            API key's organization
      responses:
        '200':
          description: >-
            SPS overview: { score, tier, peerPercentile, dimensions, benefits,
            topIssues, topIssuesSummary }
          content:
            application/json:
              example:
                score: '4.4'
                tier: Good
                peerPercentile: '82'
                dimensions:
                  - name: Product satisfaction
                    score: '4.4'
                    status: GOOD
                    status_text: Good
                    weight: '30'
                benefits:
                  - benefit_name: Flash Deal
                    is_unlocked: true
                    unlock_score: '2.5'
                topIssues: []
                topIssuesSummary: null
        '400':
          description: 'Invalid params: locale'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record you asked for doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '422':
          description: >-
            No TikTok Shop is connected for this organization. A parent
            organization whose shops sit on its child brands has to pass
            `organization_id`. Also returned when the shop isn't connected
            through TikTok's official API (`code: unsupported_on_web_only_shop`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '429':
          description: >-
            Rate limited: one call every 2 seconds and an hourly cap per API
            key. See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '502':
          description: >-
            TikTok refused or failed. `error` is a fixed message and `code`
            names the failure when there is one
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
components:
  schemas:
    TikTokShopError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong
        code:
          type: string
          description: Machine-readable reason, when there is one
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.