Update a pixel config (ADMIN, alias of PUT)

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

platformId

required

string

Request Body^required

application/json

Partial update; at least one field required. Masked credential values (••••••…) are ignored.

object

>= 1 properties

name

string

>= 1 characters

credentials

object

key

additional properties

string

>= 1 characters

eventMapping

object | null

isActive

boolean

Example^generated

1
{
2
  "name": "example",
3
  "credentials": {
4
    "additionalProperty": "example"
5
  },
6
  "eventMapping": "example",
7
  "isActive": true
8
}

Responses

200

{ updated, platform }. Some keys are dynamic — Byte-identical response contract to analyticsUpdatePlatform — literally the same handler function registered for both app.put and app.patch. Credentials masked, no plaintext.

application/json

object

updated

required

integer

Allowed values: 1

platform

required

object

required

string

projectId

required

string

platform

required

string

Allowed values: BAIDU DOUYIN TENCENT KUAISHOU XIAOHONGSHU BILIBILI WEIBO GOOGLE META TIKTOK BING TWITTER LINKEDIN SNAPCHAT PINTEREST KWAI GOOGLE_MEASUREMENT BIGO TRAFFICSTARS TRAFFICJUNKY PROPELLERADS DEEPCLICK MGSKY ADJUST XIAOBU OKSPIN SNAPTUBE APPLUCK MACAN

name

required

string

credentials

required

REDACTED. Keys are the stored credential field names (dynamic per platform); each value is “••••••” optionally suffixed with the last 4 characters of the decrypted secret. Never full plaintext.

object

key

additional properties

string

eventMapping

required

Dynamic map of internal event name -> platform event name; may be {}.

object

key

additional properties

string

isActive

required

boolean

lastError

required

string

nullable

createdAt

required

ISO-8601 UTC timestamp.

string

updatedAt

required

ISO-8601 UTC timestamp.

string

404

Platform not found

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

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

PATCH

/api/projects/{projectId}/platforms/{platformId}

1
curl --request PATCH \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/platforms/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "credentials": {},
8
  "eventMapping": {},
9
  "isActive": true
10
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/platforms/%3Cstring%3E';
2
const options = {
3
  method: 'PATCH',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","credentials":{},"eventMapping":{},"isActive":true}'
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/platforms/%3Cstring%3E"
4

5
payload = {
6
    "name": "<string>",
7
    "credentials": {},
8
    "eventMapping": {},
9
    "isActive": True
10
}
11
headers = {
12
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
13
    "Content-Type": "application/json"
14
}
15

16
response = requests.patch(url, json=payload, headers=headers)
17

18
print(response.json())

1
import httpx
2
import json
3

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

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

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"credentials\": {},\n  \"eventMapping\": {},\n  \"isActive\": true\n}")
9

10
response = httpx.patch(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/platforms/%3Cstring%3E"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"credentials\": {},\n  \"eventMapping\": {},\n  \"isActive\": true\n}")
15

16
  req, _ := http.NewRequest("PATCH", 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
}

200{ updated, platform }. Some keys are dynamic — Byte-identical response contract to analyticsUpdatePlatform — literally the same handler function registered for both app.put and app.patch. Credentials masked, no plaintext.

1
{
2
  "updated": 1,
3
  "platform": {
4
    "platform": "BAIDU"
5
  }
6
}

Update a pixel config (ADMIN, alias of PUT)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

404

Examplegenerated

Request Body^required

Example^generated

Example^generated