integrations

List extraction statuses (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
GET /admin/report/extractions
Access token

Lists data-source collection statuses that have an extraction code, newest first, one page at a time, filtered by status (in progress by default), organizationId, extractionCode, a date range on the last status change and the watchlist and isVIP switches. Each row carries the code, status, source type, dates, organization name and email and the code's watchlist flag; an unknown extractionCode returns an empty page. Super admin only.

Query parameters

  • page number

    Default value is 1.

  • perPage number

    Default value is 10.

  • skip number

    If skip/limit not provided, page/perPage will take precedence

  • limit number

    If skip/limit not provided, page/perPage will take precedence

  • organizationId string
  • extractionCode string
  • status array[string]

    Values are pending, in_progress, staged, completed, or failed. Default value is ["in_progress"].

  • startDate string
  • endDate string
  • isVIP number

    0 false, 1 true

  • watchlist number

    0 false, 1 true

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • total number Required
      • page number
      • perPage number
      • skip number
      • limit number
      • totalPages number Required
      • nextPage number | null Required
      • previousPage number | null Required
      • data array[object]
        Hide data attributes Show data attributes object
        • extractionCode string Required
        • extractionCodeId string Required
        • sourceId string Required
        • status string Required

          Values are pending, in_progress, staged, completed, or failed.

        • sourceType string Required
        • createdAt string(date-time) Required
        • lastStatusChangedAt string(date-time) Required
        • organization string Required
        • organizationEmail string Required
        • watchlist boolean Required
    • statusCode number Required
    • timestamp string(date-time) Required
GET /admin/report/extractions 
curl \
 --request GET 'http://api.example.com/admin/report/extractions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "total": 42,
    "page": 1,
    "perPage": 20,
    "skip": 0,
    "limit": 20,
    "totalPages": 3,
    "nextPage": 2,
    "previousPage": 42.0,
    "data": [
      {
        "extractionCode": "AB12CD",
        "extractionCodeId": "65a1b2c3d4e5f6a7b8c9d0e8",
        "sourceId": "65a1b2c3d4e5f6a7b8c9d0e9",
        "status": "in_progress",
        "sourceType": "device",
        "createdAt": "2026-01-15T10:15:00.000Z",
        "lastStatusChangedAt": "2026-01-15T11:00:00.000Z",
        "organization": "Example Firm",
        "organizationEmail": "admin@example.com",
        "watchlist": false
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}