sponsorships

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-sponsorships"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/35302b34-1d33-41ae-9b87-1419de376bd9/social-card.svg?v=3e7ae33eec8b" alt="sponsorships" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/sponsors/network/earnings/move

Approve earned entries, or record approved entries as paid (manual)

Request body

application/json
idsstring[]required
tostringrequired
approved | paid
notestring
{
  "ids": [
    "string"
  ],
  "to": "approved",
  "note": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/sponsors/network/earnings/move" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"to":"approved","note":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "updated": 0
}
Schema
updatednumberrequired
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/sponsors/network/earnings/move

POSThttps://hermeticor.com/v1/sponsors/network/earnings/refresh

Recompute earnings from delivered emails, web views and clicks now

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/sponsors/network/earnings/refresh" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "settled": 0
}
Schema
settlednumberrequired
4XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

GEThttps://hermeticor.com/p/sr/{ws}/{token}

Shareable sponsor report (impressions, opens, clicks, CTR)

Parameters

wsstringpathrequired
tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/sr/{ws}/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

GEThttps://hermeticor.com/v1/public/sponsor-report/{ws}/{token}

Sponsor report as JSON (same token as the shareable page)

Parameters

wsstringpathrequired
tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/public/sponsor-report/{ws}/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "booking": "string",
  "sponsor": "string",
  "publication": "string",
  "startsOn": "string",
  "endsOn": "string",
  "totals": {
    "impressions": 0,
    "opens": 0,
    "clicks": 0,
    "ctr": 0
  },
  "placements": [
    {
      "placementId": "string",
      "refKind": "campaign",
      "refId": "string",
      "slot": "string",
      "impressions": 0,
      "opens": 0,
      "clicks": 0,
      "ctr": 0
    }
  ]
}
Schema
bookingstringrequired
sponsorstringrequired
publicationstringrequired
startsOnstringrequired
endsOnstringrequired
totalsobjectrequired
Show child parameters
impressionsnumberrequired
opensnumberrequired
clicksnumberrequired
ctrnumberrequired
placementsPlacementsItem[]required
Show child parameters
placementIdstringrequired
refKindstringrequired
campaign | post
refIdstringrequired
slotstringrequired
impressionsnumberrequired
opensnumberrequired
clicksnumberrequired
ctrnumberrequired
4XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

GEThttps://hermeticor.com/p/kit/{ws}/{slug}

Public rate card / media kit of a publication

Parameters

wsstringpathrequired
slugstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/kit/{ws}/{slug}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

GEThttps://hermeticor.com/p/ad/{ws}/{id}

Sponsor link on a web post: counts the click, then redirects to the sponsor

Parameters

wsstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/ad/{ws}/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

302 Default Response
"string"
4XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

5XX Default Response

Same as 4XX · POST /v1/sponsors/network/earnings/move

Updated