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

# Search Queries

> Get the search queries driving traffic to your site, sorted by clicks.

Get the search queries driving traffic to your site, sorted by clicks.

Shared parameters and response fields are described on [Google Search Traffic](https://snowseo.com/docs/api-reference/endpoints/gsc-traffic.md).


## OpenAPI

````yaml GET /v3/integrations/gsc/website-traffic/search-queries
openapi: 3.0.0
info:
  title: SnowSEO API
  description: API documentation for SnowSEO
  version: 1.0.0
servers:
  - url: https://api.snowseo.com
    description: Production server
security:
  - bearerAuth: []
  - apiKey: []
externalDocs:
  url: https://snowseo.com/docs
  description: Find more info here
paths:
  /v3/integrations/gsc/website-traffic/search-queries:
    get:
      tags:
        - Google Search Console
      summary: Get Search Console search queries
      description: >-
        Returns search queries with server-side pagination, search, tab and
        position-band filters, sorting and period changes. pageSize defaults to
        50; use all for an explicit full export. summary describes the complete
        date window independently of table filters. coverage reports the window
        served by Google.
      operationId: getGscSearchQueries
      parameters:
        - schema:
            type: string
          in: query
          name: teamId
          required: true
          description: Team ID
        - schema:
            type: integer
            minimum: 1
            default: 30
          in: query
          name: days
          required: false
          description: >-
            Days back from today on the team's calendar, converted to
            startDate/endDate. Ignored when startDate or endDate is set.
            Defaults to 30.
        - schema:
            type: string
          in: query
          name: startDate
          required: false
          description: Start date (YYYY-MM-DD)
        - schema:
            type: string
          in: query
          name: endDate
          required: false
          description: End date (YYYY-MM-DD)
        - schema:
            type: string
          in: query
          name: country
          required: false
          description: Country filter
        - schema:
            type: string
          in: query
          name: device
          required: false
          description: Device filter
        - schema:
            type: string
          in: query
          name: type
          required: false
          description: Search appearance/type filter
        - schema:
            type: string
          in: query
          name: limit
          required: false
          description: Maximum rows to return
        - schema:
            type: string
          in: query
          name: includePages
          required: false
          description: >-
            Embed each row's ranking page URLs and their metrics inside the row
            (multiplies the payload by the number of URLs per row). Defaults to
            false; the `pages` count is always returned.
        - schema:
            type: integer
          in: query
          name: page
          required: false
          description: 1-based page. Default 1.
        - schema:
            type: string
          in: query
          name: pageSize
          required: false
          description: >-
            Rows per page (max 1000), or 'all'. Every response reports total and
            totalPages.
        - schema:
            type: string
          in: query
          name: search
          required: false
        - schema:
            type: string
            enum:
              - query
              - clicks
              - impressions
              - ctr
              - position
              - pages
              - clicksChange
              - impressionsChange
              - ctrChange
              - positionChange
          in: query
          name: sortBy
          required: false
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortDir
          required: false
        - schema:
            type: string
            enum:
              - Top
              - Growing
              - Decaying
              - Long Tail
              - Questions
          in: query
          name: tab
          required: false
        - schema:
            type: string
            enum:
              - top3
              - 4-10
              - 11-20
              - 21-49
              - 50-100
              - 100+
          in: query
          name: positionBand
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                      properties:
                        query:
                          type: string
                        pages:
                          type: number
                        rankedPages:
                          type: array
                          items:
                            type: object
                            additionalProperties: true
                        clicks:
                          type: number
                        impressions:
                          type: number
                        ctr:
                          type: number
                        position:
                          type: number
                        clicksChange:
                          type: number
                        impressionsChange:
                          type: number
                        ctrChange:
                          type: number
                        positionChange:
                          type: number
                  total:
                    type: number
                  returned:
                    type: number
                  summary:
                    type: object
                    additionalProperties: true
                    properties:
                      previousTotal:
                        type: number
                      isCapped:
                        type: boolean
                      previousIsCapped:
                        type: boolean
                      top3:
                        type: number
                      range4to10:
                        type: number
                      range11to20:
                        type: number
                      range21to49:
                        type: number
                      range50to100:
                        type: number
                      range100plus:
                        type: number
                  coverage:
                    type: object
                    additionalProperties: true
                    properties:
                      startDate:
                        type: string
                      endDate:
                        type: string
                      latestAvailableDate:
                        type: string
                        nullable: true
                      firstProvisionalDate:
                        type: string
                        nullable: true
                      includesProvisional:
                        type: boolean
                      isEstimated:
                        type: boolean
                      timeZone:
                        type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your SnowSEO API key (sk_...).
    apiKey:
      type: apiKey
      name: x-api-key
      in: header

````

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