API resource
Conversions and tracking links
Server-side conversions with the Ads add-on: send each conversion once and it is forwarded to every ad network you choose, see what was sent and how well it matched, turn on tracking for your website or store, and make tracking links that split-test landing pages and report conversions back to the network. Also store leads from your own forms next to the ones from lead ads.
List stored events
/v1/eventsWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
limitintegerfromstringOnly events at or after this time (ISO 8601, on the event time).
tostringOnly events before this time (ISO 8601, on the event time).
eventNamestringOnly events with this name, such as Purchase.
sourcestringOnly events from this source, such as stripe for the payments of a connected Stripe account. One of: api, relay, hubspot, meta_leads, google_leads, linkedin_leads, tiktok_leads, shopify, woocommerce, stripe, web, salesforce, postback, form_leads.
platformstringOnly events sent to this ad platform, such as metaads or googleads.
deliveryStatusstringOnly events whose latest send to a destination (of platform, when given) was accepted (sent) or was not (failed: failed or still retrying). One of: sent, failed.
fromAdbooleantrue: only events carrying an ad click or a campaign (a gclid, gbraid or wbraid, a zrn, or a matched campaign). false: only the others.
campaignIdstringOnly events of this ad platform campaign id: matched to it, or behind a Google click of it.
cursorstringnextCursor from the previous page.
curl "https://creatoros-production-5658.up.railway.app/v1/events" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"events": [
{
"eventId": "obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9",
"source": "string",
"eventName": "string",
"eventTime": "2026-10-10T00:00:00.000Z",
"receivedAt": "2026-10-10T00:00:00.000Z",
"actionSource": "string",
"value": 0,
"currency": "string",
"sourceUrl": "string",
"utm": {
"source": "string",
"medium": "string",
"campaign": "string",
"content": "string"
},
"zrn": "string",
"clickIds": {
"gclid": "string",
"fbc": "string"
},
"destinationsSent": 0,
"hasEmail": true,
"hasPhone": true,
"hasExternalId": true,
"pairedEventId": "string",
"ad": {
"platform": "social",
"customerId": "string",
"campaignId": "string",
"adGroupId": "string",
"adSetId": "string",
"adId": "string"
},
"campaign": {
"via": "google_click",
"id": "string",
"name": "string",
"adGroupName": "string",
"adName": "string"
},
"counted": true,
"deliveries": [
{}
]
}
],
"nextCursor": "string"
}Send events to every destination
/v1/eventsWorks on: Meta, Google, TikTok, LinkedIn ads
Body
eventsobject[]requireddestinationsobject[]Send to these destinations instead of the saved ones (every event goes to each).
consentobjectBatch-level user consent, forwarded to every destination (see POST /v1/ads/conversions).
testCodestringForwarded as each platform test code (see POST /v1/ads/conversions). A root-level test_event_code is accepted as an alias. Test events are not stored.
modestringsync sends to every destination before answering (200, per-destination results). async stores and queues the sends, then answers 202 at once; each send is retried while the platform fails for now, and its outcome shows on GET /v1/events/{eventId}. Requests with testCode always send now.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/events" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"events": [
{
"eventName": "Purchase",
"eventTime": 1744732800,
"eventId": "order_abc_123",
"value": 99.5,
"currency": "USD",
"user": {
"email": "string",
"phone": "string",
"firstName": "string",
"lastName": "string",
"externalId": "string",
"ipAddress": "string",
"userAgent": "string",
"country": "string",
"city": "string",
"state": "string",
"zip": "string",
"dob": "string",
"gender": "string",
"leadId": "string",
"visitorId": "4f9c2e1a-7b3d-4c8e-9a1f-2d6b5e8c0a73",
"clickIds": {
"fbc": "string",
"fbp": "string",
"gclid": "string",
"gbraid": "string",
"wbraid": "string",
"li_fat_id": "string",
"epik": "string",
"rdt_cid": "string",
"rdt_uuid": "string",
"aleid": "string",
"alart": "string",
"axwrt": "string",
"twclid": "string",
"msclkid": "string",
"sccid": "string",
"scid": "string"
}
},
"items": [
{
"id": "string",
"name": "string",
"price": 0,
"quantity": 0,
"category": "string"
}
],
"sourceUrl": "string",
"campaign": {
"id": "string",
"name": "string"
},
"actionSource": "web",
"messaging": {
"channel": "whatsapp",
"wabaId": "string",
"ctwaClid": "string",
"pageId": "112233445566",
"instagramBusinessAccountId": "string",
"pageScopedUserId": "string",
"instagramScopedUserId": "string"
},
"platformData": {}
}
]
}'{
"eventsReceived": 0,
"stored": true,
"testCode": "string",
"destinations": [
{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"platform": "social",
"eventsSent": 0,
"eventsFailed": 0,
"failures": [
{}
],
"error": "string",
"retrying": true,
"traceId": "string",
"platformMessages": [
"string"
]
}
],
"queuedDestinations": 0
}List the touch paths that lead to conversions
/v1/events/pathsWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
fromDatestringrequiredtoDatestringrequiredInclusive. At most 400 days after fromDate.
limitintegercurl "https://creatoros-production-5658.up.railway.app/v1/events/paths?fromDate=%3CfromDate%3E&toDate=%3CtoDate%3E" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"fromDate": "2026-10-10T00:00:00.000Z",
"toDate": "2026-10-10T00:00:00.000Z",
"paths": [
{
"steps": [
"string"
],
"conversions": 0,
"sales": 0,
"revenue": 0,
"avgDays": 0
}
]
}Get post-purchase survey answers
/v1/events/surveyWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
fromDatestringrequiredFirst day an answer was given.
toDatestringrequiredInclusive. At most 400 days after fromDate.
curl "https://creatoros-production-5658.up.railway.app/v1/events/survey?fromDate=%3CfromDate%3E&toDate=%3CtoDate%3E" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"fromDate": "2026-10-10T00:00:00.000Z",
"toDate": "2026-10-10T00:00:00.000Z",
"answers": [
{
"answer": "Podcast",
"orders": 0,
"revenue": 0
}
]
}Get buyer cohorts by first purchase month and first channel
/v1/events/ltvWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
fromMonthstringrequiredtoMonthstringrequiredcurl "https://creatoros-production-5658.up.railway.app/v1/events/ltv?fromMonth=%3CfromMonth%3E&toMonth=%3CtoMonth%3E" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"fromMonth": "string",
"toMonth": "string",
"cohorts": [
{
"cohort": "2026-09",
"channel": "facebook",
"currency": "string",
"customers": 0,
"revenue": {
"m0": 0,
"m1": 0,
"m3": 0,
"m6": 0,
"m12": 0
}
}
]
}Get delivery accuracy per destination
/v1/events/accuracyWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
periodstringThe window, ending now: today (since 00:00 UTC), or the last 7, 30 or 90 days. One of: today, 7d, 30d, 90d.
curl "https://creatoros-production-5658.up.railway.app/v1/events/accuracy" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"period": "today",
"destinations": [
{
"ruleId": "obj_Ru4Kq8Vw1Nx6Ty3Lm9Rc2Hb7Js5Df0Ga8Ue4Ki1Oq",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"platform": "social",
"accountName": "string",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"sales": 0,
"sent": 0,
"accepted": 0,
"failed": 0,
"retrying": 0,
"notSent": 0,
"accuracy": 0,
"deliveries": {
"events": 0,
"accepted": 0,
"failed": 0,
"retrying": 0
},
"match": {
"events": 0,
"identified": 0,
"email": 0,
"phone": 0,
"externalId": 0,
"clickId": 0
},
"matchRate": 0
}
]
}Get today's tracking overview
/v1/events/overviewWorks on: Meta, Google, TikTok, LinkedIn ads
curl "https://creatoros-production-5658.up.railway.app/v1/events/overview" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"today": {
"conversions": 0,
"value": 0,
"currency": "string",
"sent": 0,
"accepted": 0,
"matched": 0,
"counted": 0
},
"platforms": [
{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"platform": "social",
"accountName": "string",
"destinationName": "string",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"sentToday": 0,
"failedToday": 0,
"lastSentAt": "2026-10-10T00:00:00.000Z",
"lastEventName": "string",
"lastError": "string",
"fixUrl": "string"
}
],
"sources": [
{
"source": "string",
"label": "string",
"state": "on",
"eventsToday": 0,
"lastSeenAt": "2026-10-10T00:00:00.000Z"
}
],
"website": {
"steps": [
{
"name": "string",
"label": "string",
"count": 0
}
],
"recovered": 0,
"conversions": 0,
"consented": 0,
"visits": 0,
"bots": 0,
"serverPlatforms": [
"string"
]
},
"sites": [
{
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"hitsToday": 0,
"lastActiveOn": "string",
"totals": {
"today": {},
"7d": {},
"30d": {}
}
}
],
"eventNames": [
{
"eventName": "string",
"serverSources": [
"string"
],
"fromWebsite": true,
"websiteToday": 0,
"serverToday": 0
}
]
}Get daily tracking figures
/v1/events/overview/dailyWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
periodstringThe days to cover, each ending today (UTC): today, the last 7, 30 or 90 days. One of: today, 7d, 30d, 90d.
eventNamestringOnly events of this name, such as Purchase.
sourcesstringComma-separated sources (web, shopify, stripe, api...). Only events from them.
platformstringOnly sends to this platform (metaads, googleads...), and only the events sent to it.
curl "https://creatoros-production-5658.up.railway.app/v1/events/overview/daily" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"period": "today",
"totals": {
"conversions": 0,
"value": 0,
"valueSent": 0,
"currency": "string",
"sent": 0,
"accepted": 0,
"matched": 0,
"counted": 0,
"fromAds": 0
},
"days": [
{
"day": "string",
"conversions": 0,
"sent": 0,
"accepted": 0,
"value": 0,
"valueSent": 0,
"fromAds": 0,
"matched": 0,
"byEvent": {}
}
],
"eventNames": [
"string"
],
"platforms": [
{
"platform": "social",
"sent": 0,
"accepted": 0,
"days": [
{}
]
}
],
"pixelMissed": [
{
"platform": "social",
"conversions": 0,
"missed": 0,
"days": [
{}
]
}
],
"breakdown": {
"events": [
{
"eventName": "string",
"conversions": 0
}
],
"sources": [
{
"source": "string",
"conversions": 0
}
],
"campaigns": [
{
"platform": "social",
"campaignId": "string",
"name": "string",
"reason": "not_from_an_ad",
"conversions": 0,
"value": 0
}
]
},
"previous": {
"totals": {},
"days": [
{}
],
"pixelMissed": [
{}
]
}
}List stored event names
/v1/events/namesWorks on: Meta, Google, TikTok, LinkedIn ads
curl "https://creatoros-production-5658.up.railway.app/v1/events/names" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"names": [
{
"name": "string",
"events": 0
}
]
}List event destinations
/v1/events/destinationsWorks on: Meta, Google, TikTok, LinkedIn ads
curl "https://creatoros-production-5658.up.railway.app/v1/events/destinations" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"destinations": [
{
"id": "string",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"eventNames": [
"string"
],
"createdAt": "2026-10-10T00:00:00.000Z"
}
]
}Add an event destination
/v1/events/destinationsWorks on: Meta, Google, TikTok, LinkedIn ads
Body
accountIdstringrequiredConnected ads account ID that owns the destination.
destinationIdstringrequiredeventNamesstring[]curl -X POST "https://creatoros-production-5658.up.railway.app/v1/events/destinations" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1"
}'{
"destination": {
"id": "string",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"eventNames": [
"string"
],
"createdAt": "2026-10-10T00:00:00.000Z"
}
}Remove an event destination
/v1/events/destinations/{destinationId}Works on: Meta, Google, TikTok, LinkedIn ads
Path parameters
destinationIdstringrequiredcurl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/events/destinations/obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"deleted": true
}List forwarding rules
/v1/events/forwarding-rulesWorks on: Meta, Google, TikTok, LinkedIn ads
curl "https://creatoros-production-5658.up.railway.app/v1/events/forwarding-rules" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"forwardingRules": [
{
"id": "string",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"eventNames": [
"string"
],
"sources": [
"api"
],
"apiSecretVerified": true,
"createdAt": "2026-10-10T00:00:00.000Z"
}
]
}Add a forwarding rule
/v1/events/forwarding-rulesWorks on: Meta, Google, TikTok, LinkedIn ads
Body
accountIdstringrequiredConnected ads account ID that owns the destination.
destinationIdstringrequiredThe platform destination: a pixel, a conversion action, a conversion rule, or a GA4 web stream measurement id (G-…).
eventNamesstring[]sourcesstring[]Forward only events from these sources, such as only web for a tracked website. Leave it out to forward events from every source.
apiSecretstringGoogle Analytics streams only: the stream's Measurement Protocol API secret (GA4 Admin › Data streams). Optional when the connection has edit access, since Creator OS then creates it. Checked against Google's validation server, stored encrypted, never returned. Change it with PATCH /v1/events/forwarding-rules/{ruleId}.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/events/forwarding-rules" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1"
}'{
"forwardingRule": {
"id": "string",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"eventNames": [
"string"
],
"sources": [
"api"
],
"apiSecretVerified": true,
"createdAt": "2026-10-10T00:00:00.000Z"
}
}Change a forwarding rule's API secret
/v1/events/forwarding-rules/{ruleId}Works on: Meta, Google, TikTok, LinkedIn ads
Path parameters
ruleIdstringrequiredThe rule id.
Body
apiSecretstringrequiredcurl -X PATCH "https://creatoros-production-5658.up.railway.app/v1/events/forwarding-rules/obj_Ru4Kq8Vw1Nx6Ty3Lm9Rc2Hb7Js5Df0Ga8Ue4Ki1Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"apiSecret": "string"
}'{
"forwardingRule": {
"id": "string",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"eventNames": [
"string"
],
"sources": [
"api"
],
"apiSecretVerified": true,
"createdAt": "2026-10-10T00:00:00.000Z"
}
}Remove a forwarding rule
/v1/events/forwarding-rules/{ruleId}Works on: Meta, Google, TikTok, LinkedIn ads
Path parameters
ruleIdstringrequiredThe rule id.
curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/events/forwarding-rules/obj_Ru4Kq8Vw1Nx6Ty3Lm9Rc2Hb7Js5Df0Ga8Ue4Ki1Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"deleted": true
}Get one stored event and its deliveries
/v1/events/{eventId}Works on: Meta, Google, TikTok, LinkedIn ads
Path parameters
eventIdstringrequiredThe eventId the event was sent with.
curl "https://creatoros-production-5658.up.railway.app/v1/events/obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"event": {
"eventId": "obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9",
"source": "string",
"eventName": "string",
"eventTime": "2026-10-10T00:00:00.000Z",
"receivedAt": "2026-10-10T00:00:00.000Z",
"actionSource": "string",
"value": 0,
"currency": "string",
"sourceUrl": "string",
"utm": {
"source": "string",
"medium": "string",
"campaign": "string",
"content": "string"
},
"zrn": "string",
"clickIds": {
"gclid": "string",
"fbc": "string"
},
"destinationsSent": 0,
"hasEmail": true,
"hasPhone": true,
"hasExternalId": true,
"pairedEventId": "string",
"ad": {
"platform": "social",
"customerId": "string",
"campaignId": "string",
"adGroupId": "string",
"adSetId": "string",
"adId": "string"
},
"campaign": {
"via": "google_click",
"id": "string",
"name": "string",
"adGroupName": "string",
"adName": "string"
},
"counted": true
},
"deliveries": [
{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"platform": "social",
"status": "sent",
"attempt": 0,
"error": "string",
"errorCode": "string",
"sentAt": "2026-10-10T00:00:00.000Z"
}
],
"touches": [
{
"at": "2026-10-10T00:00:00.000Z",
"kind": "ad_click",
"platform": "social",
"adAccountId": "string",
"campaignId": "string",
"campaignName": "string",
"detail": {
"referrer": "string",
"page": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"eventName": "string",
"answer": "string"
},
"credit": {}
}
],
"after": [
{
"eventId": "obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9",
"eventName": "string",
"source": "string",
"eventTime": "2026-10-10T00:00:00.000Z",
"value": 0,
"currency": "string"
}
]
}Change a stored event's value
/v1/events/{eventId}Works on: Meta, Google, TikTok, LinkedIn ads
Path parameters
eventIdstringrequiredThe eventId the event was sent with.
Body
valuenumberrequiredThe corrected total value.
currencystringISO 4217 code such as USD. Defaults to the currency the event was sent with.
curl -X PATCH "https://creatoros-production-5658.up.railway.app/v1/events/obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"value": 0
}'{
"eventId": "obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9",
"value": 0,
"destinations": [
{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"platform": "social",
"status": "corrected",
"error": "string"
}
]
}Retract a stored event
/v1/events/{eventId}Works on: Meta, Google, TikTok, LinkedIn ads
Path parameters
eventIdstringrequiredThe eventId the event was sent with.
curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/events/obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"eventId": "obj_Ev2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9",
"deleted": true,
"destinations": [
{
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"destinationId": "obj_Ds8Kq3Vw6Nx1Ty9Lm4Rc7Hb2Js5Df0Ga3Ue8Ki6Oq1",
"platform": "social",
"status": "corrected",
"error": "string"
}
]
}List tracking sites
/v1/tracking-sitesWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
limitintegercursorstringpagination.nextCursor from the previous page.
curl "https://creatoros-production-5658.up.railway.app/v1/tracking-sites" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"sites": [
{
"id": "string",
"name": "string",
"status": "active",
"install": {
"method": "shopify",
"storeAccountId": "string",
"snippet": "string"
},
"storeOrders": true,
"siteKey": "string",
"domains": [
"string"
],
"customHostname": {
"hostname": "string",
"status": "pending",
"dnsRecord": {}
},
"proxy": {
"path": "string",
"secret": "string",
"googleTags": []
},
"googleTagIds": [
"string"
],
"consentMode": "eu_opt_in",
"checks": [
{}
],
"setup": {
"status": "pending"
},
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
],
"pagination": {
"nextCursor": "string"
}
}Turn on server-side tracking for a website
/v1/tracking-sitesWorks on: Meta, Google, TikTok, LinkedIn ads
Body
storeAccountIdstringrequiredA Shopify, WordPress, Wix or Webflow account connected to the profile.
urlstringThe store's public address, when it differs from the one the store reports.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/tracking-sites" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"storeAccountId": "string"
}'{
"site": {
"id": "string",
"name": "string",
"status": "active",
"install": {
"method": "shopify",
"storeAccountId": "string",
"snippet": "string"
},
"storeOrders": true,
"siteKey": "string",
"domains": [
"string"
],
"customHostname": {
"hostname": "string",
"status": "pending",
"dnsRecord": {
"type": "CNAME",
"name": "string",
"target": "string"
}
},
"proxy": {
"path": "string",
"secret": "string",
"googleTags": [
{}
]
},
"googleTagIds": [
"string"
],
"consentMode": "eu_opt_in",
"checks": [
{
"key": "string",
"status": "pending",
"detail": "string",
"checkedAt": "2026-10-10T00:00:00.000Z"
}
],
"setup": {
"status": "pending"
},
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Get a tracking site
/v1/tracking-sites/{siteId}Works on: Meta, Google, TikTok, LinkedIn ads
curl "https://creatoros-production-5658.up.railway.app/v1/tracking-sites/obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"site": {
"id": "string",
"name": "string",
"status": "active",
"install": {
"method": "shopify",
"storeAccountId": "string",
"snippet": "string"
},
"storeOrders": true,
"siteKey": "string",
"domains": [
"string"
],
"customHostname": {
"hostname": "string",
"status": "pending",
"dnsRecord": {
"type": "CNAME",
"name": "string",
"target": "string"
}
},
"proxy": {
"path": "string",
"secret": "string",
"googleTags": [
{}
]
},
"googleTagIds": [
"string"
],
"consentMode": "eu_opt_in",
"checks": [
{
"key": "string",
"status": "pending",
"detail": "string",
"checkedAt": "2026-10-10T00:00:00.000Z"
}
],
"setup": {
"status": "pending"
},
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Update a tracking site
/v1/tracking-sites/{siteId}Works on: Meta, Google, TikTok, LinkedIn ads
Body
namestringdomainsstring[]Hosts allowed to send events, such as brand.com. Events from any other origin are dropped.
consentModestringHow a visitor with no consent signal is treated. eu_opt_in (default): no consent in the EU, UK and other countries that require it, consent elsewhere. opt_in: no consent anywhere. opt_out: consent everywhere.
customHostnamestringA subdomain of one of the site's domains, never the domain itself. null removes it.
proxyPathstringThe path your server forwards to the collector, such as /zt. null removes it.
googleTagIdsstring[]Google tag ids such as GTM-XXXXXXX, G-XXXXXXXXXX or AW-XXXXXXXXXX, up to 10. null or [] removes them.
curl -X PATCH "https://creatoros-production-5658.up.railway.app/v1/tracking-sites/obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'{
"site": {
"id": "string",
"name": "string",
"status": "active",
"install": {
"method": "shopify",
"storeAccountId": "string",
"snippet": "string"
},
"storeOrders": true,
"siteKey": "string",
"domains": [
"string"
],
"customHostname": {
"hostname": "string",
"status": "pending",
"dnsRecord": {
"type": "CNAME",
"name": "string",
"target": "string"
}
},
"proxy": {
"path": "string",
"secret": "string",
"googleTags": [
{}
]
},
"googleTagIds": [
"string"
],
"consentMode": "eu_opt_in",
"checks": [
{
"key": "string",
"status": "pending",
"detail": "string",
"checkedAt": "2026-10-10T00:00:00.000Z"
}
],
"setup": {
"status": "pending"
},
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Delete a tracking site
/v1/tracking-sites/{siteId}Works on: Meta, Google, TikTok, LinkedIn ads
curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/tracking-sites/obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"ok": true
}Rotate a tracking site's key
/v1/tracking-sites/{siteId}/rotate-keyWorks on: Meta, Google, TikTok, LinkedIn ads
Path parameters
siteIdstringrequiredcurl -X POST "https://creatoros-production-5658.up.railway.app/v1/tracking-sites/obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq/rotate-key" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"site": {
"id": "string",
"name": "string",
"status": "active",
"install": {
"method": "shopify",
"storeAccountId": "string",
"snippet": "string"
},
"storeOrders": true,
"siteKey": "string",
"domains": [
"string"
],
"customHostname": {
"hostname": "string",
"status": "pending",
"dnsRecord": {
"type": "CNAME",
"name": "string",
"target": "string"
}
},
"proxy": {
"path": "string",
"secret": "string",
"googleTags": [
{}
]
},
"googleTagIds": [
"string"
],
"consentMode": "eu_opt_in",
"checks": [
{
"key": "string",
"status": "pending",
"detail": "string",
"checkedAt": "2026-10-10T00:00:00.000Z"
}
],
"setup": {
"status": "pending"
},
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}List tracking links
/v1/tracking-linksWorks on: Meta, Google, TikTok, LinkedIn ads
Query parameters
siteIdstringlimitintegercursorstringpagination.nextCursor from the previous page.
curl "https://creatoros-production-5658.up.railway.app/v1/tracking-links" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"links": [
{
"id": "string",
"name": "string",
"code": "string",
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"status": "active",
"destinations": [
{}
],
"campaign": {
"platform": "social",
"campaignId": "string",
"utmCampaign": "string"
},
"url": "string",
"postbackUrl": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
],
"pagination": {
"nextCursor": "string"
}
}Create a tracking link
/v1/tracking-linksWorks on: Meta, Google, TikTok, LinkedIn ads
Body
siteIdstringrequiredThe tracking site the link belongs to. The link takes its profile.
namestringrequireddestinationsobject[]requiredcampaignobjectHints that conversions from this link use to match a campaign. Every field is optional.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/tracking-links" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"name": "string",
"destinations": [
{
"url": "string",
"weight": 0
}
]
}'{
"link": {
"id": "string",
"name": "string",
"code": "string",
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"status": "active",
"destinations": [
{
"url": "string",
"weight": 0
}
],
"campaign": {
"platform": "social",
"campaignId": "string",
"utmCampaign": "string"
},
"url": "string",
"postbackUrl": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Get a tracking link
/v1/tracking-links/{linkId}Works on: Meta, Google, TikTok, LinkedIn ads
curl "https://creatoros-production-5658.up.railway.app/v1/tracking-links/obj_Lk6Tn2Vw9Kx4Ry1Lm8Qc5Hb3Js7Df0Ga2Ue6Ki9Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"link": {
"id": "string",
"name": "string",
"code": "string",
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"status": "active",
"destinations": [
{
"url": "string",
"weight": 0
}
],
"campaign": {
"platform": "social",
"campaignId": "string",
"utmCampaign": "string"
},
"url": "string",
"postbackUrl": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Update a tracking link
/v1/tracking-links/{linkId}Works on: Meta, Google, TikTok, LinkedIn ads
Body
namestringdestinationsobject[]campaignobjectstatusstringcurl -X PATCH "https://creatoros-production-5658.up.railway.app/v1/tracking-links/obj_Lk6Tn2Vw9Kx4Ry1Lm8Qc5Hb3Js7Df0Ga2Ue6Ki9Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'{
"link": {
"id": "string",
"name": "string",
"code": "string",
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"status": "active",
"destinations": [
{
"url": "string",
"weight": 0
}
],
"campaign": {
"platform": "social",
"campaignId": "string",
"utmCampaign": "string"
},
"url": "string",
"postbackUrl": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Delete a tracking link
/v1/tracking-links/{linkId}Works on: Meta, Google, TikTok, LinkedIn ads
curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/tracking-links/obj_Lk6Tn2Vw9Kx4Ry1Lm8Qc5Hb3Js7Df0Ga2Ue6Ki9Oq" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"ok": true
}Rotate a tracking link's postback URL
/v1/tracking-links/{linkId}/rotate-postback-tokenWorks on: Meta, Google, TikTok, LinkedIn ads
Path parameters
linkIdstringrequiredcurl -X POST "https://creatoros-production-5658.up.railway.app/v1/tracking-links/obj_Lk6Tn2Vw9Kx4Ry1Lm8Qc5Hb3Js7Df0Ga2Ue6Ki9Oq/rotate-postback-token" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"link": {
"id": "string",
"name": "string",
"code": "string",
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq",
"status": "active",
"destinations": [
{
"url": "string",
"weight": 0
}
],
"campaign": {
"platform": "social",
"campaignId": "string",
"utmCampaign": "string"
},
"url": "string",
"postbackUrl": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z"
}
}Get a tracking link's results
/v1/tracking-links/{linkId}/statsWorks on: Meta, Google, TikTok, LinkedIn ads
Path parameters
linkIdstringrequiredQuery parameters
fromDatestringrequiredFirst day of the range, YYYY-MM-DD.
toDatestringrequiredLast day of the range, YYYY-MM-DD.
curl "https://creatoros-production-5658.up.railway.app/v1/tracking-links/obj_Lk6Tn2Vw9Kx4Ry1Lm8Qc5Hb3Js7Df0Ga2Ue6Ki9Oq/stats?fromDate=%3CfromDate%3E&toDate=%3CtoDate%3E" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"fromDate": "2026-10-10T00:00:00.000Z",
"toDate": "2026-10-10T00:00:00.000Z",
"clicks": 0,
"conversions": 0,
"conversionRate": 0,
"revenue": [
{
"currency": "string",
"amount": 0,
"conversions": 0
}
],
"destinations": [
{
"url": "string",
"weight": 0,
"clicks": 0
}
],
"formerDestinationClicks": 0
}Create a lead from your own form
/v1/leadsWorks on: Meta, Google, TikTok, LinkedIn ads
Body
emailstringRequired unless phone is given.
phonestringRequired unless email is given. E.164 is best.
fieldsobjectOther answers, field name to value (full_name, company, ...). Stored on the lead, never sent to an ad platform.
formIdstringYour id for the form. Defaults to api.
formNamestringleadIdstringYour id for this lead (a CRM id, a submission id). Makes the call idempotent.
submittedAtstringWhen the form was submitted. Defaults to now.
sourceUrlstringThe page the form was submitted on, with its query string.
visitorIdstringThe Creator OS tag visitor id, from the _zid cookie.
clickIdsobjectAd click and browser ids: fbclid or fbc, fbp, gclid, gbraid, wbraid, ttclid, msclkid, li_fat_id, ...
utmobjectutm_source, utm_campaign, ...
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/leads" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "string"
}'{
"lead": {
"id": "string",
"platform": "social",
"leadgenId": "string",
"formId": "string",
"formName": "string",
"accountId": "acc_uwsum2TkX6QB7M2BWX_F2kYykNTaWuC3V2Spge_Xm4r",
"adId": "string",
"adsetId": "string",
"campaignId": "string",
"isOrganic": true,
"createdTime": "2026-10-10T00:00:00.000Z",
"fields": {},
"fieldData": [
{}
],
"consents": [
{
"checkboxKey": "string",
"isChecked": true
}
],
"contentNotRetained": true,
"status": "new",
"statusChangedAt": "2026-10-10T00:00:00.000Z",
"value": 0,
"currency": "string",
"contactId": "obj_Ct9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq4C",
"firstContactedAt": "2026-10-10T00:00:00.000Z",
"conversationId": "conv_M4nB7vC1xZ9lK3jH6gF2dS8aP5oI0uY7tR4eW1qQ6",
"webhookDeliveredAt": "2026-10-10T00:00:00.000Z",
"attribution": {
"clickIds": {},
"utm": {},
"visitorId": "string",
"sourceUrl": "string",
"siteId": "obj_St9Wm3Kq1Vz6Ny4Lb8Hc2Jr5Pd0Fs7Ga3Ue9Ki1Oq"
}
},
"created": true
}