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

# Get reply insights

> What one campaign's replies add up to: how many were real answers rather than bounces or auto-replies, how they read, and concrete, approvable suggestions for what to change.

`campaign` is required. The reply mix is available on every plan; the `sentiment` breakdown needs reply intelligence (Pro or Business), which the response reports as `canUseAi`.

Requires the `read` permission.



## OpenAPI

````yaml GET /api/outreach/insights
openapi: 3.1.0
info:
  title: ManyPI API
  description: >-
    The REST API behind ManyPI — AI lead generation, email validation,
    cold-email outreach, agent runs and web scraping. Every endpoint is
    authenticated with a ManyPI API key (`mpi_...`) or an OAuth 2.1 access
    token, and honours the permissions granted to that credential.
  version: 2.0.0
  contact:
    name: ManyPI Support
    email: support@manypi.com
    url: https://manypi.com
servers:
  - url: https://app.manypi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Leads
    description: Find, store, enrich and manage leads.
  - name: Email validation
    description: Verify that lead addresses can receive mail.
  - name: Outreach
    description: Inboxes, sequences, campaigns, sending and replies.
  - name: Agent
    description: Agent runs, replies and skills.
  - name: Scraping
    description: Scrapers, runs and extracted data.
  - name: Endpoints
    description: Publish scrapers as typed REST endpoints.
  - name: Account
    description: Key validation and account information.
paths:
  /api/outreach/insights:
    get:
      tags:
        - Outreach
      summary: Get reply insights
      description: >-
        What one campaign's replies add up to: how many were real answers rather
        than bounces or auto-replies, how they read, and concrete, approvable
        suggestions for what to change.


        `campaign` is required. The reply mix is available on every plan; the
        `sentiment` breakdown needs reply intelligence (Pro or Business), which
        the response reports as `canUseAi`.


        Requires the `read` permission.
      operationId: getOutreachInsights
      parameters:
        - name: campaign
          in: query
          required: true
          description: The campaign whose replies to analyse.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Insights and suggestions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  suggestions:
                    type: array
                    description: Suggested changes, newest first, up to 50.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        campaign_id:
                          type: string
                          format: uuid
                          nullable: true
                        sequence_id:
                          type: string
                          format: uuid
                          nullable: true
                        kind:
                          type: string
                          enum:
                            - lead_action
                            - campaign_config
                            - sequence_copy
                        action:
                          type: string
                          enum:
                            - suppress_lead
                            - stop_enrollment
                            - mark_interested
                            - snooze
                            - draft_reply
                            - pause_variant
                            - narrow_send_window
                            - lower_daily_limit
                            - pause_campaign
                            - rewrite_step
                        title:
                          type: string
                        rationale:
                          type: string
                        payload:
                          type: object
                          description: The exact change applying the suggestion would make.
                        evidence:
                          type: object
                        status:
                          type: string
                          enum:
                            - pending
                            - applied
                            - dismissed
                            - failed
                        applied_at:
                          type: string
                          format: date-time
                          nullable: true
                        created_at:
                          type: string
                          format: date-time
                  mix:
                    type: object
                    description: Responses by kind. `reply` is the only one a person wrote.
                    properties:
                      reply:
                        type: integer
                      bounce:
                        type: integer
                      auto_reply:
                        type: integer
                  sentiment:
                    type: object
                    additionalProperties:
                      type: integer
                    description: >-
                      Human replies by sentiment. Empty unless `canUseAi` is
                      `true`.
                  lastReplyAt:
                    type: string
                    format: date-time
                    nullable: true
                    description: When the most recent response of any kind arrived.
                  canUseAi:
                    type: boolean
                    description: Whether the plan includes reply intelligence.
              example:
                suggestions: []
                mix:
                  reply: 14
                  bounce: 3
                  auto_reply: 5
                sentiment:
                  positive: 6
                  neutral: 4
                  objection: 3
                  negative: 1
                lastReplyAt: '2026-08-21T16:12:00.000Z'
                canUseAi: true
        '400':
          description: '`campaign` is missing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          description: >-
            Human-readable message. A few validation failures (creating or
            updating an endpoint, bulk lead updates and deletes) send a list of
            the individual problems here instead of one string.
          oneOf:
            - type: string
            - type: array
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      type:
                        - string
                        - integer
                  message:
                    type: string
        code:
          type: string
          description: >-
            A machine-readable code on gated failures: `lead_limit`,
            `outreach_locked`, `validation_credits_exhausted`.
        details:
          description: >-
            Extra detail on some failures, such as the list of parameters that
            failed an endpoint's `param_schema`.
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired credential — or a key that lacks the
        permission this route requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A ManyPI API key (`mpi_...`) from the profile menu → API Access in the
        dashboard, or an OAuth 2.1 access token obtained through the MCP consent
        flow.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.