Report a automation
GET
/api/v1/automations/{automation}/reportParameters
| Name | In | Type | Description |
|---|---|---|---|
automationrequired | path | string | The automation identifier. |
Request
GET
/api/v1/automations/{automation}/reportcurl -X GET 'https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/report' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/automations/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/automations/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/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/report');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations/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.
dataobjectautomation_idstringversion_idstringPer-node counters and engagement belong to the live version.
attribution_window_daysintegerA conversion is attributed to the last email sent within this many days before the goal.
totalsobjectenteredintegerin_flightintegercompletedintegerexitedintegerfailedintegerconvertedintegerconversion_ratenumberPercentage, null when there is no denominator.
exits_by_reasonobjectgoal, exit_event, segment, unsubscribed, archived, or the raw reason.
nodesarray<object>In the tree's order from the trigger.
node_idstringtypestringlabelstringenteredintegercompletedintegerskippedintegerconvertedintegerin_flightintegersentintegersend_email nodes only.
deliveredintegeropenedintegerclickedintegeropen_ratenumberPercentage, null when there is no denominator.
click_ratenumberPercentage, null when there is no denominator.
attributed_conversionsintegerGoals reached within the window after this email.
as_ofstring
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.