> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reechee.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get pain points

> One endpoint, two depths by auth lane:

- **Anonymous** - a free *taste*: summary, the top 3 themes (each with up to 2
  quotes), and `total_themes`. The `meta.upsell` field links to the full
  report. Returns the product with empty `themes` when no report exists yet -
  never a silent empty.
- **With a valid API key** - the *full* report: every theme and quote, trend
  badges, and analysis metadata. No upsell.

A product with no generated report returns `404` to anonymous callers only
when the product id itself is unknown; a known product without a report returns
`200` with an empty taste.




## OpenAPI

````yaml /openapi.yaml get /products/{id}/pain-points
openapi: 3.1.0
info:
  title: Reechee Developer Platform API
  version: 1.0.0
  description: >
    The Reechee REST API exposes software-review pain points, buying signals,
    and

    sales opportunities.


    Two auth lanes share one base URL:


    - **Anonymous** (no key) - read-only, IP rate-limited. Product search, a
    free
      pain-points taste, and category competitors.
    - **API key** (`Authorization: Bearer rch_live_…`) - paid teams get full
      pain-point reports, opportunities, watchlist, credit balance, and safe write
      actions (follow/unfollow, triage).

    Every response uses a consistent envelope: `{ "success": true, "data": … }`
    on

    success (with an optional `meta`), or `{ "success": false, "error": {
    "code",

    "message", "details"? } }` on failure.
  contact:
    name: Reechee
    url: https://reechee.io
servers:
  - url: https://app.reechee.io/api/v1
    description: Production
security: []
tags:
  - name: System
    description: Health and connectivity.
  - name: Products
    description: Search products and read their pain points and competitors.
  - name: Opportunities
    description: Read and triage sales opportunities (API key required).
  - name: Watchlist
    description: Read and manage the team's followed products (API key required).
  - name: Account
    description: Team account data such as credit balance (API key required).
  - name: Credits
    description: >-
      Credit-spending actions (Tier 3). Requires a spend budget on the
      credential - a per-key spend cap for API keys, or the consent-time credit
      budget for OAuth connections.
paths:
  /products/{id}/pain-points:
    get:
      tags:
        - Products
      summary: Get pain points
      description: >
        One endpoint, two depths by auth lane:


        - **Anonymous** - a free *taste*: summary, the top 3 themes (each with
        up to 2
          quotes), and `total_themes`. The `meta.upsell` field links to the full
          report. Returns the product with empty `themes` when no report exists yet -
          never a silent empty.
        - **With a valid API key** - the *full* report: every theme and quote,
        trend
          badges, and analysis metadata. No upsell.

        A product with no generated report returns `404` to anonymous callers
        only

        when the product id itself is unknown; a known product without a report
        returns

        `200` with an empty taste.
      operationId: getPainPoints
      parameters:
        - $ref: '#/components/parameters/ProductId'
      responses:
        '200':
          description: The pain-points taste (anonymous) or full report (keyed).
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    anyOf:
                      - $ref: '#/components/schemas/PainPointsTaste'
                      - $ref: '#/components/schemas/PainPointsReport'
                  meta:
                    type: object
                    properties:
                      upsell:
                        type: string
                        description: Soft CTA, present on the anonymous taste only.
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - {}
        - bearerAuth: []
components:
  parameters:
    ProductId:
      name: id
      in: path
      required: true
      description: Product id (uuid).
      schema:
        type: string
        format: uuid
  schemas:
    PainPointsTaste:
      type: object
      required:
        - product
        - themes
        - total_themes
      properties:
        product:
          $ref: '#/components/schemas/ProductRef'
        status:
          type:
            - string
            - 'null'
        generated_at:
          type:
            - string
            - 'null'
          format: date-time
        summary:
          type:
            - string
            - 'null'
        themes:
          type: array
          items:
            $ref: '#/components/schemas/PainPointsTasteTheme'
        total_themes:
          type: integer
          description: Total themes in the full report (the taste returns the top few).
    PainPointsReport:
      type: object
      description: The full keyed report. `report` is `null` when none has been generated.
      required:
        - product
      properties:
        product:
          $ref: '#/components/schemas/ProductRef'
        status:
          type:
            - string
            - 'null'
        generated_at:
          type:
            - string
            - 'null'
          format: date-time
        report:
          anyOf:
            - $ref: '#/components/schemas/PainPointsReportData'
            - type: 'null'
    ProductRef:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        logo_url:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
    PainPointsTasteTheme:
      type: object
      required:
        - category_name
        - quotes
      properties:
        category_name:
          type: string
        trend:
          type:
            - string
            - 'null'
          example: trending
        total_mentions:
          type:
            - integer
            - 'null'
        business_impact:
          type:
            - string
            - 'null'
        quotes:
          type: array
          items:
            $ref: '#/components/schemas/PainPointsTasteQuote'
    PainPointsReportData:
      type: object
      required:
        - executive_summary
        - pain_points
      properties:
        analysis_metadata:
          $ref: '#/components/schemas/AnalysisMetadata'
        executive_summary:
          type: string
        pain_points:
          type: array
          items:
            $ref: '#/components/schemas/PainPointCategory'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - payment_required
                - forbidden
                - not_found
                - rate_limited
                - internal_error
            message:
              type: string
            details:
              type:
                - object
                - 'null'
              additionalProperties: true
    PainPointsTasteQuote:
      type: object
      required:
        - quote_text
      properties:
        quote_text:
          type: string
        platform:
          type:
            - string
            - 'null'
        source_url:
          type:
            - string
            - 'null'
        review_date:
          type:
            - string
            - 'null'
    AnalysisMetadata:
      type: object
      properties:
        product_name:
          type: string
        total_reviews_analyzed:
          type: integer
        historical_reviews_count:
          type: integer
        recent_reviews_count:
          type: integer
        analysis_date:
          type: string
        date_range_analyzed:
          type: object
          properties:
            earliest:
              type: string
            latest:
              type: string
    PainPointCategory:
      type: object
      required:
        - category_name
        - total_mentions
        - recent_mentions
        - most_recent_review_date
        - business_impact
        - representative_quotes
      properties:
        category_name:
          type: string
        total_mentions:
          type: integer
        recent_mentions:
          type: integer
        trend:
          type:
            - string
            - 'null'
          enum:
            - trending
            - rising
            - persistent
            - null
        most_recent_review_date:
          type: string
        business_impact:
          type: string
        representative_quotes:
          type: array
          items:
            $ref: '#/components/schemas/ReportQuote'
    ReportQuote:
      type: object
      required:
        - quote_text
        - source_url
        - platform
        - review_date
      properties:
        quote_text:
          type: string
        reviewer_context:
          type: string
        source_url:
          type: string
        platform:
          type: string
        review_date:
          type: string
  responses:
    NotFound:
      description: The resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: not_found
              message: Resource not found
    RateLimited:
      description: |
        The rate limit was exceeded. The response carries `Retry-After` and
        `X-RateLimit-*` headers.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed in the window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in the window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix seconds when the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: rate_limited
              message: Rate limit exceeded
              details:
                retry_after_seconds: 12
                limit: 60
                remaining: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rch_live_…
      description: >
        A paid-team API key, sent as `Authorization: Bearer rch_live_…`. Create
        and

        revoke keys in the app under Settings → API keys.

````