Skip to main content

List sent emails

GET https://api.rollstack.com/public/v1/reports/{id}/emails

The emails a report of any type sent, newest first: when, how, to whom, and whether each was delivered, failed or opened. To check many reports, call listEmails instead, which lists every report's emails with their report, and a burst's with its burstId. Answers up to limit emails, 20 by default and 200 at most, and a nextCursor: pass it as cursor for the next page, until it is null.

Requires the slide_decks:read scope.

Operation ID: listReportEmails.

Path parameters

  • id (string, required): The report to act on, of any type, by its id from listReports or createReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after /slides/ or /destinations/.

Query parameters

  • limit (integer): Maximum number of emails to return on this page, from 1 to 200. Defaults to 20.
  • cursor (string): Where to continue the list: pass the nextCursor returned with the previous page to get the next one. Omit it for the first page. Example: 6c1f9a2e-3b4d-4e8f-9a1b-2c3d4e5f6a7b.

Response 200

Success

application/json

  • data (array of object, required): The emails the report sent, newest first: the ones sent with sendReportEmail or from the app, and the ones its schedules' runs sent. Set up who gets them with updateReportEmailConfig.
    • id (string, required): Identifies the sent email.
    • sentAt (string (date-time), required): When it was sent.
    • status (string, required): delivered when the email server accepted it, failed when it could not be sent (error says why), and opened once a recipient opened it, which Rollstack sees only when the organization has email analytics on. One of delivered, failed, opened.
    • trigger (string or null, required): scheduled when a scheduled run of the report sent it; manual when someone sent it, in the app or with sendReportEmail. null when it was not recorded. One of manual, scheduled.
    • sender (object, required): The member it was sent as: who sent it, or whose run sent it.
      • name (string or null, required)
      • email (string, required)
    • subject (string or null, required): The email's subject. null unless you own the report or it is shared with you directly, as on the Email sends page.
    • to (array of string, required): The addresses it was sent to. Empty unless you own the report, it is shared with you directly, or you are an owner or admin of the organization.
    • cc (array of string, required): The addresses copied on it, under the same rule as to.
    • bcc (array of string, required): The addresses it was blind-copied to, under the same rule as to.
    • error (string or null, required): Why it could not be sent, when it failed. null otherwise, or when you may not see its subject.
  • nextCursor (string or null, required): Pass it as cursor to get the next page of emails. null when there are no more.