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

# Get Whats Working Report Route

> Live own-account Meta Ads creative-performance report (What's Working).



## OpenAPI

````yaml /openapi.json get /api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working
openapi: 3.1.0
info:
  title: AITasker
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working:
    get:
      tags:
        - Brand Intelligence
        - Brand Intelligence
      summary: Get Whats Working Report Route
      description: Live own-account Meta Ads creative-performance report (What's Working).
      operationId: >-
        get_whats_working_report_route_api_v1_brands__brand_id__brand_intelligence_reports_whats_working_get
      parameters:
        - name: brand_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Brand Id
        - name: date_preset
          in: query
          required: false
          schema:
            type: string
            title: Date Preset
            default: last_14d
        - name: since
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            title: Since
        - name: until
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            title: Until
        - name: sort_metric
          in: query
          required: false
          schema:
            enum:
              - spend
              - roas
              - cpa
              - purchase_value
              - ctr
              - cpm
              - purchases
              - impressions
            type: string
            default: spend
            title: Sort Metric
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsWorkingReportResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    WhatsWorkingReportResponse:
      properties:
        brand_id:
          type: string
          format: uuid
          title: Brand Id
        status:
          type: string
          enum:
            - ok
            - not_connected
            - needs_account_selection
          title: Status
        account_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Id
        account_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Name
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        account_timezone_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Timezone Name
        date_preset:
          type: string
          title: Date Preset
        date_start:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date Start
        date_end:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date End
        generated_at:
          type: string
          format: date-time
          title: Generated At
        rows:
          items:
            $ref: '#/components/schemas/WhatsWorkingRow'
          type: array
          title: Rows
        totals:
          anyOf:
            - $ref: '#/components/schemas/WhatsWorkingMetrics'
            - type: 'null'
      type: object
      required:
        - brand_id
        - status
        - date_preset
        - generated_at
      title: WhatsWorkingReportResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WhatsWorkingRow:
      properties:
        spend:
          type: number
          title: Spend
          default: 0
        impressions:
          type: integer
          title: Impressions
          default: 0
        clicks:
          type: integer
          title: Clicks
          default: 0
        link_clicks:
          type: integer
          title: Link Clicks
          default: 0
        outbound_clicks:
          type: integer
          title: Outbound Clicks
          default: 0
        purchases:
          type: number
          title: Purchases
          default: 0
        purchase_value:
          type: number
          title: Purchase Value
          default: 0
        leads:
          type: number
          title: Leads
          default: 0
        adds_to_cart:
          type: number
          title: Adds To Cart
          default: 0
        video_views:
          type: number
          title: Video Views
          default: 0
        roas:
          anyOf:
            - type: number
            - type: 'null'
          title: Roas
        cpa:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpa
        aov:
          anyOf:
            - type: number
            - type: 'null'
          title: Aov
        cost_per_lead:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost Per Lead
        ctr:
          anyOf:
            - type: number
            - type: 'null'
          title: Ctr
        ctr_outbound:
          anyOf:
            - type: number
            - type: 'null'
          title: Ctr Outbound
        cpc:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpc
        cpc_link:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpc Link
        cpm:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpm
        click_to_atc_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Click To Atc Ratio
        atc_to_purchase_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Atc To Purchase Ratio
        thumbstop_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Thumbstop Ratio
        group_key:
          type: string
          title: Group Key
        ad_name:
          type: string
          title: Ad Name
        ad_ids:
          items:
            type: string
          type: array
          title: Ad Ids
        ad_count:
          type: integer
          title: Ad Count
          default: 0
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Thumbnail Url
        media_assets:
          items:
            $ref: '#/components/schemas/WhatsWorkingMediaAsset'
          type: array
          title: Media Assets
      type: object
      required:
        - group_key
        - ad_name
      title: WhatsWorkingRow
    WhatsWorkingMetrics:
      properties:
        spend:
          type: number
          title: Spend
          default: 0
        impressions:
          type: integer
          title: Impressions
          default: 0
        clicks:
          type: integer
          title: Clicks
          default: 0
        link_clicks:
          type: integer
          title: Link Clicks
          default: 0
        outbound_clicks:
          type: integer
          title: Outbound Clicks
          default: 0
        purchases:
          type: number
          title: Purchases
          default: 0
        purchase_value:
          type: number
          title: Purchase Value
          default: 0
        leads:
          type: number
          title: Leads
          default: 0
        adds_to_cart:
          type: number
          title: Adds To Cart
          default: 0
        video_views:
          type: number
          title: Video Views
          default: 0
        roas:
          anyOf:
            - type: number
            - type: 'null'
          title: Roas
        cpa:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpa
        aov:
          anyOf:
            - type: number
            - type: 'null'
          title: Aov
        cost_per_lead:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost Per Lead
        ctr:
          anyOf:
            - type: number
            - type: 'null'
          title: Ctr
        ctr_outbound:
          anyOf:
            - type: number
            - type: 'null'
          title: Ctr Outbound
        cpc:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpc
        cpc_link:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpc Link
        cpm:
          anyOf:
            - type: number
            - type: 'null'
          title: Cpm
        click_to_atc_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Click To Atc Ratio
        atc_to_purchase_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Atc To Purchase Ratio
        thumbstop_ratio:
          anyOf:
            - type: number
            - type: 'null'
          title: Thumbstop Ratio
      type: object
      title: WhatsWorkingMetrics
      description: >-
        Aggregated Meta insights metrics for one ad group (or the report
        totals).


        Raw counters are summed across the group's ads; ratio metrics are
        derived

        AFTER aggregation (never averaged) and are ``None`` when the denominator

        is zero.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    WhatsWorkingMediaAsset:
      properties:
        ad_id:
          type: string
          title: Ad Id
        provider_key:
          type: string
          title: Provider Key
        media_type:
          type: string
          enum:
            - image
            - video
            - gif
          title: Media Type
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Url
        preview_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Preview Url
        width:
          anyOf:
            - type: integer
            - type: 'null'
          title: Width
        height:
          anyOf:
            - type: integer
            - type: 'null'
          title: Height
      type: object
      required:
        - ad_id
        - provider_key
        - media_type
      title: WhatsWorkingMediaAsset
      description: One renderable Meta creative asset attached to a report row.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````