Report a campaign

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/report' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

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

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

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/report")
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
  • objectstringcampaign_report
  • campaign_idstring
  • statestringdraft | scheduled | sending | paused | sent | canceled | unknown

    The campaign's lifecycle state, from the same map campaign.state uses.

  • timelineobject

    Engagement over time, from the start of sending to the latest event. Null for a campaign that has not started.

    • bucketstringhour | day

      hour while the window is short enough to read that way (72 hours), day after. Null when there is no window.

    • pointsarray<object>

      Null when the campaign never started; never [] in that case.

      • atstring

        The start of the time bucket, in ISO 8601 UTC.

      • deliveredinteger
      • openedinteger
      • clickedinteger
  • linksarray<object>

    Clicks grouped by DESTINATION, most-clicked first — a per-destination table, not a list of click events. At most 50 rows; no campaign at today's volumes comes near that. No ratio is published: you have both inputs.

    • urlstring

      The link that was clicked. Older clicks whose link was not recorded are grouped as (unknown link).

    • total_clicksinteger

      Every click on this destination.

    • unique_clickersinteger

      Distinct recipients who clicked it. Five clicks from one person is not five interested readers, which is why both numbers are kept.

Returned inside the standard envelope.

Errors

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