Publisher API

Terminology

How common ad-network terms map to the names mypinio uses in the Publisher API and Portal.

If you integrated with another survey wall or offer network before, some terms you expect don't exist here under the same name. This page maps common terms to their mypinio equivalent — no new concepts, just the names used elsewhere in this documentation.

Term you may knowAt mypinioNotes
Publisher ID / Affiliate IDApp IDShown per app under Apps in the portal, with a copy button. There is no single organization-wide ID — each app has its own. See Apps API.
CID / Campaign ID(no equivalent)Not a concept in the mypinio API.
Transaction ID / Click IDYour own: subId1–subId3. Ours: entryLinkCodesubId1–subId3 are optional tracking IDs you send in POST /api/v1/publishers/surveys; they are echoed back on return, unsigned. entryLinkCode is generated by mypinio for the session and only appears on the return redirect — it cannot be looked up beforehand. See Redirect URLs and POST /surveys.
Complete URL / Complete postbackComplete URLSame name. Configured per app under Apps → your app → Redirect URLs.
Terminate URLScreen-out URL, reason=qualification_mismatchmypinio uses one Screen-out URL for all disqualification cases; the reason query parameter tells you which one.
Quota Full URLScreen-out URL, reason=overquotaSame URL as Terminate, distinguished by reason.
Security / Fraud URLScreen-out URL, reason=securitySame URL as Terminate and Quota Full, distinguished by reason.
PostbackSigned browser redirect to your Complete or Screen-out URLThere is no separate server-to-server postback call. mypinio redirects the panelist's browser to your URL with signed query parameters; treat that request as your postback and verify the signature server-side. See Redirect URLs.
Cancelled URL / Cancelled postbackCancelled URLRequired field in app settings, but mypinio does not currently redirect panelists to it.

See Redirect URLs for the full query-parameter and signature-verification reference, and POST /surveys for request fields.