> ## Documentation Index > Fetch the complete documentation index at: https://docs.promptingcompany.com/llms.txt > Use this file to discover all available pages before exploring further. # Get per-prompt sentiment analytics for a product ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/analytics/sentiment openapi: 3.1.0 info: title: The Prompting Company API version: 0.1.0 description: >- Machine-readable contract for The Prompting Company organization-scoped API routes. contact: name: The Prompting Company url: https://promptingcompany.com/support email: support@promptingcompany.com license: name: Proprietary url: https://promptingcompany.com/terms termsOfService: https://promptingcompany.com/terms servers: - url: https://app.promptingco.com description: Production - url: http://localhost:3000 description: Local development security: [] tags: - name: Visibility & Mentions - name: Knowledge - name: Content - name: Simulations - name: Apps & Publishing - name: Products - name: Service Status paths: /api/v1/analytics/sentiment: get: tags: - Visibility & Mentions summary: Get per-prompt sentiment analytics for a product operationId: getAnalyticsSentiment parameters: - schema: type: string minLength: 1 description: Product ID to use as the primary sentiment scope. required: true description: Product ID to use as the primary sentiment scope. name: productId in: query - schema: type: string enum: - prompt default: prompt required: false name: by in: query - schema: type: string minLength: 1 description: View ID to scope results to prompts assigned to the view. required: false description: View ID to scope results to prompts assigned to the view. name: viewId in: query - schema: type: string minLength: 1 description: Prompt ID. Returns a daily sentiment time series for one prompt. required: false description: Prompt ID. Returns a daily sentiment time series for one prompt. name: promptId in: query - schema: type: string minLength: 1 description: Topic ID to filter per-prompt sentiment rows. required: false description: Topic ID to filter per-prompt sentiment rows. name: topicId in: query - schema: type: string description: Start of date window, formatted as YYYY-MM-DD. required: false description: Start of date window, formatted as YYYY-MM-DD. name: start in: query - schema: type: string description: End of date window, formatted as YYYY-MM-DD. required: false description: End of date window, formatted as YYYY-MM-DD. name: end in: query - schema: type: string enum: - 'true' - 'false' required: false name: wow in: query responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean enum: - true data: type: object properties: scope: type: object properties: product: type: object properties: id: type: string name: type: string slug: type: string required: - id - name - slug view: type: object properties: id: type: string name: type: string required: - id - name required: - product rows: type: array items: type: object properties: date: type: string promptId: type: string prompt: type: string topicId: type: - string - 'null' totalMentions: type: integer positive: type: integer neutral: type: integer negative: type: integer positivePct: type: number neutralPct: type: number negativePct: type: number wow: type: integer wowPct: type: number negativeReasons: type: array items: type: string required: - promptId - prompt - topicId - totalMentions - positive - neutral - negative - positivePct - neutralPct - negativePct - negativeReasons required: - scope - rows required: - ok - data '400': description: Bad request content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '401': description: Authentication required content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '403': description: Forbidden content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '404': description: Not found content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '422': description: Validation failed content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message '500': description: Internal server error content: application/json: schema: type: object properties: ok: type: boolean enum: - false code: type: string message: type: string details: {} required: - ok - code - message security: - apiKeyAuth: [] - bearerAuth: [] - cookieAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: >- Organization-scoped API key. Available scopes: - content:read: Read site pages, markdown content, and llms.txt files - content:write: Create, update, and delete site pages and content - prompts:read: Read prompts, topics, and prompt analysis results - prompts:write: Create, update, archive prompts - simulations:read: Read agent-simulation tasks, runs, environments, and analytics - simulations:write: Create and trigger simulation runs - logs:read: Read AI-traffic logs and request-level audit events - analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) - analytics:write: Write events to analytics - products:read: Read product metadata and competitor data - products:write: Update product settings and competitor lists x-scopes: content:read: Read site pages, markdown content, and llms.txt files content:write: Create, update, and delete site pages and content prompts:read: Read prompts, topics, and prompt analysis results prompts:write: Create, update, archive prompts simulations:read: Read agent-simulation tasks, runs, environments, and analytics simulations:write: Create and trigger simulation runs logs:read: Read AI-traffic logs and request-level audit events analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) analytics:write: Write events to analytics products:read: Read product metadata and competitor data products:write: Update product settings and competitor lists bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Bearer session or OAuth access token. Available OAuth scopes: - content:read: Read site pages, markdown content, and llms.txt files - content:write: Create, update, and delete site pages and content - prompts:read: Read prompts, topics, and prompt analysis results - prompts:write: Create, update, archive prompts - simulations:read: Read agent-simulation tasks, runs, environments, and analytics - simulations:write: Create and trigger simulation runs - logs:read: Read AI-traffic logs and request-level audit events - analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) - analytics:write: Write events to analytics - products:read: Read product metadata and competitor data - products:write: Update product settings and competitor lists x-scopes: content:read: Read site pages, markdown content, and llms.txt files content:write: Create, update, and delete site pages and content prompts:read: Read prompts, topics, and prompt analysis results prompts:write: Create, update, archive prompts simulations:read: Read agent-simulation tasks, runs, environments, and analytics simulations:write: Create and trigger simulation runs logs:read: Read AI-traffic logs and request-level audit events analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV) analytics:write: Write events to analytics products:read: Read product metadata and competitor data products:write: Update product settings and competitor lists cookieAuth: type: apiKey in: cookie name: better-auth.session_token description: First-party browser session cookie. ````