Getting Started

Read-only API for publisher-scoped reporting data and campaign tracking links. Requests are authenticated with a Publisher-specific Bearer token issued by Aurev. All returned data is scoped to the Publisher associated with that token. Aurev Links identify the Campaign automatically; replace enabled subid1/subid2/clickID macros with URL-encoded values. Aurev-managed callbacks require an original clickID. Campaign callback templates accept query-value placeholders {transaction_id} (original click ID), {amount} (exact net USD earnings) and {conversionclickid} (stable logical conversion ID). Aurev sends HTTPS GET. Return 2xx after durable acceptance; duplicate conversion IDs with identical values must not credit earnings twice. One click may produce several distinct conversions. Bounded retries preserve transaction, conversion ID and exact amount; redirects are not followed. Conversions are processed automatically without event approvals. Campaign Links supplies campaign_name; a dedicated Campaign Name tracking parameter is not available in this version.

Authentication

Every API request requires Authorization: Bearer <PUBLISHER_API_TOKEN>. Dashboard cookies and sessions do not authenticate this API.

The contract is readable without a token. For interactive testing, use the global Authorize button and enter only the token, without the Bearer prefix. This enables Try it out / Execute for both GET operations; their padlocks share the same authorization. The server validates the token on Execute; invalid or revoked tokens return 401.

The token is held in memory only. Full reload clears it and locks interactive requests until the next Authorize. Keep it secret: never send it in URL/query parameters or share authorized request/curl previews.

Base URL

Requests use the origin of this documentation page: <BASE_URL>. The paths below are relative to that origin.

Endpoints

GET /api/publisher/v1/reports — Retrieve publisher campaign reporting
GET /api/publisher/v1/campaign-links — Retrieve active campaign tracking links

Rate limiting & errors

Requests use your normal API quota. On 429, honor Retry-After (seconds) and retry with bounded backoff and jitter. Honor this header on temporary 503 failures when present; follow the response-specific retry guidance below.

Errors use {"error":{"code":"…","message":"…"}}. Unknown routes return 404 not_found (Resource not found.); unsupported methods return 405 method_not_allowed (Method not allowed.) with an Allow header. Use the exact single-slash paths shown here.

Request examples with curl

Replace the token placeholder and example dates with your own token and reporting period.

Retrieve publisher campaign reporting

curl -H "Authorization: Bearer <PUBLISHER_API_TOKEN>" \
  "<BASE_URL>/api/publisher/v1/reports?from=2026-09-01&to=2026-09-01&report_type=finalized"

Retrieve active campaign tracking links

curl -H "Authorization: Bearer <PUBLISHER_API_TOKEN>" \
  "<BASE_URL>/api/publisher/v1/campaign-links"

Aurev Links and conversion callbacks

Click tracking

Use the Aurev Link supplied in Campaign Links. Replace only its enabled macros with URL-encoded values: subid1={subid1}, subid2={subid2}, clickID={clickid}. Your source values remain yours. Aurev identifies the Campaign automatically; do not use a source slot for its name.

Aurev-managed conversion callbacks require a real, original clickID on each click. An empty or unresolved click macro cannot identify a transaction. Campaign Links supplies campaign_name alongside each link; a dedicated Campaign Name tracking parameter is not available in this version.

Your callback contract

When Aurev-managed callbacks are configured, Aurev sends an HTTPS GET to your configured Campaign callback template. The template accepts these query-value placeholders only:

{transaction_id} — your exact original click ID, encoded for a query value;
{amount} — your exact net USD earnings for this conversion, which may have more than two decimal places;
{conversionclickid} — the stable identifier of one logical conversion.

External parameter names and static network values belong to your template. Synthetic example:

https://partner.example.com/conversion?transaction_id={transaction_id}&amount={amount}&conversionclickid={conversionclickid}

For example, a callback may contain transaction_id=tx_example&amount=0.0285&conversionclickid=conv_example. Amounts are exact decimal strings; avoid binary floating-point parsing or rounding each conversion to cents.

Acceptance and duplicates

Return a 2xx response after durable acceptance. Treat the same conversion ID with the same transaction and amount as the same conversion and return success without adding earnings twice. One click can have several distinct conversion IDs: accept each independently. A transient failure or unknown acknowledgement can cause a bounded retry with the same values. Redirects are not followed; permanent 4xx responses terminate delivery, except 429, which is retryable.

Conversions are processed automatically; no individual event or payout approval is required. Aurev supplies only your net conversion earnings. Configure callback details with the Aurev operator; Campaign-specific configuration is retained.