> ## 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 Device Performance

> Retrieve performance metrics segmented by device type for a specified date range.

Args:
    customer_id: The Google Ads customer ID

    campaign_id: Optional filter by campaign ID
    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:
    Performance metrics by device type



## OpenAPI

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


        Args:
            customer_id: The Google Ads customer ID

            campaign_id: Optional filter by campaign ID
            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:
            Performance metrics by device type
      operationId: get_device_performance_api_v1_google_ads_device_performance_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: 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:
                $ref: '#/components/schemas/DevicePerformanceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    DevicePerformanceResponse:
      properties:
        device_performance:
          items:
            $ref: '#/components/schemas/DevicePerformance'
          type: array
          title: Device Performance
        time_period:
          type: string
          title: Time Period
        total_impressions:
          type: integer
          title: Total Impressions
        total_clicks:
          type: integer
          title: Total Clicks
        total_cost:
          type: number
          title: Total Cost
        total_conversions:
          type: number
          title: Total Conversions
      type: object
      required:
        - device_performance
        - time_period
        - total_impressions
        - total_clicks
        - total_cost
        - total_conversions
      title: DevicePerformanceResponse
      description: Response schema for device performance
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DevicePerformance:
      properties:
        device_type:
          type: string
          title: Device Type
        impressions:
          type: integer
          title: Impressions
        clicks:
          type: integer
          title: Clicks
        ctr:
          type: number
          title: Ctr
        cost:
          type: number
          title: Cost
        conversions:
          type: number
          title: Conversions
        cost_per_conversion:
          type: number
          title: Cost Per Conversion
        conversion_rate:
          type: number
          title: Conversion Rate
        percentage_of_total_impressions:
          type: number
          title: Percentage Of Total Impressions
      type: object
      required:
        - device_type
        - impressions
        - clicks
        - ctr
        - cost
        - conversions
        - cost_per_conversion
        - conversion_rate
        - percentage_of_total_impressions
      title: DevicePerformance
      description: Schema for device performance data
    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

````