> ## 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 Geographic Performance Report

> Retrieve Geographic Performance Report for a specified date range.

Args:
    customer_id: The Google Ads customer ID (required).

    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.
    campaign_id: Optional filter by campaign ID.
    include_local_services: If False, exclude campaigns with advertising_channel_type = 'LOCAL_SERVICES'. Defaults to False.
    targeting_status: Filter by targeting status: POSITIVE (included locations), NEGATIVE (excluded locations), or ALL (both). Defaults to POSITIVE.
    search: Optional text search filter
    oauth2_token: OAuth2 token for authentication.

Returns:
    Geographic Performance Report with location and campaign performance data.



## OpenAPI

````yaml https://dev-api.cattix.com/openapi.json get /api/v1/google-ads/geographic-performance
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/geographic-performance:
    get:
      tags:
        - Google Ads
      summary: Get Geographic Performance Report
      description: |-
        Retrieve Geographic Performance Report for a specified date range.

        Args:
            customer_id: The Google Ads customer ID (required).

            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.
            campaign_id: Optional filter by campaign ID.
            include_local_services: If False, exclude campaigns with advertising_channel_type = 'LOCAL_SERVICES'. Defaults to False.
            targeting_status: Filter by targeting status: POSITIVE (included locations), NEGATIVE (excluded locations), or ALL (both). Defaults to POSITIVE.
            search: Optional text search filter
            oauth2_token: OAuth2 token for authentication.

        Returns:
            Geographic Performance Report with location and campaign performance data.
      operationId: >-
        get_geographic_performance_report_api_v1_google_ads_geographic_performance_get
      parameters:
        - name: customer_id
          in: query
          required: true
          schema:
            type: integer
            title: Customer 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: campaign_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Campaign Id
        - name: include_local_services
          in: query
          required: false
          schema:
            type: boolean
            description: Include LOCAL_SERVICES campaigns from results
            default: false
            title: Include Local Services
          description: Include LOCAL_SERVICES campaigns from results
        - name: targeting_status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/LocationTargetingStatus'
            description: >-
              Filter by targeting status: POSITIVE (included), NEGATIVE
              (excluded), or ALL.
            default: POSITIVE
          description: >-
            Filter by targeting status: POSITIVE (included), NEGATIVE
            (excluded), or ALL.
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                minLength: 1
                maxLength: 200
              - type: 'null'
            title: Search
        - 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/GeographicPerformanceReportSchema'
                title: >-
                  Response Get Geographic Performance Report Api V1 Google Ads
                  Geographic Performance Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    LocationTargetingStatus:
      type: string
      enum:
        - ALL
        - POSITIVE
        - NEGATIVE
      title: LocationTargetingStatus
      description: Location targeting status filter options.
    GeographicPerformanceReportSchema:
      properties:
        location_name:
          type: string
          title: Location Name
        campaign_name:
          type: string
          title: Campaign Name
        impressions:
          type: integer
          title: Impressions
        interactions:
          type: integer
          title: Interactions
        interaction_rate:
          type: number
          title: Interaction Rate
        average_cost:
          type: number
          title: Average Cost
        cost:
          type: number
          title: Cost
        conversions_rate:
          type: number
          title: Conversions Rate
        conversions:
          type: number
          title: Conversions
        cost_per_conversion:
          type: number
          title: Cost Per Conversion
      type: object
      required:
        - location_name
        - campaign_name
        - impressions
        - interactions
        - interaction_rate
        - average_cost
        - cost
        - conversions_rate
        - conversions
        - cost_per_conversion
      title: GeographicPerformanceReportSchema
      description: Schema for Geographic Performance Report 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

````