Create a saved audience

Requires EDITOR.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

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

Request Body^required

application/json

object

name

required

string

description

string | null

source

string

default: value_users

audienceType

string

default: dynamic

estimatedCount

integer

filter

Audience filter object; also accepts filterJson (string).

filterJson

string

Responses

201

Created audience.

application/json

object

audience

object

key

additional properties

any

400

Empty name or invalid JSON.

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
}

409

Duplicate audience name.

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}/saved-audiences

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/saved-audiences \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "description": "<string>",
8
  "source": "value_users",
9
  "audienceType": "dynamic",
10
  "estimatedCount": 0,
11
  "filter": "<string>",
12
  "filterJson": "<string>"
13
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/saved-audiences';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","description":"<string>","source":"value_users","audienceType":"dynamic","estimatedCount":0,"filter":"<string>","filterJson":"<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/saved-audiences"
4

5
payload = {
6
    "name": "<string>",
7
    "description": "<string>",
8
    "source": "value_users",
9
    "audienceType": "dynamic",
10
    "estimatedCount": 0,
11
    "filter": "<string>",
12
    "filterJson": "<string>"
13
}
14
headers = {
15
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
16
    "Content-Type": "application/json"
17
}
18

19
response = requests.post(url, json=payload, headers=headers)
20

21
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/saved-audiences"
5

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"source\": \"value_users\",\n  \"audienceType\": \"dynamic\",\n  \"estimatedCount\": 0,\n  \"filter\": \"<string>\",\n  \"filterJson\": \"<string>\"\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/saved-audiences"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"source\": \"value_users\",\n  \"audienceType\": \"dynamic\",\n  \"estimatedCount\": 0,\n  \"filter\": \"<string>\",\n  \"filterJson\": \"<string>\"\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
}

201Created audience.

1
{
2
  "audience": {}
3
}

Create a saved audience

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

409

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated