SDK

openemail.tracking

この名前空間のすべてのメソッドの、シグネチャ、パラメーター、戻り値、例。

メソッド

Opens and clicks on tracked messages, one message at a time or rolled up.

`tracking.list()`

List one page of tracked messages in a time window

emails:read結果をページ単位で取得

シグネチャ

list(options?: TrackingListOptions): Promise<Page<TrackingResource>>

Returns one page of the messages the workspace tracked and sent in the window, newest first, each as a full engagement report with its recipients and links. It covers the whole mailbox, not only mail sent through this API: messages from the composer, the MCP tools and the assistant appear too, with sendId null where no send record exists. A report built off emails.list would describe the API rather than the mailbox.

Messages that carried no pixel and no rewritten link are absent entirely and never appear as a zero. opened: false therefore means tracked and not opened, and clicked narrows the same way. Both filters work on counted opens and clicks, so a message fetched only by Apple Mail Privacy Protection or a link scanner still counts as unopened.

The window defaults to 30 days. minutes wins over days when both are set, and the start of the window is floored to the grain in UTC, so days: 7 covers today plus the six whole days before it. Paging is keyset: nextCursor is the tmsg_ id of the last report on the page, and passing it back as cursor with the same filters continues strictly after it, so every tracked message in the window is reachable. listAll and iterate do that walk for you.

パラメーター

options.openedboolean: Omit for both. true keeps opened messages and false keeps tracked messages nobody opened.
options.clickedboolean: Omit for both. true keeps messages with a counted click and false keeps those without.
options.daysnumber: Window length in days, a whole number from 1 to 365, defaulting to 30.
options.minutesnumber: Window length in minutes, from 1 to 527040. Takes precedence over days.
options.grainTrackingGrain: minute, hour or day, defaulting to day. It only floors the window start so this list matches getStats read at the same grain, and shapes nothing in the response.
options.limitnumber: Reports per page, from 1 to 200, defaulting to 50.
options.cursorstring: The nextCursor from the previous page, a tmsg_ id. One that names no tracked message in the workspace is a 400 invalid_cursor.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Lists with this key instead of the client's.

戻り値

Page<TrackingResource> with items, hasMore and nextCursor. Each item has id, sendId, subject, from, source, sentAt, opens, clicks, opened, clicked, attributable, the counted and raw open and click counts, recipients and links.

例

const page = await openemail.tracking.list({    opened: false,    days: 7,    limit: 200}) for (const message of page.items) console.log(message.sentAt, message.subject, message.recipients.length) if (page.hasMore) {    const next = await openemail.tracking.list({ opened: false, days: 7, cursor: page.nextCursor ?? undefined })     console.log(next.items.length)}

注意事項

A window shorter than a day needs a finer grain. minutes: 60 at the default day grain is rounded to one bucket and starts at midnight UTC.
A key with an address allowlist sees only messages sent from those addresses.
Only messages that were actually sent are listed, so a scheduled message that has not gone yet is absent even if tracking was requested.

ほかの提供先

API: GET /tracking
CLI: openemail tracking list

`tracking.listAll()`

Collect every tracked message in a window into one array

emails:read結果をページ単位で取得

シグネチャ

listAll(options?: TrackingListOptions): Promise<Array<TrackingResource>>

Follows nextCursor from page to page and resolves once the last page has been read, with every tracked message in the window in one array, newest first. It takes the same filters as list and returns the same full engagement reports.

Everything is held in memory before the promise settles. Narrow the window or the filters, or switch to iterate when you want to stop early. limit sets the page size of each underlying request, not the total.

パラメーター

options.openedboolean: Omit for both. true keeps opened messages and false keeps tracked messages nobody opened.
options.clickedboolean: Omit for both. true keeps messages with a counted click and false keeps those without.
options.daysnumber: Window length in days, a whole number from 1 to 365, defaulting to 30.
options.minutesnumber: Window length in minutes, from 1 to 527040. Takes precedence over days.
options.grainTrackingGrain: minute, hour or day, defaulting to day. It only floors the window start.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: A tmsg_ id to start after, skipping everything newer.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Lists with this key instead of the client's.

戻り値

Array<TrackingResource> holding every report across all pages.

例

const unopened = await openemail.tracking.listAll({ opened: false, days: 30, limit: 200 }) console.log(unopened.length, unopened.map((message) => message.subject))

注意事項

A failure on any page rejects the whole call, and the reports already fetched are discarded.
A key with an address allowlist sees only messages sent from those addresses, on every page.

ほかの提供先

API: GET /tracking

`tracking.iterate()`

Stream tracked messages one at a time across pages

emails:read結果をページ単位で取得

シグネチャ

iterate(options?: TrackingListOptions): AsyncGenerator<TrackingResource, void, undefined>

Returns an async generator that yields tracked messages individually, newest first, and requests the next page only once the current one is drained. Nothing is fetched until you start consuming it, and breaking out of the loop stops the requests.

The walk is keyset based, following nextCursor from page to page, so a message tracked while you iterate lands ahead of where you started and is never yielded, and nothing already yielded comes round again.

パラメーター

options.openedboolean: Omit for both. true keeps opened messages and false keeps tracked messages nobody opened.
options.clickedboolean: Omit for both. true keeps messages with a counted click and false keeps those without.
options.daysnumber: Window length in days, a whole number from 1 to 365, defaulting to 30.
options.minutesnumber: Window length in minutes, from 1 to 527040. Takes precedence over days.
options.grainTrackingGrain: minute, hour or day, defaulting to day. It only floors the window start.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: A tmsg_ id to start after, skipping everything newer.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Lists with this key instead of the client's.

戻り値

AsyncGenerator<TrackingResource, void, undefined> yielding one report per step.

例

for await (const message of openemail.tracking.iterate({ clicked: true, days: 90 })) {    if (message.links.some((link) => link.url.includes('/pricing'))) {        console.log(message.id, message.subject)        break    }}

注意事項

The generator is lazy, so an abandoned loop costs only the pages you consumed.

ほかの提供先

API: GET /tracking

`tracking.getStats()`

Summarise engagement across a time window

emails:read

シグネチャ

getStats(options?: TrackingStatsOptions): Promise<TrackingStatsResource>

Returns the numbers behind an engagement panel in one request: how many messages were tracked, opened and clicked, the open and click rates, hit totals, a time series, the top links, mail clients and countries. It covers every tracked message sent from the mailbox in the window, whichever surface sent it.

Rates and totals count different things, and mixing them is how open rates above 100% get published. opened and clicked count distinct messages. totalOpens and totalClicks count hits. openRate is a percentage of trackedForOpens, the messages that actually carried a pixel, and clickRate is a percentage of trackedForClicks, the messages that had a link to rewrite, which is usually far fewer than tracked because most replies contain no links.

byDay is sparse: a bucket in which nothing was sent has no entry, so a chart must fill the gaps. grain sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offsetMinutes shifts bucket boundaries so days break where the reader's day does. The window starts at the beginning of the oldest bucket, so that bucket is whole, and ends now, so the newest is partial.

パラメーター

options.daysnumber: Window length in days, from 1 to 365, defaulting to 30.
options.minutesnumber: Window length in minutes, from 1 to 527040. Takes precedence over days, and only useful below a day with a finer grain.
options.grainTrackingGrain: Bucket width for byDay: minute, hour or day, defaulting to day.
options.offsetMinutesnumber: Minutes east of UTC to bucket in, from -840 to 840, defaulting to 0. Pass -new Date().getTimezoneOffset() for the local zone.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

TrackingStatsResource with tracked, trackedForOpens, trackedForClicks, opened, clicked, openRate, clickRate, totalOpens, totalClicks, machineOpens, medianTimeToOpenSeconds (null when nothing was opened), byDay, topLinks, clients and countries.

例

const stats = await openemail.tracking.getStats({    days: 7,    grain: 'day',    offsetMinutes: -new Date().getTimezoneOffset()}) console.log(`${stats.openRate}% of ${stats.trackedForOpens} messages opened`)console.log(stats.byDay, stats.topLinks.slice(0, 3))

注意事項

openRate and clickRate are percentages rounded to one decimal place, such as 42.5, not fractions between 0 and 1.
machineOpens, clients and countries are counted from individual hit records rather than from the counters on the per-message report.
A key with an address allowlist gets figures for mail sent from those addresses only, not the whole workspace.
topLinks holds at most 10 links that were clicked at least once, while clients and countries hold at most 8 each.

ほかの提供先

API: GET /tracking/stats
CLI: openemail tracking get-stats

`tracking.get()`

Read one message's engagement report

emails:read

シグネチャ

get(id: string, options?: RequestScope): Promise<TrackingResource>

Returns the whole report for one tracked message: totals, one entry per tracked copy under recipients, and every rewritten link with its clicks under links. It accepts either identifier a caller may hold. A msg_ id is looked up as the send it went out as, and anything else is treated as a tmsg_ tracking id, which is what tracking.list and webhook payloads carry for mail sent outside this API.

openCount and clickCount are counted readings: opens that looked like a person, with repeat fetches within thirty seconds collapsed. openCountRaw and clickCountRaw include every hit, machine fetches such as Apple Mail Privacy Protection and corporate scanners among them. Gmail's image proxy is a real person displaying the message and is counted, but only once, because later views are served from its cache.

recipients is one entry per tracked copy, which is not always one entry per person. When one body went to the whole list, or the bytes could not vary per recipient, the shared copy has email null and attributed false. Branch on attributed and on the message-level attributable before saying that a named person has or has not read anything.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

TrackingResource with id, sendId, threadId, subject, from, source, sentAt, opens, clicks, opened, clicked, attributable, counted and raw open and click counts, first and last open and click times, recipients and links.

例

const report = await openemail.tracking.get('tmsg_8b2e4d71c09f3a65e1d7b402') const followed = report.links.filter((link) => link.clickCount > 0) console.log(report.opened, report.openCount, report.openCountRaw)console.log(followed.map((link) => link.label ?? link.url))

注意事項

A 404 means nothing was tracked for that message, which is not the same as nobody having opened it.
opens and clicks record what was applied when the message was sent. Turning tracking on later does not make earlier mail start reporting.
Only links in the new part of a body are rewritten, so quoted history under a reply never appears in links.

ほかの提供先

API: GET /tracking/{id}
CLI: openemail tracking get

`tracking.listOpens()`

List the individual opens behind a message's open count

emails:read結果をページ単位で取得

シグネチャ

listOpens(id: string, options?: TrackingHitOptions): Promise<Page<TrackingOpenResource>>

Returns one page of the raw open hits for one tracked message, newest first. nextCursor is the opn_ id of the last hit on the page, and passing it back as cursor continues strictly after it, so every stored hit is reachable; listAllOpens and iterateOpens do that walk for you. Each hit says which copy was fetched, how it was classified, whether it moved the numbers, and what the User-Agent and the edge could tell about the client, device and location.

kind is human for something that looked like a person reading, proxy for an image proxy such as Gmail's, which is a genuine reading by a reader the tracker cannot see, and machine for a scanner or Apple Mail Privacy Protection, which fetches on delivery and only proves the message arrived. By default only counted hits come back. includeMachine: true adds the hits that did not count, which is every machine hit plus repeat fetches within thirty seconds of a counted one on the same copy, so it filters on counted rather than on kind.

A msg_ send id is resolved first, and one that names no tracked message is a 404 rather than an empty list, since an empty list reads as nobody having opened it. A tmsg_ id is taken as given without a lookup, so one that never existed or belongs to another workspace comes back as an empty list. Only read an empty result as an answer about readers when the id came from this API.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.includeMachineboolean: Defaults to false. True also returns hits with counted false, machine fetches and collapsed repeats alike.
options.limitnumber: Hits per page, from 1 to 200, defaulting to 50.
options.cursorstring: The nextCursor from the previous page, an opn_ id. Anything else, or one from another message's log, is a 400 invalid_cursor.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

Page<TrackingOpenResource> with items, hasMore and nextCursor. Each item has object set to open, id, trackedMessageId, recipient, kind, counted, userAgent, client, device, os, country, region, city and createdAt.

