ad-spend

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-ad-spend"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/bc8f9097-22b2-44bf-adf9-3bc7bba981ca/social-card.svg?v=3e7ae33eec8b" alt="ad-spend" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/ad-spend/import

Upsert daily ad spend by platform and campaign

Request body

application/json
rowsobject[]required
Show child parameters
platformstringrequired
campaignKeystringrequired
campaignNamestring
daystringrequired
spendMinorintegerrequired
currencystringrequired
impressionsinteger
clicksinteger
{
  "rows": [
    {
      "platform": "string",
      "campaignKey": "string",
      "campaignName": "string",
      "day": "string",
      "spendMinor": 0,
      "currency": "string",
      "impressions": 0,
      "clicks": 0
    }
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/ad-spend/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"platform":"string","campaignKey":"string","campaignName":"string","day":"string","spendMinor":0,"currency":"string","impressions":0,"clicks":0}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "imported": 0
}
Schema
importedintegerrequired
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/ad-spend/import

GEThttps://hermeticor.com/v1/ad-spend/report

Spend, orders, revenue and ROAS

Parameters

fromstringqueryrequired
tostringqueryrequired
groupBystringquery
platform | campaign | day = platform

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/ad-spend/report?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "groupBy": "platform",
  "rows": [
    {
      "key": "string",
      "platform": "string",
      "label": "string",
      "currency": "string",
      "spendMinor": 0,
      "impressions": 0,
      "clicks": 0,
      "orders": 0,
      "revenueMinor": 0,
      "roas": 0
    }
  ]
}
Schema
groupBystringrequired
platform | campaign | day
rowsobject[]required
Show child parameters
keystringrequired
platformstringrequired
labelstringrequired
currencystringrequired
spendMinorintegerrequired
impressionsintegerrequired
clicksintegerrequired
ordersintegerrequired
revenueMinorintegerrequired
roasnumberrequired
4XX Default Response

Same as 4XX · POST /v1/ad-spend/import

5XX Default Response

Same as 4XX · POST /v1/ad-spend/import

DELETEhttps://hermeticor.com/v1/ad-spend

Remove imported spend for a platform and date range

Parameters

platformstringqueryrequired
fromstringqueryrequired
tostringqueryrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/ad-spend?platform=<platform>&from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "deleted": 0
}
Schema
deletedintegerrequired
4XX Default Response

Same as 4XX · POST /v1/ad-spend/import

5XX Default Response

Same as 4XX · POST /v1/ad-spend/import

Updated