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

# Get search performance

> <Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Google clicks, impressions, CTR, position, top queries and pages from Search Console, or estimated rankings when Search Console isn't connected. Limited to 60 requests per minute per app across all the research endpoints; responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`, and a `429` carries `Retry-After`. Paid lookups also draw on a weekly per-app budget (`429 quota_exceeded` once it is used up).



## OpenAPI

````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/search-performance
openapi: 3.1.0
info:
  title: Base44 App Management API
  version: 1.0.0
servers:
  - url: https://app.base44.com
security:
  - PersonalAccessTokenAuth: []
paths:
  /api/apps/{app_id}/seo/research/search-performance:
    get:
      summary: Get search performance
      description: >-
        <Info>This API is in beta. Endpoints, fields, and behavior may still
        change, so avoid depending on it in production.</Info>


        Google clicks, impressions, CTR, position, top queries and pages from
        Search Console, or estimated rankings when Search Console isn't
        connected. Limited to 60 requests per minute per app across all the
        research endpoints; responses carry `X-RateLimit-Limit`,
        `X-RateLimit-Remaining` and `X-RateLimit-Reset`, and a `429` carries
        `Retry-After`. Paid lookups also draw on a weekly per-app budget (`429
        quota_exceeded` once it is used up).
      operationId: >-
        get_search_performance_api_apps__app_id__seo_research_search_performance_get
      parameters:
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            description: ID of the app.
            title: App Id
          description: ID of the app.
          example: 6820f3a4e7b91d003c45a1f2
        - name: days
          in: query
          required: false
          schema:
            type: integer
            description: Window in days, one of [7, 28, 90]. Default 28.
            default: 28
            title: Days
          description: Window in days, one of [7, 28, 90]. Default 28.
      responses:
        '200':
          description: >-
            Search Console numbers, or estimated rankings (`source:
            "estimated_rankings"`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchPerformance'
              example:
                source: search_console
                days: 28
                totals:
                  clicks: 120
                  impressions: 4300
                  ctr: 0.028
                  position: 14.2
                previous_totals:
                  clicks: 98
                  impressions: 3900
                  ctr: 0.025
                  position: 15.1
                top_queries:
                  - query: game tracker
                    clicks: 30
                    impressions: 900
                    ctr: 0.033
                    position: 6.1
                    is_new: false
                top_pages:
                  - page: https://pixelboxd.com/
                    clicks: 70
                    impressions: 2100
                    ctr: 0.033
                    position: 9.4
        '400':
          description: '`invalid_request`: a parameter is empty or malformed.'
          content:
            application/json:
              examples:
                invalid_request:
                  summary: invalid_request
                  value:
                    error:
                      code: invalid_request
                      message: Pass a keyword.
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '402':
          description: >-
            `insufficient_credits`: a live lookup is charged to the workspace's
            credits, and it has too few.
          content:
            application/json:
              examples:
                insufficient_credits:
                  summary: insufficient_credits
                  value:
                    error:
                      code: insufficient_credits
                      message: Not enough credits
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '403':
          description: >-
            `engine_not_allowed`: the workspace's AI model settings block every
            engine asked.
          content:
            application/json:
              examples:
                engine_not_allowed:
                  summary: engine_not_allowed
                  value:
                    error:
                      code: engine_not_allowed
                      message: >-
                        This workspace's AI model settings block every engine
                        asked; pick another engine.
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '404':
          description: >-
            `not_found`: the app doesn't exist, or SEO research isn't enabled
            for it.
          content:
            application/json:
              examples:
                not_found:
                  summary: not_found
                  value:
                    error:
                      code: not_found
                      message: Not found
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '409':
          description: >-
            `not_set_up`: the app has no domain or search data source to look up
            yet.
          content:
            application/json:
              examples:
                not_set_up:
                  summary: not_set_up
                  value:
                    error:
                      code: not_set_up
                      message: This app has no domain to compare yet.
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '422':
          description: >-
            `invalid_request`: a required parameter is missing or the wrong
            type, or out of range. `error.details.errors` lists each problem.
          content:
            application/json:
              examples:
                invalid_request:
                  summary: invalid_request
                  value:
                    error:
                      code: invalid_request
                      message: Invalid request
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '429':
          description: >-
            `rate_limited` (request limit) or `quota_exceeded` (the app's lookup
            budget); both carry `Retry-After`.
          content:
            application/json:
              examples:
                quota_exceeded:
                  summary: quota_exceeded
                  value:
                    error:
                      code: quota_exceeded
                      message: >-
                        This app's live SEO lookups are used up for now; they
                        reset within a week.
                      details: {}
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
        '503':
          description: >-
            Database temporarily unavailable (`database_unavailable`): the data
            cluster did not answer in time. Retry after the `Retry-After`
            seconds.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorEnvelope'
              examples:
                database_unavailable:
                  summary: database_unavailable
                  value:
                    error:
                      code: database_unavailable
                      message: Database temporarily unavailable, please retry
                      details: {}
      security:
        - PersonalAccessTokenAuth:
            - read_only
components:
  schemas:
    SearchPerformance:
      properties:
        source:
          type: string
          enum:
            - search_console
            - estimated_rankings
          title: Source
          description: >-
            `search_console` when Search Console is connected, otherwise
            `estimated_rankings`.
          example: search_console
        days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Days
          description: Window in days. Only with `search_console`.
          example: 28
        totals:
          anyOf:
            - $ref: '#/components/schemas/SearchTotals'
            - type: 'null'
          description: Totals for the window. Only with `search_console`.
        previous_totals:
          anyOf:
            - $ref: '#/components/schemas/SearchTotals'
            - type: 'null'
          description: >-
            Totals for the window before it, or `null` when Google has no data
            for it. Only with `search_console`.
        top_queries:
          anyOf:
            - items:
                $ref: '#/components/schemas/SearchQuery'
              type: array
            - type: 'null'
          title: Top Queries
          description: Top queries by clicks. Only with `search_console`.
          example:
            - clicks: 30
              ctr: 0.033
              impressions: 900
              is_new: false
              position: 6.1
              query: game tracker
        top_pages:
          anyOf:
            - items:
                $ref: '#/components/schemas/SearchPage'
              type: array
            - type: 'null'
          title: Top Pages
          description: Top pages by clicks. Only with `search_console`.
          example:
            - clicks: 70
              ctr: 0.033
              impressions: 2100
              page: https://pixelboxd.com/
              position: 9.4
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
          description: Why the numbers are estimates. Only with `estimated_rankings`.
          example: Search Console isn't connected; these are estimated Google rankings.
        ranked_keywords:
          anyOf:
            - type: integer
            - type: 'null'
          title: Ranked Keywords
          description: >-
            Keywords the app ranks for in total, or `null`. Only with
            `estimated_rankings`.
          example: 140
        page1_in_sample:
          anyOf:
            - type: integer
            - type: 'null'
          title: Page1 In Sample
          description: >-
            How many of the app's sampled ranked keywords put it on page one.
            Only with `estimated_rankings`.
          example: 6
        top:
          anyOf:
            - items:
                $ref: '#/components/schemas/RankedKeyword'
              type: array
            - type: 'null'
          title: Top
          description: >-
            Up to 20 of the app's ranked keywords. Only with
            `estimated_rankings`.
          example:
            - competition: low
              difficulty: 18
              etv: 45.5
              intent: commercial
              keyword: game tracker
              position: 8
              url: https://pixelboxd.com/
              volume: 2900
        cost_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost Usd
          description: What the lookup cost in US dollars. Only with `estimated_rankings`.
          example: 0.02
      type: object
      required:
        - source
      title: SearchPerformance
    StandardErrorEnvelope:
      properties:
        error:
          $ref: '#/components/schemas/StandardError'
          description: What went wrong.
      type: object
      required:
        - error
      title: StandardErrorEnvelope
      description: The error body returned in the standard envelope.
    SearchTotals:
      properties:
        clicks:
          type: integer
          title: Clicks
          description: Clicks from Google search.
          example: 120
        impressions:
          type: integer
          title: Impressions
          description: Times the app showed in Google results.
          example: 4300
        ctr:
          type: number
          title: Ctr
          description: Clicks divided by impressions, from 0 to 1.
          example: 0.028
        position:
          type: number
          title: Position
          description: Average position in results, weighted by impressions.
          example: 14.2
      type: object
      required:
        - clicks
        - impressions
        - ctr
        - position
      title: SearchTotals
    SearchQuery:
      properties:
        clicks:
          type: integer
          title: Clicks
          description: Clicks from Google search.
          example: 120
        impressions:
          type: integer
          title: Impressions
          description: Times the app showed in Google results.
          example: 4300
        ctr:
          type: number
          title: Ctr
          description: Clicks divided by impressions, from 0 to 1.
          example: 0.028
        position:
          type: number
          title: Position
          description: Average position in results, weighted by impressions.
          example: 14.2
        query:
          type: string
          title: Query
          description: The search query.
          example: game tracker
        is_new:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is New
          description: >-
            Whether the query had no impressions in the previous period. Left
            out when that history is too long to compare.
          example: false
      type: object
      required:
        - clicks
        - impressions
        - ctr
        - position
        - query
      title: SearchQuery
    SearchPage:
      properties:
        clicks:
          type: integer
          title: Clicks
          description: Clicks from Google search.
          example: 120
        impressions:
          type: integer
          title: Impressions
          description: Times the app showed in Google results.
          example: 4300
        ctr:
          type: number
          title: Ctr
          description: Clicks divided by impressions, from 0 to 1.
          example: 0.028
        position:
          type: number
          title: Position
          description: Average position in results, weighted by impressions.
          example: 14.2
        page:
          type: string
          title: Page
          description: URL of the page.
          example: https://pixelboxd.com/
      type: object
      required:
        - clicks
        - impressions
        - ctr
        - position
        - page
      title: SearchPage
    RankedKeyword:
      properties:
        keyword:
          type: string
          title: Keyword
          description: The keyword.
          example: video game tracker
        volume:
          anyOf:
            - type: integer
            - type: 'null'
          title: Volume
          description: Average monthly Google searches, or `null` when unknown.
          example: 2900
        difficulty:
          anyOf:
            - type: integer
            - type: 'null'
          title: Difficulty
          description: How hard it is to rank in the top 10, from 0 to 100, or `null`.
          example: 18
        intent:
          anyOf:
            - type: string
            - type: 'null'
          title: Intent
          description: >-
            Why people search it: `informational`, `navigational`, `commercial`
            or `transactional`, or `null`.
          example: commercial
        competition:
          anyOf:
            - type: string
            - type: 'null'
          title: Competition
          description: 'Advertiser competition: `low`, `medium` or `high`, or `null`.'
          example: low
        position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Position
          description: The app's position in Google for it, or `null`.
          example: 8
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: The app's page that ranks, or `null`.
          example: https://pixelboxd.com/
        etv:
          anyOf:
            - type: number
            - type: 'null'
          title: Etv
          description: Estimated monthly visits from that position, or `null`.
          example: 45.5
      type: object
      required:
        - keyword
        - volume
        - difficulty
        - intent
        - competition
        - position
        - url
        - etv
      title: RankedKeyword
    StandardError:
      properties:
        code:
          type: string
          title: Code
          description: >-
            Stable machine-readable cause of the failure. Match on this, not on
            `message`.
          example: not_found
        message:
          type: string
          title: Message
          description: Human-readable explanation. It isn't a stable contract.
          example: App not found
        details:
          additionalProperties: true
          type: object
          title: Details
          description: >-
            Structured context for the failure, or an empty object when there's
            none.
          example: {}
      type: object
      required:
        - code
        - message
      title: StandardError
  securitySchemes:
    PersonalAccessTokenAuth:
      type: http
      scheme: bearer
      description: >-
        Personal access token, sent as `Authorization: Bearer <token>`. Each
        operation lists the permission it needs: `read_only` or `full_access`. A
        full-access token can call every operation. A read-only token can call
        only the operations that list `read_only`; anything else returns 403
        `read_only_credential_route_not_allowed`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.