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

# Performance by creator

> The Meta Ads performance table grouped by creator: each creator's totals across their ads, their ads nested, a 14-day sparkline and launch and fatigue flags. Also returns totals for every filtered row, quick view counts and histograms of the range metrics.



## OpenAPI

````yaml GET /meta_ads/creators
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:
  /meta_ads/creators:
    get:
      summary: Performance by creator
      description: >-
        The Meta Ads performance table grouped by creator: each creator's totals
        across their ads, their ads nested, a 14-day sparkline and launch and
        fatigue flags. Also returns totals for every filtered row, quick view
        counts and histograms of the range metrics.
      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: 7 days ago. At most 366 days before
            end_date.
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: false
          description: 'Last day, YYYY-MM-DD. Default: today.'
          schema:
            type: string
            format: date
        - name: sort
          in: query
          required: false
          description: 'Sort rows by a metric, name or launched_at. Default: metric.'
          schema:
            type: string
            enum:
              - purchase_value
              - last_click_revenue
              - creator_earnings
              - roas
              - spend
              - cpa
              - aov
              - conversions
              - link_clicks
              - ctr
              - thumbstop
              - name
              - launched_at
        - name: metric
          in: query
          required: false
          description: >-
            The metric of each row's sparkline and the default sort. Default
            spend.
          schema:
            type: string
            enum:
              - purchase_value
              - last_click_revenue
              - creator_earnings
              - roas
              - spend
              - cpa
              - aov
              - conversions
              - link_clicks
              - ctr
              - thumbstop
        - name: direction
          in: query
          required: false
          description: desc (default) or asc.
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: page
          in: query
          required: false
          description: Page number, from 1.
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Rows per page, 1-200. Default 50.
          schema:
            type: integer
        - name: q
          in: query
          required: false
          description: Search ad, creator, ad set or product names.
          schema:
            type: string
        - name: ads
          in: query
          required: false
          description: >-
            all (default), only creatives with an active ad, or only creatives
            with purchases.
          schema:
            type: string
            enum:
              - all
              - active
              - with_gmv
        - name: creator_ids
          in: query
          required: false
          description: Comma separated Growi user ids.
          schema:
            type: string
        - name: campaign_ids
          in: query
          required: false
          description: Comma separated Growi campaign ids.
          schema:
            type: string
        - name: ad_set_ids
          in: query
          required: false
          description: Comma separated Growi ad set ids, or `unassigned`.
          schema:
            type: string
        - name: product_tags
          in: query
          required: false
          description: Comma separated product names, or `Unattributed`.
          schema:
            type: string
        - name: launched
          in: query
          required: false
          description: Only ads launched in the last N days.
          schema:
            type: string
            enum:
              - '7'
              - '14'
              - '30'
        - name: quick_view
          in: query
          required: false
          description: >-
            scaling (ROAS >= 1.5), burning (ROAS < 0.5), fatiguing (CTR down
            30%+ week over week) or new (launched in the last 7 days).
          schema:
            type: string
            enum:
              - scaling
              - burning
              - fatiguing
              - new
        - name: purchase_value_min
          in: query
          required: false
          description: Rows with purchase_value at least this.
          schema:
            type: number
        - name: purchase_value_max
          in: query
          required: false
          description: Rows with purchase_value at most this.
          schema:
            type: number
        - name: cpa_min
          in: query
          required: false
          description: Rows with cpa at least this.
          schema:
            type: number
        - name: cpa_max
          in: query
          required: false
          description: Rows with cpa at most this.
          schema:
            type: number
        - name: spend_min
          in: query
          required: false
          description: Rows with spend at least this.
          schema:
            type: number
        - name: spend_max
          in: query
          required: false
          description: Rows with spend at most this.
          schema:
            type: number
        - name: roas_min
          in: query
          required: false
          description: Rows with roas at least this.
          schema:
            type: number
        - name: roas_max
          in: query
          required: false
          description: Rows with roas at most this.
          schema:
            type: number
        - name: ctr_min
          in: query
          required: false
          description: Rows with ctr at least this.
          schema:
            type: number
        - name: ctr_max
          in: query
          required: false
          description: Rows with ctr at most this.
          schema:
            type: number
        - name: thumbstop_min
          in: query
          required: false
          description: Rows with thumbstop at least this.
          schema:
            type: number
        - name: thumbstop_max
          in: query
          required: false
          description: Rows with thumbstop at most this.
          schema:
            type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  group_by:
                    type: string
                  metric:
                    type: string
                  sort:
                    type: string
                  direction:
                    type: string
                  date_range:
                    type: object
                    properties:
                      start_date:
                        type: string
                        format: date
                      end_date:
                        type: string
                        format: date
                  tw_metric_columns:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        value_type:
                          type: string
                  total:
                    type: integer
                    description: Rows across all pages
                  creator_count:
                    type: integer
                  ad_count:
                    type: integer
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total:
                        type: integer
                  totals:
                    type: object
                    properties:
                      purchase_value:
                        type: number
                      last_click_revenue:
                        type: number
                      last_click_commission:
                        type: number
                      cpa:
                        type: number
                      roas:
                        type: number
                      spend:
                        type: number
                      aov:
                        type: number
                      conversions:
                        type: integer
                      link_clicks:
                        type: integer
                      ctr:
                        type: number
                      thumbstop:
                        type: number
                      tw_metrics:
                        type: object
                        additionalProperties:
                          type: number
                        description: Your Triple Whale metrics shown to the brand, by key
                    description: Money in your currency (not cents).
                  quick_view_counts:
                    type: object
                    additionalProperties:
                      type: integer
                  histograms:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties: true
                    description: 'Per range metric: min, max, edges, counts, total'
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        creator:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                            handle:
                              type: string
                              nullable: true
                            avatar_url:
                              type: string
                              nullable: true
                            color:
                              type: string
                        ads_count:
                          type: integer
                        ads_active_count:
                          type: integer
                        metrics:
                          type: object
                          properties:
                            purchase_value:
                              type: number
                            last_click_revenue:
                              type: number
                            last_click_commission:
                              type: number
                            cpa:
                              type: number
                            roas:
                              type: number
                            spend:
                              type: number
                            aov:
                              type: number
                            conversions:
                              type: integer
                            link_clicks:
                              type: integer
                            ctr:
                              type: number
                            thumbstop:
                              type: number
                            tw_metrics:
                              type: object
                              additionalProperties:
                                type: number
                              description: >-
                                Your Triple Whale metrics shown to the brand, by
                                key
                          description: Money in your currency (not cents).
                        ads:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              ad_name:
                                type: string
                              creative_name:
                                type: string
                                nullable: true
                              meta_ads_count:
                                type: integer
                              thumbnail_url:
                                type: string
                                nullable: true
                              thumbnail_color:
                                type: string
                              status:
                                type: string
                                enum:
                                  - active
                                  - paused
                                  - draft
                              product_tag:
                                type: string
                                nullable: true
                              creator:
                                allOf:
                                  - type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      handle:
                                        type: string
                                        nullable: true
                                      avatar_url:
                                        type: string
                                        nullable: true
                                      color:
                                        type: string
                                nullable: true
                              ad_set_id:
                                type: string
                              ad_set_name:
                                type: string
                              metrics:
                                type: object
                                properties:
                                  purchase_value:
                                    type: number
                                  last_click_revenue:
                                    type: number
                                  last_click_commission:
                                    type: number
                                  cpa:
                                    type: number
                                  roas:
                                    type: number
                                  spend:
                                    type: number
                                  aov:
                                    type: number
                                  conversions:
                                    type: integer
                                  link_clicks:
                                    type: integer
                                  ctr:
                                    type: number
                                  thumbstop:
                                    type: number
                                  tw_metrics:
                                    type: object
                                    additionalProperties:
                                      type: number
                                    description: >-
                                      Your Triple Whale metrics shown to the
                                      brand, by key
                                description: Money in your currency (not cents).
                              launched_at:
                                type: string
                                format: date-time
                                nullable: true
                              is_new:
                                type: boolean
                              fatiguing:
                                type: boolean
                              sparkline:
                                type: array
                                items:
                                  type: number
                        launched_at:
                          type: string
                          nullable: true
                        is_new:
                          type: boolean
                        fatiguing:
                          type: boolean
                        sparkline:
                          type: array
                          items:
                            type: number
        '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.