Experiments a automation

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

Parameters

NameInTypeDescription
automationrequiredpathstringThe automation identifier.

Request

GET/api/v1/automations/{automation}/experiments
curl -X GET 'https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/experiments' \
  -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
    • experimentsarray<object>
      • node_idstring
      • metricstringclicked | opened | converted
      • promotedstring

        The winning variant key once promoted.

      • variantsarray<object>
        • keystring
        • labelstring
        • percentinteger
        • enteredinteger
        • sentinteger
        • deliveredinteger
        • openedinteger
        • clickedinteger
        • convertedinteger
        • ratenumber

          The metric as a percentage.

      • verdictobject
        • statusstringwinner | not_enough_data | no_difference
        • leaderstring
        • confidencenumber

          Two-sided confidence from a two-proportion z-test, 0–1.

        • messagestring

          The verdict in plain words.

        • needed_moreinteger

          Roughly how many more sends per variant would settle it.

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