> ## 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.

# Stores overview

> Sales per store for the range, the same numbers as the dashboard's Stores overview: Shopify, TikTok Shop, Amazon, custom website, App Store, Google Play and Meta Ads (the stores your organization type uses; agencies and parent organizations get all of them, rolled up over their brands). Each store carries its connection status, totals (GMV, commission, orders, active creators, AOV), the change against the previous period of the same length and a daily series. Meta Ads also carries spend and three revenue views: last click, Meta reported and Triple Whale. Money is in cents. Refreshed every 15 minutes.

> [!TIP]
>
> Replaces [`/stats/top_creators_by_gmv`](https://growi.mintlify.site/api-reference/endpoint/get-top-creators-by-gmv) and [`/stats/top_earning_creators`](https://growi.mintlify.site/api-reference/endpoint/get-top-earning-creators), which are deprecated.


## OpenAPI

````yaml GET /stores/overview
openapi: 3.0.1
info:
  title: Growi API
  description: >-
    API documentation for Growi platform, showcasing the public tracking event
    endpoint
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /stores/overview:
    get:
      summary: Stores overview
      description: >-
        Sales per store for the range, the same numbers as the dashboard's
        Stores overview: Shopify, TikTok Shop, Amazon, custom website, App
        Store, Google Play and Meta Ads (the stores your organization type uses;
        agencies and parent organizations get all of them, rolled up over their
        brands). Each store carries its connection status, totals (GMV,
        commission, orders, active creators, AOV), the change against the
        previous period of the same length and a daily series. Meta Ads also
        carries spend and three revenue views: last click, Meta reported and
        Triple Whale. Money is in cents. Refreshed every 15 minutes.
      parameters:
        - name: organization_id
          in: query
          required: false
          description: >-
            Read one of your child brands instead of the organization that owns
            the key. Any id that is not one of your brands answers 404.
          schema:
            type: integer
        - name: start_date
          in: query
          required: false
          description: 'First day, YYYY-MM-DD. Default: 29 days before end_date.'
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: false
          description: 'Last day, YYYY-MM-DD. Default: today (UTC). At most 366 days in all.'
          schema:
            type: string
            format: date
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      currency_symbol:
                        type: string
                      organization_type:
                        type: string
                        nullable: true
                      range:
                        type: object
                        properties:
                          start:
                            type: string
                            format: date
                          end:
                            type: string
                            format: date
                          prior_start:
                            type: string
                            format: date
                          prior_end:
                            type: string
                            format: date
                      channels:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              enum:
                                - shopify
                                - tiktok_shop
                                - amazon
                                - website
                                - ios
                                - android
                                - meta_ads
                            name:
                              type: string
                            connected:
                              type: boolean
                            status:
                              type: string
                              description: ok, needs_reauth, pending_first_sync, ...
                            last_synced_at:
                              type: string
                              format: date-time
                              nullable: true
                            last_data_date:
                              type: string
                              format: date
                              nullable: true
                            available:
                              type: boolean
                              description: >-
                                Connected, or has data in the range. totals,
                                deltas and series appear only when true.
                            totals:
                              type: object
                              properties:
                                gmv_cents:
                                  type: integer
                                commission_cents:
                                  type: integer
                                orders:
                                  type: integer
                                refund_cents:
                                  type: integer
                                  description: TikTok Shop only
                                active_creators:
                                  type: integer
                                aov_cents:
                                  type: integer
                                  nullable: true
                                revenue_per_commission:
                                  type: number
                                  nullable: true
                            deltas:
                              type: object
                              additionalProperties: true
                            series:
                              type: array
                              items:
                                type: object
                                properties:
                                  date:
                                    type: string
                                    format: date
                                  gmv_cents:
                                    type: integer
                                  commission_cents:
                                    type: integer
                                  orders:
                                    type: integer
                            attribution:
                              type: object
                              properties:
                                spend_scope:
                                  type: string
                                spend:
                                  type: object
                                  properties:
                                    spend_cents:
                                      type: integer
                                    series:
                                      type: array
                                      items:
                                        type: object
                                        additionalProperties: true
                                last_click:
                                  type: object
                                  properties:
                                    available:
                                      type: boolean
                                    revenue_cents:
                                      type: integer
                                    orders:
                                      type: integer
                                      nullable: true
                                    roas:
                                      type: number
                                      nullable: true
                                    series:
                                      type: array
                                      items:
                                        type: object
                                        additionalProperties: true
                                meta_reported:
                                  type: object
                                  properties:
                                    available:
                                      type: boolean
                                    revenue_cents:
                                      type: integer
                                    orders:
                                      type: integer
                                      nullable: true
                                    roas:
                                      type: number
                                      nullable: true
                                    series:
                                      type: array
                                      items:
                                        type: object
                                        additionalProperties: true
                                triple_whale:
                                  type: object
                                  properties:
                                    available:
                                      type: boolean
                                    revenue_cents:
                                      type: integer
                                    orders:
                                      type: integer
                                      nullable: true
                                    roas:
                                      type: number
                                      nullable: true
                                    series:
                                      type: array
                                      items:
                                        type: object
                                        additionalProperties: true
                              description: Meta Ads only
                      blended:
                        type: object
                        properties:
                          totals:
                            type: object
                            properties:
                              gmv_cents:
                                type: integer
                              commission_cents:
                                type: integer
                              orders:
                                type: integer
                              refund_cents:
                                type: integer
                                description: TikTok Shop only
                              active_creators:
                                type: integer
                              aov_cents:
                                type: integer
                                nullable: true
                              revenue_per_commission:
                                type: number
                                nullable: true
                          deltas:
                            type: object
                            additionalProperties: true
                          series:
                            type: array
                            items:
                              type: object
                              additionalProperties: true
                          prior_series:
                            type: array
                            items:
                              type: object
                              additionalProperties: true
                        description: >-
                          The stores summed. Never includes the Meta reported or
                          Triple Whale views.
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Invalid or missing params. `error` says which
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limited: 2 seconds between calls and an hourly cap per API key.
            See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: string
          description: What went wrong
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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