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

# Record collector coverage for an entity/platform scope

> Record what a collector attempted and whether coverage is proven.

This is intentionally separate from row insertion: a collector can prove a
target is blocked or fully exhausted even when zero new rows were stored
because all posts were already deduplicated.



## OpenAPI

````yaml /api/openapi.json post /agent/v1/ingest/coverage
openapi: 3.1.0
info:
  title: CrowdListen Agent API
  description: >-
    Configure sources, collect and retain originals, run durable analysis, and
    read or revise cited insights. Humans and agents share authorized
    entity/project records, research jobs and evidence history.
  version: 1.0.0
servers:
  - url: https://agent.crowdlisten.com
    description: Production
  - url: http://localhost:8000
    description: Local development
security: []
paths:
  /agent/v1/ingest/coverage:
    post:
      tags:
        - ingest
      summary: Record collector coverage for an entity/platform scope
      description: >-
        Record what a collector attempted and whether coverage is proven.


        This is intentionally separate from row insertion: a collector can prove
        a

        target is blocked or fully exhausted even when zero new rows were stored

        because all posts were already deduplicated.
      operationId: record_collection_coverage_agent_v1_ingest_coverage_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoverageRecordRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoverageRecordResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CoverageRecordRequest:
      properties:
        entity_id:
          type: string
          maxLength: 100
          minLength: 1
          title: Entity Id
        platform:
          $ref: '#/components/schemas/Platform'
        collector:
          type: string
          maxLength: 200
          title: Collector
          default: unknown
        collection_scope:
          type: string
          maxLength: 200
          title: Collection Scope
          default: unknown
        coverage_state:
          type: string
          pattern: ^(exhaustive|sampled|bounded|blocked|unknown)$
          title: Coverage State
          description: >-
            Whether the collector proved full coverage for the declared
            scope/window.
        run_id:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Run Id
        query:
          anyOf:
            - type: string
              maxLength: 5000
            - type: 'null'
          title: Query
        started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
        targets:
          items:
            $ref: '#/components/schemas/CoverageTarget'
          type: array
          maxItems: 200
          title: Targets
        totals:
          additionalProperties: true
          type: object
          title: Totals
        notes:
          anyOf:
            - type: string
              maxLength: 5000
            - type: 'null'
          title: Notes
      type: object
      required:
        - entity_id
        - platform
        - coverage_state
      title: CoverageRecordRequest
    CoverageRecordResponse:
      properties:
        status:
          type: string
          title: Status
        entity_id:
          type: string
          title: Entity Id
        run_id:
          type: string
          title: Run Id
        coverage_state:
          type: string
          title: Coverage State
        targets_recorded:
          type: integer
          title: Targets Recorded
      type: object
      required:
        - status
        - entity_id
        - run_id
        - coverage_state
        - targets_recorded
      title: CoverageRecordResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Platform:
      type: string
      enum:
        - reddit
        - youtube
        - tiktok
        - twitter
        - instagram
        - linkedin
        - hackernews
        - producthunt
        - github
        - threads
        - web
        - granola
        - slack
        - agent
        - claude_code
        - codex
      title: Platform
    CoverageTarget:
      properties:
        target:
          type: string
          maxLength: 500
          minLength: 1
          title: Target
        target_type:
          type: string
          maxLength: 100
          title: Target Type
          default: account
        role:
          type: string
          maxLength: 100
          title: Role
          default: unknown
        source_group:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Source Group
        sender_type:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Sender Type
        status:
          type: string
          maxLength: 100
          title: Status
          default: unknown
        items_found:
          type: integer
          minimum: 0
          title: Items Found
          default: 0
        items_stored:
          type: integer
          minimum: 0
          title: Items Stored
          default: 0
        cursor_start:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Cursor Start
        cursor_end:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Cursor End
        reached_end:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Reached End
        error:
          anyOf:
            - type: string
              maxLength: 1000
            - type: 'null'
          title: Error
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
        - target
      title: CoverageTarget
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

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