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

> Every Meta Ads metric for the range: its total, the previous period's total, the change (a fraction: 0.25 is +25%) and a daily sparkline. Metrics: purchase value, last-click revenue, creator earnings, ROAS, spend, CPA, AOV, conversions, link clicks, CTR and thumbstop rate. Takes the same filters as /meta_ads/creators, so the totals describe exactly those rows. `availability` says whether last-click revenue and creator earnings can be tracked (they need orders tagged with an ad Growi has synced).



## OpenAPI

````yaml GET /meta_ads/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:
  /meta_ads/overview:
    get:
      summary: Performance overview
      description: >-
        Every Meta Ads metric for the range: its total, the previous period's
        total, the change (a fraction: 0.25 is +25%) and a daily sparkline.
        Metrics: purchase value, last-click revenue, creator earnings, ROAS,
        spend, CPA, AOV, conversions, link clicks, CTR and thumbstop rate. Takes
        the same filters as /meta_ads/creators, so the totals describe exactly
        those rows. `availability` says whether last-click revenue and creator
        earnings can be tracked (they need orders tagged with an ad Growi has
        synced).
      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: 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
                  date_range:
                    type: object
                    properties:
                      start_date:
                        type: string
                        format: date
                      end_date:
                        type: string
                        format: date
                  previous_range:
                    type: object
                    properties:
                      start_date:
                        type: string
                        format: date
                      end_date:
                        type: string
                        format: date
                  metrics:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        value:
                          type: number
                        prev_value:
                          type: number
                        change_pct:
                          type: number
                          nullable: true
                        sparkline:
                          type: array
                          items:
                            type: number
                    description: >-
                      Keyed by purchase_value, last_click_revenue,
                      creator_earnings, roas, spend, cpa, aov, conversions,
                      link_clicks, ctr, thumbstop
                  availability:
                    type: object
                    properties:
                      last_click_revenue:
                        type: boolean
                      creator_earnings:
                        type: boolean
        '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.