Read a source's activity
const url = 'http://localhost:11044/api/v1/channels/sources/example/example/activity';const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:11044/api/v1/channels/sources/example/example/activity \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Retained receipts and each approved consumer’s progress. Metadata only: no payloads, nothing delivered.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Name of the captured realm installed in the signed-in owner’s world; non-blank, at most 256 UTF-8 bytes, no control characters and not all * (400 otherwise). 404 when it has no live installation
Source the realm declares, by the name the source list gives; same text rules as the realm name. A source that is undeclared or not approved is answered with a 503, not a 404
Responses
Section titled “Responses”OK
Metadata about one approved source’s journal: retained offsets, recent receipts and each approved consumer’s progress; never a payload. Answered by GET /channels/sources/{realmName}/{sourceName}/activity
object
Every approved consumer reading the source, from any realm installation, with its progress
One approved consumer of a source and how far it has read
object
The live installation of that realm
Name of the consumer, as its realm declares it
The consumer’s position in the source’s journal
object
Journal offset the consumer has checkpointed through: every record at or below it is acknowledged. A new cursor starts at the retained horizon, or at the end. Null when it has not adopted a cursor
Consumer’s id in the journal
Number of offsets between the consumer’s checkpoint and the journal’s end offset: how far behind it is. Null when it has not adopted a cursor
When the consumer last acknowledged an offer; null before its first acknowledgement
Records offered to the consumer and not yet checkpointed through; null when no offer is outstanding
object
Journal offset of the offer’s first record
Number of records in the offer
Journal offset of the offer’s last record
Name of the realm that declares the consumer
That installation’s revision
Mode of the trigger that names this consumer and source, lowercase: observe or apply; null when no trigger names it
Upper bound of the retained range, inclusive: the highest offset in the source’s journal
Recent appends to the source, newest first
One recent append to a channel source: the receipt it was given and the offsets its items landed at. Listed newest first, at most 20, by GET /channels/sources/{realmName}/{sourceName}/activity
object
Lowest journal offset the batch’s items landed at; null when the batch carried no items
Receipt id the append was answered with
Number of items the batch appended
Highest journal offset the batch’s items landed at; null when the batch carried no items
Lower bound of the retained range, exclusive: records at offsets above this one, up to and including endOffset, are retained
The source as its list entry shows it
object
Digest of the realm snapshot the installation admitted, 64 lowercase hex characters
The live installation of that realm this was read from; send it back as installationId on a change
Name of the source: the stem of its sources/
Name of the realm that declares the source
That installation’s revision; send it back as expectedRevision on a change
Revision of the source’s approval, which moves independently of the installation’s revision and is what a consumer grant names as sourceRevision; null while the source is not approved
Journal stream the source’s events are appended to; the same as name
Event type, the source name qualified by its realm:

