API docs v1
GET /v1/agency/prospecting-overview

Read what waits in prospecting

scope read:agency cost 1 RU

What waits on the agency across every list, counting only the prospects it goes after (outbound and from the clients' reports): prospects who opened their report and have not replied, pitches to review, approved pitches not sent, pitches with no contact email, and the reports, pitches and sends that failed, each with how many lists hold them and the list holding the most. The website's widget leads are counted apart in leads. Also the prospects' lost deals by reason and their campaign emails of the last 30 days, sent, opened and replied, by day. Who opened their report: GET /v1/agency/prospect-report-views. Account level, on any plan: the owner or an all-brands member of the account; a key restricted to one brand answers 403 forbidden.

Query parameters

  • dry_run boolean optional

    Preview the call without executing it. Runs auth, scope, eligibility and body validation, then returns 200 with a dry_run object reporting the request-unit and credit cost plus a non-consuming quota snapshot. Nothing is debited, reserved, dispatched or mutated. An invalid body still returns 422.

    default: false

Responses

Read what waits in prospecting application/json
Type: ProspectingOverview
  • leads ProspectingLeads required

    The website's widget leads, counted apart from the prospects.

    Show fields
    Type: ProspectingLeads
    • new_week ProspectingCount required

      Leads that came in over the last 7 days.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • opened ProspectingCount required

      Leads who opened their report, not contacted, won or lost yet.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • report_ready ProspectingCount required

      Leads whose report finished, not contacted yet.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • unworked ProspectingCount required

      Leads not contacted, won or lost yet.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

  • outreach ProspectingOutreach required

    The emails the prospects' campaigns sent since since (never the widget leads'), opened and replied to.

    Show fields
    Type: ProspectingOutreach
    • days integer required

      How many days back since is, today included.

    • since string required

      The first day counted (UTC).

    • by_day array of ProspectingOutreachDay

      Only the days with sends.

    • opened integer

      default: `0`

    • replied integer

      default: `0`

    • sent integer

      default: `0`

  • waiting ProspectingWaiting required

    What waits on the agency across every list, only the prospects it goes after (outbound and from the clients' reports), never the website's widget leads.

    Show fields
    Type: ProspectingWaiting
    • approved ProspectingCount required

      Pitches approved and not sent yet.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • drafted ProspectingCount required

      Pitches written and waiting for review.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • not_ready_no_email ProspectingCount required

      Pitched prospects with no contact email to send to.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • pitch_failed ProspectingCount required

      Queued pitches that were not written.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • prospect_opened ProspectingCount required

      Prospects sent outreach who opened their report and have not replied: the moment to call.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • report_failed ProspectingCount required

      Reports that did not come out.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

    • send_failed ProspectingCount required

      Queued outreach that did not start.

      Show fields
      Type: ProspectingCount
      • count integer

        default: `0`

      • lists integer

        How many lists hold them.

        default: `0`

      • top_list_id string (nullable) nullable

        The list holding the most of them: where to act first.

  • lost_by_reason object

    The prospects' lost deals by reason (never the widget leads'): price, no_budget, chose_competitor, no_response, not_a_fit, timing, other, or unknown. The set is open.

    Show fields

    Empty object (no properties).

  • object string

    default: `prospecting_overview`

Request validation failed application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Missing or invalid credentials application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid credentials"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
You do not have permission to access this resource application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "forbidden",
    "message": "You do not have permission to access this resource"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Resource conflict application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "conflict",
    "message": "Resource conflict"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Per-minute rate limit exceeded application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Per-minute rate limit exceeded"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
An unexpected error occurred application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Service temporarily unavailable, please retry application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • request_id string

    Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response 
{
  "error": {
    "code": "service_unavailable",
    "message": "Service temporarily unavailable, please retry"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}