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

# A research job's keywords, paged

> Searched by keyword, in the order the job stored them. `meta.summary` is of every result, whatever the page or search: how many, the average volume, difficulty and CPC, and whether the rows carry a ranking position.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/projects/{projectId}/keywords/research/{jobId}/results
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/projects/{projectId}/keywords/research/{jobId}/results:
    get:
      tags:
        - keywords
      summary: A research job's keywords, paged
      description: >-
        Searched by keyword, in the order the job stored them. `meta.summary` is
        of every result, whatever the page or search: how many, the average
        volume, difficulty and CPC, and whether the rows carry a ranking
        position.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: jobId
          in: path
        - schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          required: false
          name: per_page
          in: query
        - schema:
            type: string
            maxLength: 200
          required: false
          name: search
          in: query
      responses:
        '200':
          description: One page of keywords
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        keyword:
                          type: string
                        search_volume:
                          type: integer
                          nullable: true
                        keyword_difficulty:
                          type: number
                          nullable: true
                        cpc:
                          type: number
                          nullable: true
                        competition:
                          type: number
                          nullable: true
                        competition_index:
                          type: number
                          nullable: true
                        competition_level:
                          type: string
                          nullable: true
                        low_top_of_page_bid:
                          type: number
                          nullable: true
                        high_top_of_page_bid:
                          type: number
                          nullable: true
                        location_code:
                          type: integer
                          nullable: true
                        language_code:
                          type: string
                          nullable: true
                        search_intent:
                          type: string
                          nullable: true
                        trend:
                          type: array
                          nullable: true
                          items:
                            type: object
                            properties:
                              year:
                                type: integer
                              month:
                                type: integer
                              search_volume:
                                type: integer
                                nullable: true
                            required:
                              - year
                              - month
                              - search_volume
                      required:
                        - keyword
                        - search_volume
                        - keyword_difficulty
                        - cpc
                        - competition
                        - competition_index
                        - competition_level
                        - low_top_of_page_bid
                        - high_top_of_page_bid
                        - location_code
                        - language_code
                        - search_intent
                        - trend
                      additionalProperties:
                        nullable: true
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
                        minimum: 1
                      per_page:
                        type: integer
                        minimum: 1
                        maximum: 500
                      total:
                        type: integer
                        minimum: 0
                      summary:
                        type: object
                        properties:
                          count:
                            type: integer
                          avg_search_volume:
                            type: number
                          avg_keyword_difficulty:
                            type: number
                          avg_cpc:
                            type: number
                          ranking:
                            type: boolean
                        required:
                          - count
                          - avg_search_volume
                          - avg_keyword_difficulty
                          - avg_cpc
                          - ranking
                    required:
                      - page
                      - per_page
                      - total
                      - summary
                required:
                  - success
                  - data
                  - meta

````

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