Report a automation

GET/api/v1/automations/{automation}/report
Requires anorganization API keywith the scopeautomations:read

Parameters

NameInTypeDescription
automationrequiredpathstringThe automation identifier.

Request

GET/api/v1/automations/{automation}/report
curl -X GET 'https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/report' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • automation_idstring
    • version_idstring

      Per-node counters and engagement belong to the live version.

    • attribution_window_daysinteger

      A conversion is attributed to the last email sent within this many days before the goal.

    • totalsobject
      • enteredinteger
      • in_flightinteger
      • completedinteger
      • exitedinteger
      • failedinteger
      • convertedinteger
      • conversion_ratenumber

        Percentage, null when there is no denominator.

      • exits_by_reasonobject

        goal, exit_event, segment, unsubscribed, archived, or the raw reason.

    • nodesarray<object>

      In the tree's order from the trigger.

      • node_idstring
      • typestring
      • labelstring
      • enteredinteger
      • completedinteger
      • skippedinteger
      • convertedinteger
      • in_flightinteger
      • sentinteger

        send_email nodes only.

      • deliveredinteger
      • openedinteger
      • clickedinteger
      • open_ratenumber

        Percentage, null when there is no denominator.

      • click_ratenumber

        Percentage, null when there is no denominator.

      • attributed_conversionsinteger

        Goals reached within the window after this email.

    • as_ofstring

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The 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.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too 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.