integrations

List a collection's event timeline (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/collection-ops/collections/{codeId}/timeline
Access token

Returns a page of the code's collection events, newest first unless order=asc, filterable by event types and severities, with the total. Attachments are listed by index only; a download link is minted per attachment by its own route. Super admin only; 404 while the collection-ops console is turned off.

Path parameters

  • codeId string Required

    Id of the extraction code

Query parameters

  • skip number

    Maximum value is 10000. Default value is 0.

  • limit number

    Maximum value is 100. Default value is 25.

  • order string

    Values are desc or asc. Default value is desc.

  • types array[string]

    Comma-separated event types.

  • severity array[string]

    Comma-separated severities.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • rows array[object]
        Hide rows attributes Show rows attributes object
        • id string
        • eventId string
        • type string
        • source string

          Values are api, app, portal, ops, or system.

        • severity string

          Values are info, warning, or error.

        • message string
        • occurredAt string(date-time)
        • receivedAt string(date-time)
        • clockSkewMs number | null
        • count number

          Repeats collapsed into this row

        • firstAt string(date-time)
        • lastAt string(date-time)
        • dataSource string | null
        • deviceId string | null
        • systemId string | null
        • attemptId string | null
        • errorCode string | null
        • error object | null
          Hide error attributes Show error attributes object | null
          • title string
          • explanation string
          • category string

            Values are connection, disk, permission, device, encryption, server, or unknown.

          • severity string

            Values are info, warning, or error.

        • details object | null

          Additional properties are allowed.

        • attachments array[object]
          Hide attachments attributes Show attachments attributes object
          • index number
          • kind string
          • sizeBytes number | null
        • origin string
        • actorUserId string | null
      • total number
    • statusCode number Required
    • timestamp string(date-time) Required
GET /admin/collection-ops/collections/{codeId}/timeline 
curl \
 --request GET 'http://api.example.com/admin/collection-ops/collections/{codeId}/timeline' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "rows": [
      {
        "id": "65a1b2c3d4e5f6a7b8c9d0e1",
        "eventId": "string",
        "type": "backup.failed",
        "source": "api",
        "severity": "info",
        "message": "string",
        "occurredAt": "2026-05-04T09:42:00Z",
        "receivedAt": "2026-05-04T09:42:00Z",
        "clockSkewMs": 42.0,
        "count": 42.0,
        "firstAt": "2026-05-04T09:42:00Z",
        "lastAt": "2026-05-04T09:42:00Z",
        "dataSource": "string",
        "deviceId": "string",
        "systemId": "string",
        "attemptId": "string",
        "errorCode": "string",
        "error": {
          "title": "Device unplugged",
          "explanation": "string",
          "category": "connection",
          "severity": "info"
        },
        "details": {},
        "attachments": [
          {
            "index": 42.0,
            "kind": "string",
            "sizeBytes": 42.0
          }
        ],
        "origin": "v2",
        "actorUserId": "string"
      }
    ],
    "total": 140
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}