List email campaigns

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Tenant project id (row-level isolation on every query).

Query Parameters

status

string

Filter by campaign status.

limit

integer

default: 20 >= 1 <= 100

Responses

200

Campaigns.

application/json

object

campaigns

Array<object>

Email campaign (serialized). See handler for the full field set.

object

string

projectId

string

name

string

status

string

Allowed values: draft queued expanding sending paused completed aborted

templateId

string

providerId

string | null

identityId

string | null

audienceFilter

Segment predicate shared by campaigns and trigger userFilter (all fields optional).

object

locale

One of:

string
Array<string>

string

hasEmail

boolean

hasPhone

boolean

userIdLike

string

firstSeenFrom

string format: date-time

firstSeenTo

string format: date-time

lastSeenFrom

string format: date-time

lastSeenTo

string format: date-time

savedAudienceId

string

queueKey

string

Allowed values: new_paid_activation key_created_low_usage high_balance_inactive high_value low_balance_renewal churn_risk_paid

paidStatus

One of:

string
Array<string>

string

valueTier

One of:

string
Array<string>

string

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string format: date-time

lastPurchaseTo

string format: date-time

lifecycleStage

One of:

string
Array<string>

string

recommendedAction

One of:

string
Array<string>

string

variables

object | null

estimatedRecipients

integer

suppressionPreview

integer

sendRatePerSecond

integer

scheduledAt

string | null format: date-time

launchAt

string | null format: date-time

expandedCount

integer

sentCount

integer

deliveredCount

integer

openedCount

integer

clickedCount

integer

failedCount

integer

suppressedCount

integer

abortedReason

string | null

quotaDeferredCount

integer

lastQuotaDeferredAt

string | null format: date-time

createdBy

string | null

createdAt

string format: date-time

updatedAt

string format: date-time

startedAt

string | null format: date-time

completedAt

string | null format: date-time

401

Not authenticated (no valid session/principal).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

403

Authenticated but lacks the required project role.

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}/email/campaigns

1
curl --request GET \
2
  --url 'https://retidal.com/api/projects/%3Cstring%3E/email/campaigns?limit=20' \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/campaigns?limit=20';
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/email/campaigns"
4

5
querystring = {"limit":"20"}
6

7
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
8

9
response = requests.get(url, headers=headers, params=querystring)
10

11
print(response.json())

1
import httpx
2

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

5
params = [("limit", "20")]
6

7
cookies = {"trackly_session": "<YOUR_API_KEY>"}
8

9
response = httpx.get(url, params=params, cookies=cookies)
10

11
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/email/campaigns?limit=20"
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
}

200Campaigns.

1
{
2
  "campaigns": [
3
    {
4
      "status": "draft",
5
      "audienceFilter": {
6
        "queueKey": "new_paid_activation"
7
      }
8
    }
9
  ]
10
}

List email campaigns

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

401

Examplegenerated

403

Examplegenerated

Example^generated

Example^generated