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

# Reputation Sources (Domains)

> Paginated list of domains cited by the AI responses behind a narrative, theme, or brand, across the date range.



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/reputation/sources/domains
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/sources/domains:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
    get:
      tags:
        - Reputation
      summary: Reputation Sources (Domains)
      description: >-
        Paginated list of domains cited by the AI responses behind a narrative,
        theme, or brand, across the date range.
      operationId: v1ProjectsReputationSourcesDomains
      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: scope_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - narrative
              - theme
              - brand
          description: >-
            The entity the source rollup is scoped to: a narrative, a theme, or
            a brand (every response that mentions the brand).
        - name: scope_uuid
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: The UUID of the narrative, theme, or brand named by `scope_type`.
        - name: categories
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/DomainCategory'
          description: >-
            Domain category filters. Repeat as `categories[]=<category>`.
            Discover values with `GET /api/v1/domain-categories`.
          style: form
          explode: true
        - name: search_term
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Free-text filter over the listed sources.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Results per page, 1-100. Defaults to 20.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Page number. Defaults to 1.
      responses:
        '200':
          description: Paginated domain sources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDomainSource'
        '403':
          $ref: '#/components/responses/ReputationNotEnabled'
        '404':
          description: The scoped narrative, theme, or brand was 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
  schemas:
    DomainCategory:
      type: string
      enum:
        - ugc
        - editorial
        - corporate
        - reference
        - academic
        - analyst
        - institutional
        - other
    PaginatedDomainSource:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DomainSource'
        links:
          $ref: '#/components/schemas/PaginationLinks'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - data
        - meta
    DomainSource:
      type: object
      properties:
        domain:
          type: string
        citations_count:
          type: integer
        avg_rank:
          type: number
          format: float
        rank:
          type: integer
        category:
          oneOf:
            - $ref: '#/components/schemas/DomainCategory'
            - type: 'null'
        category_label:
          type:
            - string
            - 'null'
        previous_rank:
          type:
            - integer
            - 'null'
        previous_citations_count:
          type:
            - integer
            - 'null'
        total_responses:
          type: integer
        response_count:
          type: integer
        response_percentage:
          type: number
          format: float
        brand_coverage:
          oneOf:
            - $ref: '#/components/schemas/SourceBrandCoverage'
            - type: 'null'
          description: >-
            Brand coverage for this source; null when no cited page has been
            analysed yet.
      required:
        - domain
        - citations_count
        - avg_rank
        - rank
        - total_responses
        - response_count
        - response_percentage
        - brand_coverage
    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
    SourceBrandCoverage:
      type: object
      description: >-
        On-page brand coverage for a source, derived from analysed cited pages.
        Null on a source means none of its cited pages have been analysed yet.
      properties:
        mine_present:
          type: boolean
          description: Whether the primary brand is mentioned on any analysed page.
        mine_sentiment:
          type:
            - string
            - 'null'
          enum:
            - positive
            - negative
            - neutral
            - null
          description: >-
            Sentiment of the primary brand mention. Only set on URL-level
            sources.
        competitor_count:
          type: integer
          description: Distinct competitor brands mentioned across the analysed pages.
        analysed_pages:
          type: integer
          description: Cited pages that have been analysed for brand mentions.
        mine_pages:
          type: integer
          description: Analysed pages mentioning the primary brand.
        is_gap:
          type: boolean
          description: >-
            Competitors are present and the primary brand is absent across the
            analysed pages.
        mentioned_brands:
          type: array
          items:
            $ref: '#/components/schemas/MentionedBrand'
          description: >-
            Up to five mentioned brand identities for display; the full count is
            available via competitor_count and mine_present.
      required:
        - mine_present
        - mine_sentiment
        - competitor_count
        - analysed_pages
        - mine_pages
        - is_gap
        - mentioned_brands
    PaginationMetaLink:
      type: object
      properties:
        url:
          type:
            - string
            - 'null'
        label:
          type: string
        active:
          type: boolean
      required:
        - url
        - label
        - active
    MentionedBrand:
      type: object
      description: >-
        A brand mentioned on a source's analysed pages, ordered with the primary
        brand first, then competitors by how many analysed pages they appear on.
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        domain:
          type:
            - string
            - 'null'
      required:
        - uuid
        - name
        - domain
  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.

````