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

# List Pages

> Every page in the brand's inventory with its search performance.

Get every page in the brand's inventory merged with its Search Console clicks, impressions, CTR, average position and keyword count for the selected window. Pages with no search traffic are included so they stay findable.

Rows carry `visitors` and `visitorsChange` only when `analyticsProvider` names the brand's connected analytics integration (`ga`, `posthog`, `plausible` or `snow`). Sorting by `visitors` or `visitorsChange` without it returns `400`.


## OpenAPI

````yaml GET /v3/pages/list
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/pages/list:
    get:
      tags:
        - Pages
      summary: List pages with their search performance
      description: >-
        Returns every page in the team inventory merged with its Search Console
        clicks, impressions, CTR, average position and keyword count for the
        selected window. Pages with no search traffic are included so they stay
        findable.
      operationId: listPages
      parameters:
        - schema:
            type: string
          in: query
          name: teamId
          required: false
          description: Team ID
        - schema:
            type: string
          in: query
          name: startDate
          required: false
          description: Start date (YYYY-MM-DD on the team's calendar).
        - schema:
            type: string
          in: query
          name: endDate
          required: false
          description: >-
            End date (YYYY-MM-DD on the team's calendar). A start with no end
            runs to today; an end with no start means All Time.
        - 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: country
          required: false
          description: ISO-3 country code to filter Search Console rows by.
        - schema:
            type: string
          in: query
          name: device
          required: false
          description: 'Device filter: desktop, mobile or tablet.'
        - schema:
            type: string
          in: query
          name: type
          required: false
          description: 'Search type: web, image, video or news.'
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Filter to pages whose URL or title contains this text.
        - schema:
            anyOf:
              - type: integer
                minimum: 1
                maximum: 5000
              - type: string
                enum:
                  - all
          in: query
          name: limit
          required: false
          description: Page size, or all for explicit bulk selection resolution.
        - schema:
            type: string
            enum:
              - ga
              - posthog
              - plausible
              - snow
          in: query
          name: analyticsProvider
          required: false
          description: >-
            Connected analytics integration to read page visitors from: ga
            (Google Analytics), posthog, plausible or snow (Snow Analytics).
            Without it, rows carry no visitor counts, and sorting by visitors
            returns 400.
        - schema:
            type: integer
          in: query
          name: offset
          required: false
          description: Rows to skip.
        - schema:
            type: string
            enum:
              - clicks
              - impressions
              - ctr
              - position
              - keywords
              - url
              - auditScore
              - aiCitations
              - clicksChange
              - keywordsChange
              - positionChange
              - visitors
              - visitorsChange
          in: query
          name: sortKey
          required: false
          description: Column to sort on. Defaults to clicks.
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortDir
          required: false
          description: Sort direction. Defaults to desc.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                  - total
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      required:
                        - url
                        - path
                      properties:
                        url:
                          type: string
                        path:
                          type: string
                        title:
                          type: string
                          nullable: true
                        statusCode:
                          type: integer
                          nullable: true
                        clicks:
                          type: number
                        impressions:
                          type: number
                        ctr:
                          type: number
                        position:
                          type: number
                        keywords:
                          type: integer
                        keywordsChange:
                          type: number
                        clicksChange:
                          type: number
                        impressionsChange:
                          type: number
                        ctrChange:
                          type: number
                        positionChange:
                          type: number
                        auditScore:
                          type: integer
                          nullable: true
                        indexVerdict:
                          type: string
                          nullable: true
                        aiCitations:
                          type: integer
                        visitors:
                          type: number
                        visitorsChange:
                          type: number
                          nullable: true
                  total:
                    type: integer
                  connected:
                    type: boolean
                  startDate:
                    type: string
                    nullable: true
                  endDate:
                    type: string
                    nullable: true
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.