Prosper202 ClickServer API
Pull Prosper202 report data into your own apps and scripts with an API key and the v1 reports endpoint.
The Prosper202 ClickServer API lets your own dashboards, scripts and apps work with ClickServer without opening the web interface. The REST API is open on every install, free or Pro.
REST API v3
The current API is v3. It authenticates with a bearer token and covers campaigns, goals, events, apps, customer LTV, subscriptions, forecasts, sync and system operations. Listing campaigns looks like this:
curl https://your-domain.com/api/v3/campaigns \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Your own backend can also send conversion events to POST /api/v3/events.
The API is strict about input. A body field it doesn't recognise gets a 422 that names the field rather than being dropped. Amounts and counts arrive as JSON numbers. time_from and time_to accept unix seconds, a YYYY-MM-DD day in your account's time zone, or an ISO time that carries its offset.
API keys
- Find or create keys under My Account > Personal Settings, in the Prosper202 App API keys section.
- You can create several keys. Give each app or integration its own, so you can cut off a single integration later without breaking the rest.
- A key works as the user it belongs to.
- Keep keys secure: whoever holds one can read your data.
The original v1 reports endpoint
Older integrations pull reports from v1. The base address follows your tracking domain:
http://[[your-Prosper202-domain]]/api/v1/
Its one method is reports.
Report arguments
| Argument | Required | Notes |
|---|---|---|
type | Yes | keywords, ips, text_ads, referers, countries, cities, carriers or landing_pages |
apikey | Yes | A key created in ClickServer |
date_from | No | mm/dd/yyyy. Left empty, it starts at the beginning of today |
date_to | No | mm/dd/yyyy. Left empty, it ends at the close of today |
cid | No | One campaign id. Left empty, every campaign is included |
c1, c2, c3, c4 | No | Match the value stored in that variable |
A countries report for campaign 1 over a date range looks like this:
http://[[your-Prosper202-domain]]/api/v1/reports/?type=countries&apikey=YOUR_API_KEY&date_from=03/24/2014&date_to=04/27/2014&cid=1
Attribution over REST
Multi-touch attribution models are managed under /api/v3/attribution/models, for example PUT /api/v3/attribution/models/{id} with {"status": "inactive"} to switch one off. Older /api/v2/attribution endpoints only existed in development builds and were never in a release. The Multi-touch Attribution QA Runbook covers the details.
From the command line
The p202 CLI works with the same API key, data and permissions as the web UI, and returns JSON for scripts and AI agents. Unlike the REST API, it needs Prosper202 Pro on the install (a 7-day trial is enough). See the p202 CLI Reference.
Full guide on prosper.tracking202.com
The full guide walks through key setup, token authentication and each report argument, with a complete example call: the Prosper202 ClickServer reporting API guide
Updated 2 days ago