> ## 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 Report Filter Values

> The values one report filter field accepts for the project, so a filter can be filled without guessing: brand UUIDs with names (primary brand first), narrative and theme UUIDs, prompt UUIDs with their text, tag and topic UUIDs, platform slugs, country codes, the domains the project's answers cite (most cited first), and the fixed vocabularies (`page_type`, `category`, `brand_on_page`, `mention_sentiment`, `page_sentiment`, `narrative_sentiment`).

Put the returned `value` in the filter; `label` and `description` are for people. `search` matches the label case-insensitively (prompts, domains and narratives search in the database). `total` counts the matches before `limit`. The narrative and theme fields need the Reputation capability.



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/reports/values/{field}
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`.
  - 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.
paths:
  /api/v1/projects/{project}/reports/values/{field}:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
      - name: field
        in: path
        required: true
        description: A filter field with a value list.
        schema:
          type: string
          enum:
            - brand
            - mentions_brand
            - page_brand
            - narrative
            - carries_narrative
            - theme
            - carries_theme
            - prompt
            - topic
            - tag
            - service
            - country
            - domain
            - cites_domain
            - page_type
            - category
            - brand_on_page
            - mention_sentiment
            - page_sentiment
            - narrative_sentiment
    get:
      tags:
        - Reports
      summary: List Report Filter Values
      description: >-
        The values one report filter field accepts for the project, so a filter
        can be filled without guessing: brand UUIDs with names (primary brand
        first), narrative and theme UUIDs, prompt UUIDs with their text, tag and
        topic UUIDs, platform slugs, country codes, the domains the project's
        answers cite (most cited first), and the fixed vocabularies
        (`page_type`, `category`, `brand_on_page`, `mention_sentiment`,
        `page_sentiment`, `narrative_sentiment`).


        Put the returned `value` in the filter; `label` and `description` are
        for people. `search` matches the label case-insensitively (prompts,
        domains and narratives search in the database). `total` counts the
        matches before `limit`. The narrative and theme fields need the
        Reputation capability.
      operationId: v1ProjectsReportsValues
      parameters:
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 100
          description: Case-insensitive match on the label.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
      responses:
        '200':
          description: The field's values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportFieldValues'
              example:
                field: brand
                search: ''
                total: 25
                values:
                  - value: 4e1f77d6-35d8-4a29-9fb6-d83e51469b35
                    label: Apple
                    description: primary brand
                  - value: bb908fbe-ad42-4a75-8555-648b5298a159
                    label: Anker
                    description: null
        '403':
          $ref: '#/components/responses/ReportEntitlement'
        '404':
          description: Project not found in the current team.
          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:
    ReportFieldValues:
      type: object
      properties:
        field:
          type: string
        search:
          type: string
        total:
          type: integer
          description: Matches before `limit` was applied.
        values:
          type: array
          items:
            $ref: '#/components/schemas/ReportFieldValue'
      required:
        - field
        - search
        - total
        - values
    ReportFieldValue:
      type: object
      properties:
        value:
          type: string
          description: What to put in the filter.
        label:
          type: string
        description:
          type: string
          nullable: true
          examples:
            - primary brand
            - 2127 citations
            - negative · Pricing
      required:
        - value
        - label
        - description
    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:
    ReportEntitlement:
      description: >-
        The query reads reputation data (the `narratives` entity, or a
        `carries_narrative` / `carries_theme` filter) and the team does not have
        the Reputation capability.
      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.