Preview a campaign's audience

Returns recipient/suppression counts, ETA, and a localeCoverageWarning.

Omit the request body entirely to preview against the campaign’s stored audience filter. If a body is sent it must contain audienceFilter — an empty object {} is rejected with 400 (the schema is .strict() and the field is not optional).

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

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

campaignId

required

string

Campaign id.

Request Body

application/json

object

audienceFilter

required

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

Responses

200

Preview counts + localeCoverageWarning.

application/json

object

total

integer

suppressionPreview

integer

eligible

integer

willReceive

integer

etaSeconds

integer

localeCoverageWarning

object

key

additional properties

any

400

Invalid JSON or preview parameters.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

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
}

404

Resource not found (or belongs to another project — indistinguishable).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

POST

/api/projects/{projectId}/email/campaigns/{campaignId}/preview

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/email/campaigns/%3Cstring%3E/preview \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "audienceFilter": {
7
    "locale": "<string>",
8
    "hasEmail": true,
9
    "hasPhone": true,
10
    "userIdLike": "<string>",
11
    "firstSeenFrom": "<string>",
12
    "firstSeenTo": "<string>",
13
    "lastSeenFrom": "<string>",
14
    "lastSeenTo": "<string>",
15
    "savedAudienceId": "<string>",
16
    "queueKey": "new_paid_activation",
17
    "paidStatus": "<string>",
18
    "valueTier": "<string>",
19
    "minLtv": 0,
20
    "maxLtv": 0,
21
    "minBalance": 0,
22
    "maxBalance": 0,
23
    "minUsage30d": 0,
24
    "maxUsage30d": 0,
25
    "lastPurchaseFrom": "<string>",
26
    "lastPurchaseTo": "<string>",
27
    "lifecycleStage": "<string>",
28
    "recommendedAction": "<string>"
29
  }
30
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/email/campaigns/%3Cstring%3E/preview';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"audienceFilter":{"locale":"<string>","hasEmail":true,"hasPhone":true,"userIdLike":"<string>","firstSeenFrom":"<string>","firstSeenTo":"<string>","lastSeenFrom":"<string>","lastSeenTo":"<string>","savedAudienceId":"<string>","queueKey":"new_paid_activation","paidStatus":"<string>","valueTier":"<string>","minLtv":0,"maxLtv":0,"minBalance":0,"maxBalance":0,"minUsage30d":0,"maxUsage30d":0,"lastPurchaseFrom":"<string>","lastPurchaseTo":"<string>","lifecycleStage":"<string>","recommendedAction":"<string>"}}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

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

5
payload = { "audienceFilter": {
6
        "locale": "<string>",
7
        "hasEmail": True,
8
        "hasPhone": True,
9
        "userIdLike": "<string>",
10
        "firstSeenFrom": "<string>",
11
        "firstSeenTo": "<string>",
12
        "lastSeenFrom": "<string>",
13
        "lastSeenTo": "<string>",
14
        "savedAudienceId": "<string>",
15
        "queueKey": "new_paid_activation",
16
        "paidStatus": "<string>",
17
        "valueTier": "<string>",
18
        "minLtv": 0,
19
        "maxLtv": 0,
20
        "minBalance": 0,
21
        "maxBalance": 0,
22
        "minUsage30d": 0,
23
        "maxUsage30d": 0,
24
        "lastPurchaseFrom": "<string>",
25
        "lastPurchaseTo": "<string>",
26
        "lifecycleStage": "<string>",
27
        "recommendedAction": "<string>"
28
    } }
29
headers = {
30
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
31
    "Content-Type": "application/json"
32
}
33

34
response = requests.post(url, json=payload, headers=headers)
35

36
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"audienceFilter\": {\n    \"locale\": \"<string>\",\n    \"hasEmail\": true,\n    \"hasPhone\": true,\n    \"userIdLike\": \"<string>\",\n    \"firstSeenFrom\": \"<string>\",\n    \"firstSeenTo\": \"<string>\",\n    \"lastSeenFrom\": \"<string>\",\n    \"lastSeenTo\": \"<string>\",\n    \"savedAudienceId\": \"<string>\",\n    \"queueKey\": \"new_paid_activation\",\n    \"paidStatus\": \"<string>\",\n    \"valueTier\": \"<string>\",\n    \"minLtv\": 0,\n    \"maxLtv\": 0,\n    \"minBalance\": 0,\n    \"maxBalance\": 0,\n    \"minUsage30d\": 0,\n    \"maxUsage30d\": 0,\n    \"lastPurchaseFrom\": \"<string>\",\n    \"lastPurchaseTo\": \"<string>\",\n    \"lifecycleStage\": \"<string>\",\n    \"recommendedAction\": \"<string>\"\n  }\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

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

10
func main() {
11

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

14
  payload := strings.NewReader("{\n  \"audienceFilter\": {\n    \"locale\": \"<string>\",\n    \"hasEmail\": true,\n    \"hasPhone\": true,\n    \"userIdLike\": \"<string>\",\n    \"firstSeenFrom\": \"<string>\",\n    \"firstSeenTo\": \"<string>\",\n    \"lastSeenFrom\": \"<string>\",\n    \"lastSeenTo\": \"<string>\",\n    \"savedAudienceId\": \"<string>\",\n    \"queueKey\": \"new_paid_activation\",\n    \"paidStatus\": \"<string>\",\n    \"valueTier\": \"<string>\",\n    \"minLtv\": 0,\n    \"maxLtv\": 0,\n    \"minBalance\": 0,\n    \"maxBalance\": 0,\n    \"minUsage30d\": 0,\n    \"maxUsage30d\": 0,\n    \"lastPurchaseFrom\": \"<string>\",\n    \"lastPurchaseTo\": \"<string>\",\n    \"lifecycleStage\": \"<string>\",\n    \"recommendedAction\": \"<string>\"\n  }\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

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

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

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

200Preview counts + localeCoverageWarning.

1
{
2
  "total": 1,
3
  "suppressionPreview": 1,
4
  "eligible": 1,
5
  "willReceive": 1,
6
  "etaSeconds": 1,
7
  "localeCoverageWarning": {}
8
}

Preview a campaign's audience

Authorizations

Parameters

Path Parameters

Request Body

Responses

200

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated