ackDB

Get activity timeline for an entity

Returns the entity's activity timeline - events from all sources, ordered by timestamp. Filterable by source type and event type. Use for building activity feeds or investigating what happened with a customer.

get/api/v1/ackdb/entities/{entityId}/events

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

entityIdstring required

Entity ID (ULID)

Query parameters

limitinteger

Maximum number of events to return.

offsetinteger

Number of events to skip for pagination.

sourcestring

Filter by source type (e.g. slack, stripe).

sourcesstring

CSV include list — only events from these sources (e.g. slack,stripe). Mutually exclusive with source and excludeSources (400).

excludeSourcesstring

CSV exclude list — drop events from these sources (e.g. system,custom,member to hide ackDB bookkeeping events). Mutually exclusive with source and sources (400).

eventTypestring

Filter by event type (e.g. slack_message, stripe_charge.succeeded).

sincestring date-time

Filter events after this ISO date.

untilstring date-time

Filter events before this ISO date.

Response

Paginated list of entity events

Example response

{
  "data": [
    {
      "id": "01HXYZ123456789ABCDEFGH",
      "source": "slack",
      "eventType": "message",
      "summary": "Customer asked about pricing in #acme-corp"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "totalIsLowerBound": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.