List automations with their 30-day performance

GET

/api/v1/workspaces/{workspace}/automations

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations?status=all"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations?status=all';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/automations?status=all' \
  --header 'Authorization: Bearer <token>'

Permission: automations:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Query Parameters

status

string

default: all

Allowed values: all live paused drafts

Responses

200

application/json

object

alerts

required

Array<object>

object

actions

required

Array<object>

object

kind

required

string

Allowed values: open_step step_log providers routing

label

required

string

nodeId

string

automation

required

string

automationId

required

string

detail

required

string

failures

required

integer format: int64

required

string

kind

required

string

Allowed values: sending_held step_failing

nodeId

string

since

required

string format: date-time

title

required

string

counts

required

object

all

required

integer format: int64

drafts

required

integer format: int64

live

required

integer format: int64

paused

required

integer format: int64

days

required

integer format: int64

items

required

Array<object>

object

channelCost

number format: double

channels

required

Array<string>

completed

% of entrants who finished the flow (goal or end)

number format: double

description

required

string

draftVersion

required

integer format: int64

entered

integer format: int64

goal

object

label

required

string

percent

Contacts who reached the goal, % of those who entered in the window

number format: double

humanOpens

Human opens, % of delivered

number format: double

required

string

inFlow

integer format: int64

liveVersion

integer format: int64

name

required

string

pauseReason

string

pausedAt

string format: date-time

pausedBy

string

publishedAt

string format: date-time

revenue

object

currency

required

string

orders

required

integer format: int64

revenue

required

In minor units of the currency

integer format: int64

status

required

string

Allowed values: draft live paused

steps

required

integer format: int64

trigger

required

string

unpublishedChanges

required

boolean

route

required

object

fallback

object

adapter

required

string

detail

string

downReason

string

downSince

string format: date-time

required

string

lastErrorStatus

integer format: int64

name

required

string

short

required

string

status

required

Healthy, degraded, down, sandbox, warming_up or paused

string

weight

integer format: int64

healthy

required

A provider on the route can send right now

boolean

label

required

string

primary

required

Array<object>

object

adapter

required

string

detail

string

downReason

string

downSince

string format: date-time

required

string

lastErrorStatus

integer format: int64

name

required

string

short

required

string

status

required

Healthy, degraded, down, sandbox, warming_up or paused

string

weight

integer format: int64

Example

{
  "alerts": [
    {
      "actions": [
        {
          "kind": "open_step",
          "label": "Open the step"
        }
      ],
      "kind": "sending_held"
    }
  ],
  "items": [
    {
      "goal": {
        "label": "Clicked docs"
      },
      "status": "draft"
    }
  ],
  "route": {
    "fallback": {
      "name": "Amazon SES",
      "short": "SES"
    },
    "label": "SES, failover Postmark",
    "primary": [
      {
        "name": "Amazon SES",
        "short": "SES"
      }
    ]
  }
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}