List runs (status filter, incl. derived "suppressed")

Requires VIEWER.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

required

string

Automation (journey) identifier.

Query Parameters

status

string

Instance status, or the special value suppressed (runs with a suppressed effect_outbox row).

Responses

200

Run (journey_instance) rows.

application/json

object

runs

Array<object>

A journey_instances row (an automation run).

object

string

projectId

string

journeyId

string

journeyVersionId

string

userId

string

status

string

currentNodeId

string | null

contextJson

string

startedAt

string

completedAt

string | null

terminatedAt

string | null

updatedAt

string

key

additional properties

any

400

Missing/invalid path input (e.g. projectId) or invalid JSON body.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

GET

/api/projects/{projectId}/automations/{id}/runs

1
curl --request GET \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/runs \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/runs';
2
const options = {method: 'GET', headers: {cookie: 'trackly_session=%3CYOUR_API_KEY%3E'}};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/runs"
4

5
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
6

7
response = requests.get(url, headers=headers)
8

9
print(response.json())

1
import httpx
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/runs"
4

5
cookies = {"trackly_session": "<YOUR_API_KEY>"}
6

7
response = httpx.get(url, cookies=cookies)
8

9
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "net/http"
6
  "io"
7
)
8

9
func main() {
10

11
  url := "https://retidal.com/api/projects/%3Cstring%3E/automations/%3Cstring%3E/runs"
12

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

15
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
16

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

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

22
  fmt.Println(res)
23
  fmt.Println(string(body))
24

25
}

200Run (journey_instance) rows.

1
{
2
  "runs": [
3
    {
4
      "id": "example",
5
      "projectId": "example",
6
      "journeyId": "example",
7
      "journeyVersionId": "example",
8
      "userId": "example",
9
      "status": "example",
10
      "currentNodeId": "example",
11
      "contextJson": "example",
12
      "startedAt": "example",
13
      "completedAt": "example",
14
      "terminatedAt": "example",
15
      "updatedAt": "example"
16
    }
17
  ]
18
}

List runs (status filter, incl. derived "suppressed")

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

400

Examplegenerated

403

Examplegenerated

Example^generated

Example^generated