An automation's numbers

GEThttps://api.norreach.app/v1/automations/{id}/analytics

Per compiled step: sent, delivered, opened, clicked, failed, bounced; the replies it got; and the funnel — how many contacts ran and wait at each step, how many are in progress or need attention.

campaigns:readOperation id: get_automation_analytics

GET/automations/{id}/analytics

curl -X GET "https://api.norreach.app/v1/automations/{id}/analytics" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

An automation's numbers

{
  "object": "automation_analytics",
  "automation_id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
  "by_step": [
    {
      "step_index": 0,
      "sent": 40,
      "delivered": 39,
      "opened": 18,
      "clicked": 3,
      "failed": 0,
      "bounced": 1
    }
  ],
  "totals": {
    "sent": 40,
    "delivered": 39,
    "opened": 18,
    "clicked": 3,
    "failed": 0,
    "bounced": 1
  },
  "replies": 5,
  "funnel": {
    "total": 42,
    "in_progress": 30,
    "needs_attention": 1,
    "passed": [
      40
    ],
    "waiting": [
      2
    ]
  }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope campaigns:read. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Response

200application/json— An automation's numbers

object"automation_analytics"required

automation_idstring (uuid)required

An id (UUID).

by_stepobject[]required

Show child attributes

by_step[].step_indexintegerrequired

by_step[].sentintegerrequired

by_step[].deliveredintegerrequired

by_step[].openedintegerrequired

by_step[].clickedintegerrequired

by_step[].failedintegerrequired

by_step[].bouncedintegerrequired

totalsobjectrequired

Show child attributes

totals.sentintegerrequired

totals.deliveredintegerrequired

totals.openedintegerrequired

totals.clickedintegerrequired

totals.failedintegerrequired

totals.bouncedintegerrequired

repliesintegerrequired

funnelobjectrequired

Show child attributes

funnel.totalintegerrequired

funnel.in_progressintegerrequired

funnel.needs_attentionintegerrequired

funnel.passedinteger[]required

Contacts that ran each compiled step.

funnel.waitinginteger[]required

Contacts waiting at each compiled step.

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
404	`not_found`	That doesn't exist.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/automations/{id}/analytics

curl -X GET "https://api.norreach.app/v1/automations/{id}/analytics" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

An automation's numbers

{
  "object": "automation_analytics",
  "automation_id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
  "by_step": [
    {
      "step_index": 0,
      "sent": 40,
      "delivered": 39,
      "opened": 18,
      "clicked": 3,
      "failed": 0,
      "bounced": 1
    }
  ],
  "totals": {
    "sent": 40,
    "delivered": 39,
    "opened": 18,
    "clicked": 3,
    "failed": 0,
    "bounced": 1
  },
  "replies": 5,
  "funnel": {
    "total": 42,
    "in_progress": 30,
    "needs_attention": 1,
    "passed": [
      40
    ],
    "waiting": [
      2
    ]
  }
}