Skip to main content

PaginatedResponse[LeadResearchResultRead]

items object[]required
  • Array [
  • idIdrequired

    Unique numeric identifier of the record.

    lead_idLead Idrequired

    ID of the lead this record relates to.

    product_idProduct Idrequired

    ID of the product (workspace) that owns this record. Most endpoints scope access by product.

    agent_idAgent Idrequired

    ID of the agent (a configured AI assistant / bot persona) this record belongs to.

    dispatch_run_id objectrequired

    ID of the dispatch run that requested the research, if any.

    anyOf
    integer
    statusLeadResearchResultStatusrequired

    Research status — queued, in_progress, pending_review, approved, rejected, failed, or expired.

    Possible values: [queued, in_progress, pending_review, approved, rejected, failed, expired]

    result objectrequired

    The research output text.

    anyOf
    string
    source_values objectrequired

    The inputs the research was based on.

    anyOf
    object
    metadata object

    Additional metadata about the research run.

    anyOf
    object
    error_message objectrequired

    Failure detail if the research failed.

    anyOf
    string
    status_changed_atdate-timerequired

    When the status last changed (UTC).

    started_at objectrequired

    When research started (UTC).

    anyOf
    date-time
    completed_at objectrequired

    When research completed (UTC).

    anyOf
    date-time
    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

    updated_atdate-timerequired

    Last modification time (UTC, ISO 8601).

  • ]
  • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[LeadResearchResultRead]
    {
    "items": [
    {
    "id": 0,
    "lead_id": 0,
    "product_id": 0,
    "agent_id": 0,
    "dispatch_run_id": 0,
    "status": "queued",
    "result": "string",
    "source_values": {},
    "metadata": {},
    "error_message": "string",
    "status_changed_at": "2024-07-29T15:51:28.071Z",
    "started_at": "2024-07-29T15:51:28.071Z",
    "completed_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "page": 0,
    "limit": 0,
    "total": 0,
    "pages": 0
    }