Bento
View markdown

Delivery API

Use this API to inspect transactional delivery health and recipient-level delivery events from your backend systems. These endpoints use your normal Bento API keys and require Transactional Platform access for the site.

Call these endpoints from server-side code. Do not expose your Bento secret key in a browser or mobile app.

Available Endpoints

MethodEndpointCopy
GET
/delivery/report

Delivery Report

Fetch delivery report data for a site and date range.

GET
/delivery/events

Recipient Events

Fetch delivery events for one recipient email address.

The Delivery Query Model

Delivery queries are scoped by site_uuid and authenticated with your Bento publishable key and secret key. Date filters are optional. Bento defaults to a recent window when dates are omitted.

Use ISO 8601 timestamps when you need exact hour/minute boundaries. Date-only values like 2026-07-08 are treated as calendar days.

Common Query Parameters

  • Name
    site_uuidstring
    Description

    Your Bento site UUID. Required on every request.

  • Name
    start_datedatetime
    Description

    Optional start of the delivery window. Alias: from.

  • Name
    end_datedatetime
    Description

    Optional end of the delivery window. Alias: to.

GET/v1/delivery/report

Delivery Report

Returns delivery report data for the site. If you do not pass dates, Bento returns the last 24 hours.

Required Attributes

  • Name
    site_uuidstring
    Description

    Your Bento site UUID.

Optional Attributes

  • Name
    start_datedatetime
    Description

    Start of the report window. Alias: from.

  • Name
    end_datedatetime
    Description

    End of the report window. Alias: to.



Response

Returns JSON delivery report data for the requested site and date range.

  • Name
    dataobject
    Description

    Report payload for the selected window.

  • Name
    metaobject
    Description

    Metadata returned with the report when available.

  • Name
    errorstring
    Description

    Error message when delivery data cannot be loaded.

GET/v1/delivery/events

Recipient Events

Returns delivery events for one recipient email address. If you do not pass dates, Bento searches up to the last 30 days.

Required Attributes

  • Name
    site_uuidstring
    Description

    Your Bento site UUID.

  • Name
    emailstring
    Description

    Recipient email address to investigate.

Optional Attributes

  • Name
    start_datedatetime
    Description

    Start of the event window. Alias: from.

  • Name
    end_datedatetime
    Description

    End of the event window. Alias: to.

  • Name
    limitinteger
    Description

    Number of events to return. Defaults to 100 and cannot exceed 100.



Response

Returns matching delivery events for the requested recipient.

  • Name
    eventsarray
    Description

    Delivery events for the requested recipient.

  • Name
    metaobject
    Description

    Metadata returned with the event search when available.

  • Name
    errorstring
    Description

    Error message when delivery events cannot be loaded.

Common Errors

  • Name
    400status
    Description

    Missing email, invalid date, invalid limit, or a start date after the end date.

  • Name
    401status
    Description

    Missing or invalid API credentials, or a site_uuid your API key cannot access.

  • Name
    403status
    Description

    Transactional Platform access is required for this site.

  • Name
    503status
    Description

    Delivery data is unavailable. Retry later.