Volume Trends (report)

Request

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

const response = await fetch('https://app.mailyte.com/api/v1/reports/volume-trends', {
  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/volume-trends",
    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/volume-trends');

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

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/reports/volume-trends")
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
  • objectstringvolume_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

    The totals for the period.

    • eventsinteger

      Every event in the period, including opens, clicks and unsubscribes, so it is not a count of messages. Null means unavailable, not 0.

    • sentinteger

      Messages delivered plus bounced. This is narrower than sent in /reports/email-delivery, so do not compare the two.

    • receivedinteger

      Inbound mail (email.inbound). Summed from series.

  • 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.

    • eventsinteger

      Every event in the period, including opens, clicks and unsubscribes, so it is not a count of messages. Null means unavailable, not 0.

    • sentinteger

      Messages delivered plus bounced in this bucket. This is narrower than sent in /reports/email-delivery, so do not compare the two. Null means unavailable, not 0.

    • receivedinteger

      Incoming mail. Null means unavailable, not 0.

  • distributionsobject

    Activity by hour of day and by weekday. An hour or day with no events is left out rather than shown as 0. Times are in the server's time zone.

    • hour_of_dayarray<object>
      • bucketstring

        "00" to "23".

      • eventsinteger

        Every event in the period, including opens, clicks and unsubscribes, so it is not a count of messages. Null means unavailable, not 0.

    • day_of_weekarray<object>
      • bucketstring

        "Monday" to "Sunday", in English.

      • eventsinteger

        Every event in the period, including opens, clicks and unsubscribes, so it is not a count of messages. 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.