> ## 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 Overview > Headline reputation KPIs for the project across the date range, with comparison values versus the equal-length previous period. ## OpenAPI ````yaml /openapi.json get /api/v1/projects/{project}/reputation/overview 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/overview: parameters: - $ref: '#/components/parameters/ProjectUuid' get: tags: - Reputation summary: Reputation Overview description: >- Headline reputation KPIs for the project across the date range, with comparison values versus the equal-length previous period. operationId: v1ProjectsReputationOverview 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[]=`. 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[]=`. 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[]=`. 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[]=`. 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`. responses: '200': description: Reputation overview KPIs. content: application/json: schema: $ref: '#/components/schemas/ReputationOverviewStats' '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: ReputationOverviewStats: type: object description: >- Headline reputation KPIs for the window. `previous_sentiment_score` is null when the prior window had no data; narrative counts always carry a previous (zero when empty). properties: sentiment_score: type: integer description: >- Net Sentiment Index across all narrative mentions in the window (0-100). previous_sentiment_score: type: - integer - 'null' active_narratives: type: integer description: Number of narratives mentioned in the window. previous_active_narratives: type: integer required: - sentiment_score - previous_sentiment_score - active_narratives - previous_active_narratives 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. ````