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

# Get Narrative Record

> One narrative as a record: its name, description, sentiment, theme and when it was first and last said, with no date range and no metric. Use it for what a narrative's page shows above its numbers; the numbers come from `POST /api/v1/projects/{project}/reports/narratives` with a `narrative` filter, so they match the report rows. Needs the Reputation capability.



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/narratives/{narrative}
openapi: 3.1.0
info:
  title: Surfacd Public API
  version: 1.0.0
  description: >-
    Public API for Surfacd. Team-scoped operations live under
    `/api/v1/team/...`; project collections live under `/api/v1/projects`;
    project-scoped operations live under `/api/v1/projects/{project}/...`. All
    endpoints require a Bearer team API key created in Team Settings. The API
    key selects the team for team-level and collection endpoints. Reports
    default to currently monitored, nondeprecated platforms. Explicit platform
    filters can include deprecated or no-longer-monitored platforms with project
    history, provided they remain enabled globally. Admin-disabled platforms are
    excluded; no eligible default platforms means no default answers. Use
    `copilot` for historical standalone Copilot data and `bing_ai_mode` for Bing
    AI Mode; these are separate platforms. Deprecated platforms are not
    available for new monitoring through `/api/v1/platforms`.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints.
  - name: Prompts
    description: Prompt management endpoints.
  - name: Team
    description: Team settings and plan details for the current team.
  - name: Reporting
    description: >-
      Read-only reporting endpoints for projects (brand rankings, mentions,
      visibility, matrix analysis, source data) and single AI answers.
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
  - name: Reputation
    description: >-
      Read-only reputation analytics for a project: sentiment overview and
      trends, themes, narratives, the AI responses behind them, and the sources
      those responses cite. Requires the Reputation capability on the project's
      team; without it these endpoints return `403`.
  - name: Reports
    description: >-
      The report query endpoint. One `POST` per report entity (`visibility`,
      `sources`, `narratives`) takes dimensions, measures, filters, an optional
      compare window and paging, and returns a dataset any renderer can draw.
      The schema and values endpoints describe what a query accepts. See the
      Reports API guide in the docs for worked examples of every app report.
  - name: Personas
    description: >-
      Project persona management endpoints. A persona is a buyer you want AI to
      recommend you to; a prompt can be asked from one persona's point of view,
      and reporting can be filtered or broken down by persona. Prompts asked
      without a persona are `no_persona` ("No persona") here and in reports, and
      the Baseline in the app. Personas are in beta and available to all teams
      with API access.
paths:
  /api/v1/projects/{project}/narratives/{narrative}:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
      - $ref: '#/components/parameters/NarrativeUuid'
    get:
      tags:
        - Reputation
      summary: Get Narrative Record
      description: >-
        One narrative as a record: its name, description, sentiment, theme and
        when it was first and last said, with no date range and no metric. Use
        it for what a narrative's page shows above its numbers; the numbers come
        from `POST /api/v1/projects/{project}/reports/narratives` with a
        `narrative` filter, so they match the report rows. Needs the Reputation
        capability.
      operationId: v1ProjectsNarrativesShow
      parameters:
        - name: brand
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Brand UUID of the project. Counts only that brand's mentions for
            `first_seen_at` and `last_seen_at`, as a report row with `brand`
            does. Without it every brand's mentions count.
      responses:
        '200':
          description: The narrative.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NarrativeFacts'
        '403':
          $ref: '#/components/responses/ReputationNotEnabled'
        '404':
          description: Narrative not found in this project.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    ProjectUuid:
      name: project
      in: path
      required: true
      description: Project UUID.
      schema:
        type: string
        format: uuid
    NarrativeUuid:
      name: narrative
      in: path
      required: true
      description: The narrative UUID.
      schema:
        type: string
        format: uuid
  schemas:
    NarrativeFacts:
      type: object
      description: >-
        A narrative as a record, whatever the date range. Its numbers come from
        `POST /api/v1/projects/{project}/reports/narratives`.
      properties:
        uuid:
          type: string
          format: uuid
        label:
          type: string
        description:
          type:
            - string
            - 'null'
          description: What answers say, or null when none is recorded.
        sentiment:
          type: string
          enum:
            - positive
            - neutral
            - negative
          description: >-
            The narrative's own sentiment, as `narrative_sentiment` on report
            rows.
        theme_uuid:
          type:
            - string
            - 'null'
          format: uuid
          description: The theme it belongs to, or null when it has none.
        theme_label:
          type:
            - string
            - 'null'
        first_seen_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When it was first said, across all time; null when never.
        last_seen_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When it was last said, across all time; null when never.
      required:
        - uuid
        - label
        - description
        - sentiment
        - theme_uuid
        - theme_label
        - first_seen_at
        - last_seen_at
    ValidationError:
      type: object
      description: Returned when one or more request parameters fail validation.
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - message
        - errors
  responses:
    ReputationNotEnabled:
      description: >-
        Reputation is not available: the team's plan does not include the
        Reputation capability, or the project has not enabled it.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    ValidationError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````

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