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

# Shopify stats

> The Shopify Ambassadors stats: revenue, commission, orders, page views, link clicks, creators added and ambassador sign-ins, as totals and a daily series, plus top creators and top products. Revenue, commission and orders equal the Sales tab for the same filters. Money is in cents. Refreshed every 15 minutes. Replaces /stats/top_creators_by_gmv and /stats/top_earning_creators.



## OpenAPI

````yaml GET /shopify/stats
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:
  /shopify/stats:
    get:
      summary: Shopify stats
      description: >-
        The Shopify Ambassadors stats: revenue, commission, orders, page views,
        link clicks, creators added and ambassador sign-ins, as totals and a
        daily series, plus top creators and top products. Revenue, commission
        and orders equal the Sales tab for the same filters. Money is in cents.
        Refreshed every 15 minutes. Replaces /stats/top_creators_by_gmv and
        /stats/top_earning_creators.
      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
        - name: campaign_scope
          in: query
          required: false
          description: >-
            Which programs: ambassador programs (default), social campaigns and
            contracts, or all.
          schema:
            type: string
            enum:
              - ambassador
              - social
              - all
        - name: campaign_ids
          in: query
          required: false
          description: Comma separated campaign ids of your organization.
          schema:
            type: string
        - name: creator_id
          in: query
          required: false
          description: Only this creator (Growi user id).
          schema:
            type: integer
        - name: sale_source
          in: query
          required: false
          description: all (default), sales from Meta ads, or organic.
          schema:
            type: string
            enum:
              - all
              - meta
              - organic
        - name: customer_occurrence
          in: query
          required: false
          description: First-time or repeat customers only.
          schema:
            type: string
            enum:
              - first_time
              - repeat
              - all
        - name: joined_start_date
          in: query
          required: false
          description: Only creators who joined on or after this day, YYYY-MM-DD.
          schema:
            type: string
            format: date
        - name: joined_end_date
          in: query
          required: false
          description: Only creators who joined on or before this day, YYYY-MM-DD.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      totals:
                        type: object
                        additionalProperties: true
                      series:
                        type: array
                        items:
                          type: object
                          additionalProperties: true
                      top_creators:
                        type: object
                        additionalProperties: true
                      top_products:
                        type: object
                        additionalProperties: true
                      notes:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
        '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.