Publisher API

Getting started

Integrate your panel or app with mypinio — request survey offers for your users and send them to live studies.

What you integrate

As a publisher, you connect your backend to the mypinio Publishers API. Your server requests survey offers for a panelist; mypinio returns HTTPS links you open in the user’s browser or WebView.

This site documents your integration only:

TopicDescription
Integration guideEnd-to-end setup and runtime flow
AuthenticationAPI keys
API referenceDiscovery, apps CRUD, surveys
API discoveryGET /api/v1/publishers
Apps APIGET/POST/PATCH/DELETE /api/v1/publishers/apps
POST /surveysRequest offers
Redirect URLsOutcome URLs and signature verification
TerminologyCommon ad-network terms mapped to mypinio's names
ErrorsStatus codes and failure handling

Base URL

All API requests use:

https://publishers.mypinio.com

Example endpoint:

POST https://publishers.mypinio.com/api/v1/publishers/surveys

Local docs: use Download collection and import the file in Postman (File → Import). Run in Postman needs the public URL at publishers.mypinio.com — Postman cannot fetch collections from localhost.

Sign up

Everything is self-service — no approval step, no contract call. Go to the Publisher Portal and choose Continue with Google. Your organization is created automatically on first sign-in; then create an app (your appId is shown under Apps) and an API key.

  • Company Google accounts: colleagues from the same domain join your organization automatically when they sign in.
  • Gmail and other personal addresses: invite colleagues under Team first; they then sign in with Google using exactly that address.
  • The e-mail sign-in link on the login page works only for accounts that already exist. New publishers sign up with Google.

Integration at a glance

  1. Portal setup — create an app and configure its redirect URLs and signing secret.
  2. API key — create a key under Settings → API keys (server-side only).
  3. Request offers — your backend calls POST /api/v1/publishers/surveys with appId, panelistId, country, locale and profileDetails (age and gender are required from 2026-10-06).
  4. Show surveys — render surveys (ready now) and partlySurveys (unlock with questions). Open entryLink when the user picks an offer. Ignore profilingUrl in new builds (legacy only).
  5. Handle returns — when a panelist finishes or screens out, mypinio redirects the panelist's browser to your configured URLs with signed query parameters; verify the signature on your server, then credit once per entryLinkCode.

See the Integration guide for detailed steps and the Quickstart for a copy-paste curl example.

Support

Setup and integration are self-service; your appId is shown in the portal under Apps. For questions, open a ticket on the Support page of the publisher portal (signed in). Never send API keys or signing secrets by email — rotate credentials if they are exposed.

On this page