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

# List Radar topics with trend direction, size, and priority

> Returns the product's Radar scope topics (the top `scopeTopicLimit` topics by relevance, as on the scope chart): trend direction (rising, steady, cooling), 30-day mentions (the bubble size on the scope chart), 7-day change, relevance, priority quadrant (act_now, watch, keep_covered, park), and suggested prompts. Requires Radar (Enterprise).



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/radar/scope/topics
openapi: 3.1.0
info:
  title: The Prompting Company API
  version: 0.1.0
  description: >-
    Machine-readable contract for The Prompting Company organization-scoped API
    routes.
  contact:
    name: The Prompting Company
    url: https://promptingcompany.com/support
    email: support@promptingcompany.com
  license:
    name: Proprietary
    url: https://promptingcompany.com/terms
  termsOfService: https://promptingcompany.com/terms
servers:
  - url: https://app.promptingco.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Visibility & Mentions
  - name: Knowledge
  - name: Content
  - name: Simulations
  - name: Apps & Publishing
  - name: Products
  - name: Service Status
  - name: Account
paths:
  /api/v1/radar/scope/topics:
    get:
      tags:
        - Visibility & Mentions
      summary: List Radar topics with trend direction, size, and priority
      description: >-
        Returns the product's Radar scope topics (the top `scopeTopicLimit`
        topics by relevance, as on the scope chart): trend direction (rising,
        steady, cooling), 30-day mentions (the bubble size on the scope chart),
        7-day change, relevance, priority quadrant (act_now, watch,
        keep_covered, park), and suggested prompts. Requires Radar (Enterprise).
      operationId: getRadarScopeTopics
      parameters:
        - schema:
            type: string
            minLength: 1
          required: true
          name: productId
          in: query
        - schema:
            type: string
            description: >-
              Comma-separated trend directions to keep: rising, steady, cooling,
              none.
          required: false
          description: >-
            Comma-separated trend directions to keep: rising, steady, cooling,
            none.
          name: direction
          in: query
        - schema:
            type: string
            description: >-
              Comma-separated priority quadrants to keep: act_now, watch,
              keep_covered, park.
          required: false
          description: >-
            Comma-separated priority quadrants to keep: act_now, watch,
            keep_covered, park.
          name: priority
          in: query
        - schema:
            type: string
            enum:
              - relevance
              - mentions
              - change
            description: >-
              relevance (default, the scope rank), mentions (30-day mentions,
              the bubble size), or change (7-day change).
          required: false
          description: >-
            relevance (default, the scope rank), mentions (30-day mentions, the
            bubble size), or change (7-day change).
          name: sort
          in: query
        - schema:
            type: integer
            exclusiveMinimum: 0
            description: >-
              Return at most this many topics after filtering and sorting.
              Results come from the Radar scope set, so at most
              `scopeTopicLimit` topics are returned.
          required: false
          description: >-
            Return at most this many topics after filtering and sorting. Results
            come from the Radar scope set, so at most `scopeTopicLimit` topics
            are returned.
          name: limit
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      productId:
                        type: string
                      capturedAt:
                        type:
                          - string
                          - 'null'
                      totalTopics:
                        type: integer
                        minimum: 0
                        description: >-
                          Every eligible Radar topic for the product, including
                          those beyond the scope set.
                      scopeTopicLimit:
                        type: integer
                        exclusiveMinimum: 0
                        description: >-
                          How many topics, ranked by relevance, make up the
                          Radar scope set that this route filters and sorts.
                      latestRun:
                        type:
                          - object
                          - 'null'
                        properties:
                          status:
                            type: string
                            enum:
                              - queued
                              - running
                              - completed
                              - failed
                          topicCount:
                            type: integer
                            minimum: 0
                        required:
                          - status
                          - topicCount
                      topics:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            number:
                              type: integer
                            name:
                              type: string
                            direction:
                              type: string
                              enum:
                                - rising
                                - steady
                                - cooling
                                - none
                            trendStatus:
                              type:
                                - string
                                - 'null'
                              enum:
                                - emerging
                                - growing
                                - peaking
                                - declining
                                - stable
                                - null
                            change7d:
                              type:
                                - number
                                - 'null'
                            mentions30d:
                              type: number
                            relevanceScore:
                              type:
                                - number
                                - 'null'
                            ring:
                              type: string
                              enum:
                                - core
                                - close
                                - adjacent
                                - edge
                                - unscored
                            priority:
                              type:
                                - string
                                - 'null'
                              enum:
                                - act_now
                                - watch
                                - keep_covered
                                - park
                                - null
                            group:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: string
                                label:
                                  type: string
                              required:
                                - id
                                - label
                            summary:
                              type:
                                - string
                                - 'null'
                            suggestedPrompts:
                              type: array
                              items:
                                type: object
                                properties:
                                  message:
                                    type: string
                                  tracked:
                                    type: boolean
                                required:
                                  - message
                                  - tracked
                          required:
                            - id
                            - number
                            - name
                            - direction
                            - trendStatus
                            - change7d
                            - mentions30d
                            - relevanceScore
                            - ring
                            - priority
                            - group
                            - summary
                            - suggestedPrompts
                    required:
                      - productId
                      - capturedAt
                      - totalTopics
                      - scopeTopicLimit
                      - latestRun
                      - topics
                required:
                  - ok
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
      security:
        - apiKeyAuth: []
        - bearerAuth: []
        - cookieAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization-scoped API key. Available scopes:

        - content:read: Read site pages, markdown content, and llms.txt files

        - content:write: Create, update, and delete site pages and content

        - prompts:read: Read prompts, topics, Radar topics, prompt suggestions,
        and prompt analysis results

        - prompts:write: Create, update, archive prompts and generate, edit, or
        review prompt suggestions

        - simulations:read: Read agent-simulation tasks, runs, environments, and
        analytics

        - simulations:write: Create and trigger simulation runs

        - logs:read: Read AI-traffic logs and request-level audit events

        - analytics:read: Read analytics aggregates (rankings, mentions,
        sources, SOV)

        - analytics:write: Write events to analytics

        - products:read: Read product metadata and competitor data

        - products:write: Update product settings and competitor lists
      x-scopes:
        content:read: Read site pages, markdown content, and llms.txt files
        content:write: Create, update, and delete site pages and content
        prompts:read: >-
          Read prompts, topics, Radar topics, prompt suggestions, and prompt
          analysis results
        prompts:write: >-
          Create, update, archive prompts and generate, edit, or review prompt
          suggestions
        simulations:read: Read agent-simulation tasks, runs, environments, and analytics
        simulations:write: Create and trigger simulation runs
        logs:read: Read AI-traffic logs and request-level audit events
        analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
        analytics:write: Write events to analytics
        products:read: Read product metadata and competitor data
        products:write: Update product settings and competitor lists
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer session or OAuth access token. Available OAuth scopes:

        - content:read: Read site pages, markdown content, and llms.txt files

        - content:write: Create, update, and delete site pages and content

        - prompts:read: Read prompts, topics, Radar topics, prompt suggestions,
        and prompt analysis results

        - prompts:write: Create, update, archive prompts and generate, edit, or
        review prompt suggestions

        - simulations:read: Read agent-simulation tasks, runs, environments, and
        analytics

        - simulations:write: Create and trigger simulation runs

        - logs:read: Read AI-traffic logs and request-level audit events

        - analytics:read: Read analytics aggregates (rankings, mentions,
        sources, SOV)

        - analytics:write: Write events to analytics

        - products:read: Read product metadata and competitor data

        - products:write: Update product settings and competitor lists
      x-scopes:
        content:read: Read site pages, markdown content, and llms.txt files
        content:write: Create, update, and delete site pages and content
        prompts:read: >-
          Read prompts, topics, Radar topics, prompt suggestions, and prompt
          analysis results
        prompts:write: >-
          Create, update, archive prompts and generate, edit, or review prompt
          suggestions
        simulations:read: Read agent-simulation tasks, runs, environments, and analytics
        simulations:write: Create and trigger simulation runs
        logs:read: Read AI-traffic logs and request-level audit events
        analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
        analytics:write: Write events to analytics
        products:read: Read product metadata and competitor data
        products:write: Update product settings and competitor lists
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: First-party browser session cookie.

````

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