例

const page = await openemail.tracking.listOpens('msg_3f9a1c07d2b84e6a9c5b1f20', {    includeMachine: true,    limit: 200}) const machine = page.items.filter((open) => open.kind === 'machine').length console.log(page.items.length, machine, page.items[0]?.client, page.hasMore)

注意事項

An open row carries no IP address, and country, region and city are what the edge already knew, so on a proxied hit they describe the proxy rather than the reader. The address the request came from is still kept: it goes into the event log for the message, which GET /emails/{id}/events returns, and into the email.opened webhook payload.
recipient is null on a shared copy, for the same reason recipients[].email is null on the report.

ほかの提供先

API: GET /tracking/{id}/opens
CLI: openemail tracking list-opens

`tracking.listAllOpens()`

Collect every open hit on one message into one array

emails:read結果をページ単位で取得

シグネチャ

listAllOpens(id: string, options?: TrackingHitOptions): Promise<Array<TrackingOpenResource>>

Walks every page of one tracked message's open log and resolves with all of its hits, newest first. It takes the same options as listOpens, so by default only counted hits come back and includeMachine: true adds the rest.

A message opened by a mailing list of thousands can hold a great many rows. Prefer iterateOpens when you can stop early. limit sets the page size of each request, not the total.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.includeMachineboolean: Defaults to false. True also returns hits with counted false.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: An opn_ id to start after, skipping every newer open.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

Array<TrackingOpenResource> holding every hit across all pages, newest first.

例

const opens = await openemail.tracking.listAllOpens('msg_3f9a1c07d2b84e6a9c5b1f20', { includeMachine: true, limit: 200 }) const byCountry = new Map<string, number>() for (const open of opens) byCountry.set(open.country ?? 'unknown', (byCountry.get(open.country ?? 'unknown') ?? 0) + 1) console.log([...byCountry.entries()])

注意事項

A failure on any page rejects the whole call, and the hits already fetched are discarded.
The same id rules as listOpens apply: a msg_ id that names no tracked message is a 404, and an unknown tmsg_ id collects an empty array.

ほかの提供先

API: GET /tracking/{id}/opens

`tracking.iterateOpens()`

Stream the open hits on one message one at a time

emails:read結果をページ単位で取得

シグネチャ

iterateOpens(id: string, options?: TrackingHitOptions): AsyncGenerator<TrackingOpenResource, void, undefined>

Returns an async generator over one tracked message's open log that yields hits individually, newest first, and fetches the next page only when the current one is drained. Nothing is requested until you consume it, and breaking out of the loop stops further requests.

The walk ends when hasMore is false. Hits recorded after the walk starts are newer than its cursor and are not yielded.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.includeMachineboolean: Defaults to false. True also returns hits with counted false.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: An opn_ id to start after, skipping every newer open.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

AsyncGenerator<TrackingOpenResource, void, undefined> yielding one hit per step.

例

for await (const open of openemail.tracking.iterateOpens('tmsg_8b2e4d71c09f3a65e1d7b402')) {    if (open.kind === 'human') {        console.log('first person read it at', open.createdAt)        break    }}

注意事項

The generator is lazy, so an abandoned loop costs only the pages you consumed.

ほかの提供先

API: GET /tracking/{id}/opens

`tracking.listClicks()`

List the individual link clicks on a message

emails:read結果をページ単位で取得

シグネチャ

listClicks(id: string, options?: TrackingHitOptions): Promise<Page<TrackingClickResource>>

Returns one page of the raw click hits for one tracked message, newest first. nextCursor is the clk_ id of the last hit on the page, and passing it back as cursor continues strictly after it, so every stored hit is reachable; listAllClicks and iterateClicks do that walk for you. Each hit has the same classification and client detail as an open, plus linkId and url naming the link that was followed, where url is the original destination rather than the redirect.

A click is stronger evidence of reading than an open. Mail clients block images far more often than readers leave links unfollowed, so a message with clicks and no opens was certainly read. Link scanners that follow every URL on delivery are classified as machine and excluded from the default result, and includeMachine: true brings them back along with repeat hits collapsed by the thirty second window.

