> ## 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.

# List Narratives

> Paginated list of reputation narratives (recurring storylines) for the project across the date range.



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/reputation/narratives
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.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints. Reads only in this version.
  - name: Prompts
    description: Prompt management endpoints. Reads only in this version.
  - 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).
  - 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`.
paths:
  /api/v1/projects/{project}/reputation/narratives:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
    get:
      tags:
        - Reputation
      summary: List Narratives
      description: >-
        Paginated list of reputation narratives (recurring storylines) for the
        project across the date range.
      operationId: v1ProjectsReputationNarrativesIndex
      parameters:
        - name: start_date
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: true
          schema:
            type: string
            format: date
          description: Must be on or after `start_date`.
        - name: tags
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Tag UUID or name filters. Repeat as `tags[]=<uuid-or-name>`.
            Discover tags with `GET /api/v1/projects/{project}/tags`.
          style: form
          explode: true
        - name: services
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            AI platform provider filters such as `chatgpt` or `perplexity`.
            Repeat as `services[]=<provider>`. Discover providers with `GET
            /api/v1/platforms`.
          style: form
          explode: true
        - name: countries
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Country code filters such as `US` or `GB`. Repeat as
            `countries[]=<code>`. Discover codes with `GET /api/v1/countries`.
          style: form
          explode: true
        - name: topics
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Topic UUID or name filters. Use `no_topic` for prompts without a
            topic. Repeat as `topics[]=<uuid-or-name>`. Discover topics with
            `GET /api/v1/projects/{project}/topics`.
          style: form
          explode: true
        - name: prompt
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Prompt UUID filter.
        - name: brand
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Brand UUID to scope the reputation data to. Must belong to the
            project. Defaults to the project's primary brand; when the project
            has no primary brand an explicit `brand` is required. Discover brand
            UUIDs with `GET /api/v1/projects/{project}/brands`.
        - name: sentiments
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BrandSentiment'
          description: Sentiment filters. Repeat as `sentiments[]=<sentiment>`.
        - name: trajectory
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - emerging
                - surging
                - steady
                - cooling
                - dormant
                - rising
                - fading
                - active
          description: >-
            Momentum filters: one or more bands (`emerging`, `surging`,
            `steady`, `cooling`, `dormant`) or named groups — `rising` (surging
            or emerging), `fading` (cooling or dormant), `active` (anything not
            fading). Repeat as `trajectory[]=<band>`; a single
            `trajectory=<band>` is also accepted.
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - mentions
              - recent
              - sentiment
              - first_seen
              - movement
          description: >-
            Sort order. Defaults to `mentions`. `movement` sorts by the change
            in response share versus the previous period.
        - name: theme_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Theme UUID filters. Repeat as `theme_ids[]=<uuid>`.
          style: form
          explode: true
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: Free-text search over narrative labels and descriptions.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Results per page, 1-100. Defaults to 10.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Page number. Defaults to 1.
      responses:
        '200':
          description: Paginated narratives.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginated_NarrativeSummary'
        '403':
          $ref: '#/components/responses/ReputationNotEnabled'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    ProjectUuid:
      name: project
      in: path
      required: true
      description: Project UUID.
      schema:
        type: string
        format: uuid
  schemas:
    BrandSentiment:
      type: string
      enum:
        - positive
        - negative
        - neutral
      description: The sentiment valence of a mention or narrative.
    Paginated_NarrativeSummary:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NarrativeSummary'
        links:
          $ref: '#/components/schemas/PaginationLinks'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - data
        - meta
    NarrativeSummary:
      type: object
      description: >-
        A narrative (a recurring storyline) with its windowed metrics.
        `response_share` is the share of in-scope responses that mention the
        narrative.
      properties:
        uuid:
          type: string
          format: uuid
        label:
          type: string
        description:
          type:
            - string
            - 'null'
        sentiment:
          $ref: '#/components/schemas/BrandSentiment'
          description: Overall sentiment of the narrative across the window.
        response_share:
          type: number
          format: float
        first_seen_at:
          type:
            - string
            - 'null'
          format: date-time
        last_seen_at:
          type:
            - string
            - 'null'
          format: date-time
        sparkline:
          type: array
          items:
            $ref: '#/components/schemas/NarrativeSparklinePoint'
        theme:
          oneOf:
            - $ref: '#/components/schemas/ReputationThemeChip'
            - type: 'null'
        services:
          type: array
          items:
            $ref: '#/components/schemas/ReputationServiceChip'
        previous_response_share:
          type:
            - number
            - 'null'
          format: float
        momentum:
          oneOf:
            - $ref: '#/components/schemas/ReputationTrajectory'
            - type: 'null'
      required:
        - uuid
        - label
        - description
        - sentiment
        - response_share
        - first_seen_at
        - last_seen_at
        - sparkline
        - theme
        - services
        - previous_response_share
        - momentum
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
      required:
        - first
        - last
        - prev
        - next
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/PaginationMetaLink'
        path:
          type:
            - string
            - 'null'
        per_page:
          type: integer
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
      required:
        - current_page
        - last_page
        - per_page
        - total
    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
    NarrativeSparklinePoint:
      type: object
      description: >-
        One day of mention volume, split by sentiment, for an entity's
        sparkline.
      properties:
        date:
          type: string
          format: date-time
        count:
          type: integer
        positive_count:
          type: integer
        negative_count:
          type: integer
        neutral_count:
          type: integer
      required:
        - date
        - count
        - positive_count
        - negative_count
        - neutral_count
    ReputationThemeChip:
      type: object
      description: A compact theme reference (the parent theme of a narrative).
      properties:
        uuid:
          type: string
          format: uuid
        label:
          type: string
      required:
        - uuid
        - label
    ReputationServiceChip:
      type: object
      description: A compact AI platform reference attached to a reputation entity.
      properties:
        name:
          type: string
        display_name:
          type: string
      required:
        - name
        - display_name
    ReputationTrajectory:
      type: string
      enum:
        - emerging
        - surging
        - steady
        - cooling
        - dormant
      description: >-
        The volume-axis momentum of a reputation entity over the active window
        versus the equal-length previous window.
    PaginationMetaLink:
      type: object
      properties:
        url:
          type:
            - string
            - 'null'
        label:
          type: string
        active:
          type: boolean
      required:
        - url
        - label
        - active
  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.

````