Skip to main content

Integration reference

The API

Read this network’s data from your own systems, with an API key made in your account or in Settings.

Authentication

Send the key in the header of every request, as Authorization: Bearer wo_<your key>, to https://api.wowmediametrics.pl. The panel’s own address does not take keys: a key is for the API host.

Who am I? Any key can ask.
curl -H "Authorization: Bearer wo_<your key>" https://api.wowmediametrics.pl/auth/me
  • A key acts exactly as the login that made it: the same role, the same partner or advertiser, and the same rows. There is no second set of permissions.
  • A key cannot make another key, and it can list and revoke only its owner’s keys.
  • Some routes refuse a key and need a signed-in person: changing a password is one. A key is refused there with 401 and the code auth.notPermitted.
  • Changing the owner’s password revokes every key the owner holds. A revoked or unknown key answers 401.
  • A key is shown once, when it is made, and only its hash is stored. If it is lost, make another and revoke the old one.

Fraud fields, by audience

Clicks, impressions and conversions carry the network’s fraud judgement in three fields: fraud_verdict, fraud_score and fraud_reasons. Which of them a key is answered with depends on who owns it.

  • Network staff read the verdict, the score and the reason tokens of every click, impression and conversion.
  • A partner’s or an advertiser’s key reads only the verdict of its clicks and impressions: clean, suspect or blocked, and unspecified for traffic that was not scored. Traffic recorded before scoring was in place may instead carry an empty verdict, which also means not scored.
  • For those keys a conversion’s verdict is withheld: the field is empty on every conversion, and on a conversion empty does not mean it was never scored. A verdict filter such as f.verdict=suspect never matches a conversion.
  • For those keys fraud_reasons is always an empty list, and there is no fraud_score field at all.
  • For those keys fraud_verdict is not a report dimension: a report cannot be grouped, filtered or sorted by it.

Lists

Lists answer one page at a time: page from 1, pageSize of 10, 25, 50, 100 or 200, sort=occurred_at:desc as a field and a direction, q to search, and filters as f.status=pending,approved, several values separated by commas. The answer carries the rows, the total across every page, and counts per filter value.

A key the list does not know, or a value it cannot apply, is refused with 400 rather than ignored, so a list is never silently wider than asked, as in /conversions?page=1&pageSize=50&f.status=pending.

Errors

Every refusal is JSON with a stable code, an English message for your logs and the details in params. Program against the code, not the message.

A refused filter value
{"statusCode":400,"code":"validation.failed","message":"validation failed: f.offer: …","params":{"fields":[{"field":"f.offer","code":"field.badFormat"}]}}

The main routes

Routes, and who may call them
RequestWho may call it
GET /auth/meAny login or key. Each sees only its own rows: a partner its conversions, an advertiser its offers’.
GET /offersAny login or key. Each sees only its own rows: a partner its conversions, an advertiser its offers’.
GET /conversionsAny login or key. Each sees only its own rows: a partner its conversions, an advertiser its offers’.
GET /conversions/recent?offerId=…&since=…Any login or key. Each sees only its own rows: a partner its conversions, an advertiser its offers’.
GET /exports/conversions/csvAny login or key. Each sees only its own rows: a partner its conversions, an advertiser its offers’.
GET /reports/pivotAny login or key. Each sees only its own rows: a partner its conversions, an advertiser its offers’.
POST /conversions/:id/approveNetwork staff only.
POST /conversions/:id/rejectNetwork staff only.
GET /payouts/batchesNetwork staff and partners (a partner sees its own).
GET /invoicesNetwork staff and advertisers (an advertiser sees its own).
POST /users/me/passwordA signed-in person only; a key is refused.