Only links in the new part of the body were rewritten, so nothing here can be a click on quoted history under a reply. The id rules match listOpens: a msg_ id that names no tracked message is a 404, while a tmsg_ id is used without a lookup and an unknown one returns an empty list.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.includeMachineboolean: Defaults to false. True also returns hits with counted false, scanner clicks and collapsed repeats alike.
options.limitnumber: Hits per page, from 1 to 200, defaulting to 50.
options.cursorstring: The nextCursor from the previous page, a clk_ id. Anything else, or one from another message's log, is a 400 invalid_cursor.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

Page<TrackingClickResource> with items, hasMore and nextCursor. Each item has object set to click, id, trackedMessageId, linkId, url, recipient, kind, counted, userAgent, client, device, os, country, region, city and createdAt.

例

const clicks = await openemail.tracking.listAllClicks('tmsg_8b2e4d71c09f3a65e1d7b402', { limit: 200 }) const byUrl = new Map<string, number>() for (const click of clicks) byUrl.set(click.url, (byUrl.get(click.url) ?? 0) + 1) console.log([...byUrl.entries()])

注意事項

Repeated destinations share one linkId on the report, so a page linked from a header image, a button and a footer is one link. Group by linkId to match links on tracking.get.
A key with an address allowlist gets a 404 for a msg_ id sent from an address outside it, and a tmsg_ id is then looked up rather than taken as given.

ほかの提供先

API: GET /tracking/{id}/clicks
CLI: openemail tracking list-clicks

`tracking.listAllClicks()`

Collect every click hit on one message into one array

emails:read結果をページ単位で取得

シグネチャ

listAllClicks(id: string, options?: TrackingHitOptions): Promise<Array<TrackingClickResource>>

Walks every page of one tracked message's click log and resolves with all of its hits, newest first. It takes the same options as listClicks, so by default only counted hits come back and includeMachine: true adds the rest.

A message opened by a mailing list of thousands can hold a great many rows. Prefer iterateClicks when you can stop early. limit sets the page size of each request, not the total.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.includeMachineboolean: Defaults to false. True also returns hits with counted false.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: A clk_ id to start after, skipping every newer click.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

Array<TrackingClickResource> holding every hit across all pages, newest first.

例

const clicks = await openemail.tracking.listAllClicks('tmsg_8b2e4d71c09f3a65e1d7b402') console.log(new Set(clicks.map((click) => click.recipient)).size, 'people clicked')

注意事項

A failure on any page rejects the whole call, and the hits already fetched are discarded.
The same id rules as listClicks apply: a msg_ id that names no tracked message is a 404, and an unknown tmsg_ id collects an empty array.

ほかの提供先

API: GET /tracking/{id}/clicks

`tracking.iterateClicks()`

Stream the click hits on one message one at a time

emails:read結果をページ単位で取得

シグネチャ

iterateClicks(id: string, options?: TrackingHitOptions): AsyncGenerator<TrackingClickResource, void, undefined>

Returns an async generator over one tracked message's click log that yields hits individually, newest first, and fetches the next page only when the current one is drained. Nothing is requested until you consume it, and breaking out of the loop stops further requests.

The walk ends when hasMore is false. Hits recorded after the walk starts are newer than its cursor and are not yielded.

パラメーター

idstring必須: A tmsg_ tracking id or the msg_ send id the message went out as.
options.includeMachineboolean: Defaults to false. True also returns hits with counted false.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: A clk_ id to start after, skipping every newer click.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Reads with this key instead of the client's.

戻り値

AsyncGenerator<TrackingClickResource, void, undefined> yielding one hit per step.

例

for await (const click of openemail.tracking.iterateClicks('tmsg_8b2e4d71c09f3a65e1d7b402')) {    if (click.url.includes('/unsubscribe')) {        console.log(click.recipient, click.createdAt)        break    }}

注意事項

The generator is lazy, so an abandoned loop costs only the pages you consumed.

ほかの提供先

API: GET /tracking/{id}/clicks

openemail.tracking

メソッド

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

受信トレイを、あなたの思いどおりに。

受信トレイを、
あなたの思いどおりに。