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

# Export keyword search results as XLSX



## OpenAPI

````yaml /api-reference/openapi.json get /v1/search/keywords/export
openapi: 3.0.0
info:
  title: Amazonomics API
  version: 0.0.1
  description: The Amazonomics REST API. All endpoints need an API key.
servers:
  - url: https://api.amazonomics.com
security:
  - bearerAuth: []
paths:
  /v1/search/keywords/export:
    get:
      tags:
        - Search
      summary: Export keyword search results as XLSX
      parameters:
        - schema:
            anyOf:
              - type: string
                minLength: 1
              - type: array
                items:
                  type: string
                  minLength: 1
                minItems: 1
            description: Search query - one or more keywords to search for
            example: laptop
          required: true
          description: Search query - one or more keywords to search for
          name: query
          in: query
        - schema:
            type: string
            enum:
              - exact
              - similar
            description: Search method to use
            example: similar
          required: false
          description: Search method to use
          name: method
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: >-
              Negative keyword query to exclude from similar/full-text keyword
              searches. Ignored for exact searches.
            example: decaf
          required: false
          description: >-
            Negative keyword query to exclude from similar/full-text keyword
            searches. Ignored for exact searches.
          name: exclude_query
          in: query
        - schema:
            type: string
            enum:
              - weekly
              - monthly
            description: Data frequency type
            example: monthly
          required: false
          description: Data frequency type
          name: type
          in: query
        - schema:
            type: integer
            minimum: 1
            description: Page number for pagination
            example: 1
          required: false
          description: Page number for pagination
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 1000
            description: Number of results per page (max 1000)
            example: 50
          required: false
          description: Number of results per page (max 1000)
          name: limit
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: Filter by brand name(s)
          required: false
          description: Filter by brand name(s)
          name: brand
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: Filter by product ASIN(s)
          required: false
          description: Filter by product ASIN(s)
          name: product
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: >-
              Filter by friendly category bucket name(s). Known stored category
              names are also accepted; unmatched values are treated as Other.
          required: false
          description: >-
            Filter by friendly category bucket name(s). Known stored category
            names are also accepted; unmatched values are treated as Other.
          name: category
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - latest_period
                  - latest_rank
                  - best_rank
                  - worst_rank
                  - avg_rank
                  - total_periods
                  - fts_rank
                  - similarity_score
                  - best_match
              - type: string
                pattern: ^[0-9]{1,3}-[0-9]{4}$
            description: Field to sort results by, or a period (MM-YYYY/WW-YYYY)
            example: latest_period
          required: false
          description: Field to sort results by, or a period (MM-YYYY/WW-YYYY)
          name: order_by
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
              - ASC
              - DESC
            description: Sort direction
            example: DESC
          required: false
          description: Sort direction
          name: order_direction
          in: query
        - schema:
            anyOf:
              - type: boolean
              - type: string
                enum:
                  - 'true'
              - type: string
                enum:
                  - 'false'
            description: Exclude results with null values in the latest period
            example: false
          required: false
          description: Exclude results with null values in the latest period
          name: exclude_nulls
          in: query
        - schema:
            type: string
            enum:
              - raw
              - delta
              - percentage
            description: Value format for period columns in exports
            example: raw
          required: false
          description: Value format for period columns in exports
          name: format
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            maximum: 50
            description: >-
              Percentage threshold for color coding (0-50). Changes below this
              threshold show as neutral.
            example: 20
          required: false
          description: >-
            Percentage threshold for color coding (0-50). Changes below this
            threshold show as neutral.
          name: color_threshold
          in: query
      responses:
        '200':
          description: Keyword search export generated.
          content:
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
        '400':
          description: Invalid parameters.
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````