Email Delivery (report)

Request

curl -X GET 'https://app.mailyte.com/api/v1/reports/email-delivery' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/reports/email-delivery', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/reports/email-delivery",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/reports/email-delivery');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/reports/email-delivery")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringemail_delivery_report
  • generated_atstring

    When this response was computed, ISO 8601 UTC. Every report answers it, so "is this figure stale?" never depends on which report you asked.

  • periodobject

    The period this report covers. A date_range other than day, week, month or quarter falls back to month, and this shows it. Null for a report read from /reports/history.

    • start_atstring
    • end_atstring
    • granularitystringday

      The width of one series bucket. Always day: the granularity query parameter is accepted and ignored.

  • totalsobject

    Counts for the whole period. Divide them yourself for rates.

    • sentinteger

      Every delivery event in the period: delivered, bounced, deferred, rejected and dropped. It includes deferrals, so it is usually more than the figures beside it added up. Null means unavailable, not 0.

    • deliveredinteger

      Messages a receiving server accepted. Divide engagement counts by this for rates. Null means unavailable, not 0.

    • bouncedinteger

      Messages a receiving server refused. Null means unavailable, not 0.

    • failedinteger

      Messages that will not be delivered: rejected plus dropped. Deferrals are retried and not counted here. Null means unavailable, not 0.

  • seriesarray<object>

    The same counts bucketed over the period, oldest first. Rows are SPARSE: a bucket in which nothing happened has no row at all, rather than a row of zeros, so do not index this array by day offset.

    • start_atstring

      When this time bucket starts: midnight UTC.

    • sentinteger

      Every delivery event in the period: delivered, bounced, deferred, rejected and dropped. It includes deferrals, so it is usually more than the figures beside it added up. Null means unavailable, not 0.

    • deliveredinteger

      Messages a receiving server accepted. Divide engagement counts by this for rates. Null means unavailable, not 0.

    • bouncedinteger

      Messages a receiving server refused. Null means unavailable, not 0.

    • failedinteger

      Messages that will not be delivered: rejected plus dropped. Deferrals are retried and not counted here. Null means unavailable, not 0.

  • bounce_reasonsarray<object>

    The ten most common bounce reasons in the period, most common first.

    • reasonstring

      The bounce reason as reported. unknown groups bounces with no reason, so the counts add up to totals.bounced.

    • countinteger

      Bounces in the period with this reason. Null means unavailable, not 0.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.