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

# Get Prompt Research campaign

> Returns a Prompt Research campaign together with its analyzed run results.



## OpenAPI

````yaml /api-reference/openapi.json get /prompt-research/campaigns/{id}
openapi: 3.1.0
info:
  title: Keupera Public API
  version: 1.0.0
  description: >-
    Programmatic access to every major Keupera module — Keyword Research,
    Backlinks, Content, AI Visibility, and Analytics.


    All endpoints are served under `https://app.keupera.com/api/v1` and
    authenticated with a Bearer API key. Responses are JSON and follow a
    consistent `{ "data": ... }` envelope, with list endpoints adding a `meta`
    object for pagination.
  contact:
    name: Keupera Support
    email: ask@support.keupera.com
    url: https://keupera.com
  x-logo:
    url: /logo/light.svg
servers:
  - url: https://app.keupera.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Keywords
    description: >-
      Research, enrich, and manage keywords and keyword groups. List, add,
      delete, star, bulk-update status, trigger AI keyword research jobs, and
      organize keywords into groups.
  - name: Backlinks
    description: >-
      Run backlink research campaigns, manage the opportunities discovered for
      each campaign, and generate or send personalized outreach emails.
  - name: Content
    description: >-
      Plan, generate, update, and publish AI-written articles across the full
      content pipeline, and configure per-website content automation.
  - name: AI Visibility
    description: >-
      Track how your brand and competitors appear across LLM answers via Brand
      Radar campaigns, the Prompt Research Engine, and a consolidated visibility
      score.
  - name: Analytics
    description: >-
      Query website traffic, cached Google Search Console data, and AI bot crawl
      activity for a website.
  - name: Account & Utilities
    description: >-
      Verify credentials, connect CMS integrations, and reference internal
      endpoints.
paths:
  /prompt-research/campaigns/{id}:
    get:
      tags:
        - AI Visibility
      summary: Get Prompt Research campaign
      description: >-
        Returns a Prompt Research campaign together with its analyzed run
        results.
      operationId: getPromptResearchCampaign
      parameters:
        - $ref: '#/components/parameters/PathId'
      responses:
        '200':
          description: Campaign detail and results.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      campaign:
                        $ref: '#/components/schemas/PromptResearchCampaign'
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            campaign_id:
                              type: string
                              format: uuid
                            run_at:
                              type: string
                              format: date-time
                            analyzed_data:
                              type: object
                              additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    PathId:
      name: id
      in: path
      required: true
      description: Resource ID.
      schema:
        type: string
        format: uuid
  schemas:
    PromptResearchCampaign:
      type: object
      properties:
        id:
          type: string
          format: uuid
        custom_prompt:
          type: string
          example: What are the best SEO tools?
        frequency:
          type: integer
          example: 7
        languages:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - active
            - paused
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      description: Standard error envelope.
      properties:
        error:
          type: string
          description: Descriptive error message.
  responses:
    Unauthorized:
      description: Unauthorized — missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or missing API key
    NotFound:
      description: Not found — resource does not exist or is not accessible with this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Resource not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your Keupera API key as a Bearer token: `Authorization: Bearer
        YOUR_KEUPERA_API_KEY`. Generate keys from **Account → API Keys** in your
        Keupera dashboard.

````