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

> Get all analyses with pagination. Only superusers can access this endpoint.



## OpenAPI

````yaml https://dev-api.cattix.com/openapi.json get /api/v1/analysis/
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/analysis/:
    get:
      tags:
        - Analysis
      summary: Get Analyses
      description: >-
        Get all analyses with pagination. Only superusers can access this
        endpoint.
      operationId: get_analyses_api_v1_analysis__get
      parameters:
        - name: analysis_type
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/AnalysisTypes'
              - type: 'null'
            title: Analysis Type
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 20
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AnalysisSchema'
                title: Response Get Analyses Api V1 Analysis  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    AnalysisTypes:
      type: string
      enum:
        - keyword_pause
        - negative_keyword
        - double_check_keywords_to_pause
        - headline
        - description
        - budget_migration
        - pause_hours
        - pause_locations
        - search_terms
      title: AnalysisTypes
      description: The types of analyses.
    AnalysisSchema:
      properties:
        id:
          type: integer
          title: Id
        google_ads_customer:
          $ref: >-
            #/components/schemas/api__knowledge_items__schemas__GoogleAdsCustomerSchema
        google_ads_login_customer_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Google Ads Login Customer Id
        campaign:
          $ref: '#/components/schemas/CampaignSchema'
        analysis_type:
          $ref: '#/components/schemas/AnalysisTypes'
        delay:
          type: integer
          title: Delay
        is_started:
          type: boolean
          title: Is Started
        is_completed:
          type: boolean
          title: Is Completed
        is_failed:
          type: boolean
          title: Is Failed
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
        data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Data
        date_added:
          type: string
          format: date-time
          title: Date Added
        date_updated:
          type: string
          format: date-time
          title: Date Updated
      type: object
      required:
        - id
        - google_ads_customer
        - google_ads_login_customer_id
        - campaign
        - analysis_type
        - delay
        - is_started
        - is_completed
        - is_failed
        - message
        - error_message
        - data
        - date_added
        - date_updated
      title: AnalysisSchema
      description: The schema for an analysis.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    api__knowledge_items__schemas__GoogleAdsCustomerSchema:
      properties:
        id:
          type: integer
          title: Id
        descriptive_name:
          type: string
          title: Descriptive Name
        currency_code:
          type: string
          title: Currency Code
        time_zone:
          type: string
          title: Time Zone
        status:
          type: string
          title: Status
        manager:
          type: boolean
          title: Manager
      type: object
      required:
        - id
        - descriptive_name
        - currency_code
        - time_zone
        - status
        - manager
      title: GoogleAdsCustomerSchema
      description: The schema for a Google Ads customer.
    CampaignSchema:
      properties:
        id:
          type: integer
          title: The ID of the campaign
        google_ads_customer_id:
          type: integer
          title: The ID of the Google Ads customer
        name:
          type: string
          title: The name of the campaign
        status:
          type: string
          title: The status of the campaign
        channel_type:
          anyOf:
            - type: string
            - type: 'null'
          title: The channel type of the campaign
        start_date:
          type: string
          format: date-time
          title: The start date of the campaign
        end_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: The end date of the campaign
      type: object
      required:
        - id
        - google_ads_customer_id
        - name
        - status
        - start_date
      title: CampaignSchema
      description: Schema for Campaign 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

````