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

# Get Auction Insights

> Retrieve auction insights for campaigns or ad groups for a specified date range.

Args:
    customer_id: The Google Ads customer ID

    campaign_id: Optional campaign ID filter
    ad_group_id: Optional ad group ID filter (takes precedence over campaign_id if both provided)
    start_date (str): Start date for the data range (YYYY-MM-DD). Defaults to 30 days ago.
    end_date (str): End date for the data range (YYYY-MM-DD). Defaults to today.
    oauth2_token: OAuth2 token for authentication

Returns:
    List of auction insights with competitor metrics



## OpenAPI

````yaml https://dev-api.cattix.com/openapi.json get /api/v1/google-ads/auction-insights
openapi: 3.1.0
info:
  title: CATTIX API
  description: CATTIX Backend API
  version: 0.107.0
servers:
  - url: http://localhost:8000
    description: Local
  - url: https://dev-api.cattix.com
    description: Development
  - url: https://staging-api.cattix.com
    description: Staging
  - url: https://api.cattix.com
    description: Production
security: []
paths:
  /api/v1/google-ads/auction-insights:
    get:
      tags:
        - Google Ads
      summary: Get Auction Insights
      description: >-
        Retrieve auction insights for campaigns or ad groups for a specified
        date range.


        Args:
            customer_id: The Google Ads customer ID

            campaign_id: Optional campaign ID filter
            ad_group_id: Optional ad group ID filter (takes precedence over campaign_id if both provided)
            start_date (str): Start date for the data range (YYYY-MM-DD). Defaults to 30 days ago.
            end_date (str): End date for the data range (YYYY-MM-DD). Defaults to today.
            oauth2_token: OAuth2 token for authentication

        Returns:
            List of auction insights with competitor metrics
      operationId: get_auction_insights_api_v1_google_ads_auction_insights_get
      parameters:
        - name: customer_id
          in: query
          required: true
          schema:
            type: integer
            title: Customer Id
        - name: campaign_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Campaign Id
        - name: ad_group_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Ad Group Id
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            title: Start Date
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            title: End Date
        - name: token_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Optional specific Token ID
            title: Token Id
          description: Optional specific Token ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuctionInsightSchema'
                title: >-
                  Response Get Auction Insights Api V1 Google Ads Auction
                  Insights Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    AuctionInsightSchema:
      properties:
        display_name:
          type: string
          title: Display Name
        domain_url:
          type: string
          title: Domain Url
        impression_share:
          type: number
          title: Impression Share
        overlap_rate:
          type: number
          title: Overlap Rate
        position_above_rate:
          type: number
          title: Position Above Rate
        top_of_page_rate:
          type: number
          title: Top Of Page Rate
        outranking_share:
          type: number
          title: Outranking Share
      type: object
      required:
        - display_name
        - domain_url
        - impression_share
        - overlap_rate
        - position_above_rate
        - top_of_page_rate
        - outranking_share
      title: AuctionInsightSchema
      description: Schema for Auction Insights data
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: api/v1/users/authorization/token

````