ads API reference — Part 2

Embed

<a href="https://hermeticor.com/docs/ref-ads"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/c2535669-01a3-482f-a371-11a539962017/social-card.svg?v=3e7ae33eec8b" alt="ads" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/ads/audiences/{id}/sync

Sync now

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ads/audiences/{id}/sync" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "accountId": "string",
  "segmentId": "string",
  "name": "string",
  "externalAudienceId": "string",
  "schedule": "manual",
  "onlyMarketing": true,
  "enabled": true,
  "status": "string",
  "lastSyncedAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "memberCount": 0,
  "lastAdded": 0,
  "lastRemoved": 0,
  "matchRate": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

accountIdstringrequired

segmentIdstringrequired

namestringrequired

externalAudienceIdstringrequired

schedulestringrequired

manual | hourly | daily

onlyMarketingbooleanrequired

enabledbooleanrequired

statusstringrequired

lastSyncedAtstringrequired

lastErrorstringrequired

memberCountintegerrequired

lastAddedintegerrequired

lastRemovedintegerrequired

matchRatestringrequired

createdAtstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

GEThttps://hermeticor.com/v1/ads/audiences/{id}/runs

Sync history with counts and errors

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ads/audiences/{id}/runs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "syncId": "string",
      "trigger": "string",
      "status": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "finishedAt": "2024-01-01T00:00:00Z",
      "added": 0,
      "removed": 0,
      "total": 0,
      "skipped": 0,
      "matchRate": "string",
      "error": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

syncIdstringrequired

triggerstringrequired

statusstringrequired

createdAtstringrequired

finishedAtstringrequired

addedintegerrequired

removedintegerrequired

totalintegerrequired

skippedintegerrequired

matchRatestringrequired

errorstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

GEThttps://hermeticor.com/v1/ads/accounts/{id}/conversions

Conversion forwarding settings and event mapping

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ads/accounts/{id}/conversions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "accountId": "string",
  "enabled": true,
  "eventMap": {},
  "testEventCode": "string",
  "requireConsent": true
}

Schema

accountIdstringrequired

enabledbooleanrequired

eventMapobjectrequired

testEventCodestringrequired

requireConsentbooleanrequired

4XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

PUThttps://hermeticor.com/v1/ads/accounts/{id}/conversions

Save conversion forwarding settings

Parameters

idstringpathrequired

Request body

application/json

enabledbooleanrequired

eventMapobjectrequired

testEventCodestring

requireConsentboolean

= true

{
  "enabled": true,
  "eventMap": {},
  "testEventCode": "string",
  "requireConsent": true
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/ads/accounts/{id}/conversions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"eventMap":{},"testEventCode":"string","requireConsent":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/ads/accounts/{id}/conversions

4XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

POSThttps://hermeticor.com/v1/ads/accounts/{id}/conversions/test

Send a test event in the platform's test mode

Parameters

idstringpathrequired

Request body

application/json

eventNamestring

{
  "eventName": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ads/accounts/{id}/conversions/test" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"eventName":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "status": 0,
  "error": "string"
}

Schema

okbooleanrequired

statusintegerrequired

errorstringrequired

4XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

GEThttps://hermeticor.com/v1/ads/accounts/{id}/conversions/log

Conversion delivery log

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

pending | retry | sent | failed | skipped

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ads/accounts/{id}/conversions/log" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "eventName": "string",
      "platformEvent": "string",
      "status": "string",
      "attempt": 0,
      "responseCode": 0,
      "error": "string",
      "isTest": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

eventNamestringrequired

platformEventstringrequired

statusstringrequired

attemptintegerrequired

responseCodeintegerrequired

errorstringrequired

isTestbooleanrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

GEThttps://hermeticor.com/v1/ads/campaigns

Campaigns built here

Parameters

accountIdstringquery

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ads/campaigns" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "accountId": "string",
      "name": "string",
      "objective": "traffic",
      "dailyBudgetMinor": 0,
      "currency": "string",
      "startAt": "string",
      "endAt": "string",
      "targeting": {
        "countries": [],
        "ageMin": 0,
        "ageMax": 0,
        "audienceIds": [],
        "googleLocationIds": []
      },
      "creative": {
        "headline": "string",
        "body": "string",
        "linkUrl": "string",
        "imageUrl": "string",
        "cta": "LEARN_MORE",
        "descriptions": []
      },
      "adSets": [
        {
          "name": "string",
          "targeting": {
            "countries": [],
            "ageMin": 0,
            "ageMax": 0,
            "audienceIds": [],
            "googleLocationIds": []
          },
          "dailyBudgetMinor": 0,
          "creatives": [
            {
              "headline": "string",
              "body": "string",
              "linkUrl": "string",
              "imageUrl": "string",
              "cta": "LEARN_MORE",
              "descriptions": []
            }
          ]
        }
      ],
      "id": "string",
      "status": "draft",
      "externalIds": {},
      "lastError": "string",
      "syncedAt": "string",
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem174[]required

Show child parameters

accountIdstringrequired

namestringrequired

objectivestringrequired

traffic | leads | sales | awareness | engagement = traffic

dailyBudgetMinorintegerrequired

currencystringrequired

startAtstringrequired

endAtstringrequired

targetingobjectrequired

Show child parameters

countriesstring[]required

= []

ageMininteger

ageMaxinteger

audienceIdsstring[]required

= []

googleLocationIdsstring[]required

= []

creativeobjectrequired

Show child parameters

headlinestringrequired

bodystringrequired

linkUrlstringrequired

imageUrlstring

ctastringrequired

= LEARN_MORE

descriptionsstring[]required

= []

adSetsAdSetsItem[]

Show child parameters

namestringrequired

targetingobjectrequired

dailyBudgetMinorinteger

creativesCreative[]required

idstringrequired

statusstringrequired

draft | active | paused | archived | error

externalIdsobjectrequired

lastErrorstringrequired

syncedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

5XX Default Response

Same as 4XX · POST /v1/ads/audiences/{id}/sync

Next part

Updated Nov 8, 2026

Was this page helpful?