{"__v":6,"_id":"565e4120ea462517009725b4","category":{"project":"5643e1c19eebf70d00490e46","version":"5643e1c19eebf70d00490e49","_id":"565f12c37f93280d0052cea5","pages":[],"__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-02T15:48:19.602Z","from_sync":false,"order":3,"slug":"api","title":"API"},"project":"5643e1c19eebf70d00490e46","user":"565dfa3460497d1700ecce49","version":{"__v":6,"_id":"5643e1c19eebf70d00490e49","project":"5643e1c19eebf70d00490e46","createdAt":"2015-11-12T00:48:01.649Z","releaseDate":"2015-11-12T00:48:01.649Z","categories":["5643e1c29eebf70d00490e4a","56586e2f3df5130d00a57a14","565f12c37f93280d0052cea5","565f1325bca87d0d006bc618","565f161f649b951900c896cb","565f165a0dc99e1900f24b56"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.9.37","version":"1.9.37"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-02T00:53:52.851Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Currently, if you are developer, you can use the Prosper202 ClickServer API to run reports without a UI and integrate it into your own applications. Below is the documentation available for the API.\n\n## Locating your API Keys\n\nTo generate or find your Prosper202 ClickServer API Key, simply log into Prosper, click on My Account > Personal Settings, and scroll down until you find the section labeled Prosper202 App API keys.\n\n## Generating API Keys\n\nYou can create multiple API keys. It’s best to create a new App API key for every integration that needs to access the reporting API. This will give you fine grained control over disabling access to an app or integration you no longer need.\n\n## API Authentication\n\nThe Prosper202 ClickServer uses a simple token based authentication system. The API keys that you generate are used to authenticate and app and allow the pulling of reports from your system. With that in mind it’s important to keep the tokens secure and limit token use to one per app or integration.\n\n## API Endpoint\n\nThe API endpoint for Prosper202 will depend up your tracking domain, however the general form is as follows: **http://[[your­Prosper202­domain]]/api/v1/**\n\n## Methods\n\nAs of now the only support method is the reports method\n\nMethod Name: reports\nRequired: Yes\n\n## Arguments\n\n**Argument name:** type (Required) - Specifies the type of report you'd like to run.\nThe current valid values are as follows\n  * keywords ­- Keyword report\n  * ips ­- IP report\n  * text_ads -­ text ad report\n  * referers ­- Referrer report\n  * countries -­ Country report\n  * cities ­- Cities report\n  * carriers -­ Carrier and ISP report\n  * landing_pages -­ Landing page report\n\n**Argument name: **apikey (Required) - API key generated in Prosper202 and used\nfor authentication.\n\n**Argument name:** date_from (Optional) - Start date for the report you’d like to\nrun. If left blank the system will default to the start of the current day. A valid date\nshould be in the following format: mm/dd/yyyy\n\n**Argument name:** date_to (Optional) - End date for the report you’d like to run.\nIf left blank the system will default to the end of the current day. A valid date should\nbe in the following format: mm/dd/yyyy\n\n**Argument name: **cid (Optional) - Campaign id to filter your report by. If this is\nblank, data from all campaigns will be returned.\n\n**Argument name:** c1,c2,c3,c4 (Optional) - Filters by value stored in the\ncorresponding c1-4 variable. If this is blank, data from all campaigns will be\nreturned.\n\n## Example of a validly formatted API call\n\n**http://prosper202.com/api/v1/reports/?type=countries&apikey=6cvyz0ckgpylum2ira502jap6w6ou412&date_from=03/24/2014&date_to=04/27/2014&cid=1&c1=c1­var&c2=c2­var&c3=c3­var&c4=c4­var**","excerpt":"","slug":"api-integrations","type":"basic","title":"Prosper202 ClickServer API"}

Prosper202 ClickServer API


Currently, if you are developer, you can use the Prosper202 ClickServer API to run reports without a UI and integrate it into your own applications. Below is the documentation available for the API. ## Locating your API Keys To generate or find your Prosper202 ClickServer API Key, simply log into Prosper, click on My Account > Personal Settings, and scroll down until you find the section labeled Prosper202 App API keys. ## Generating API Keys You can create multiple API keys. It’s best to create a new App API key for every integration that needs to access the reporting API. This will give you fine grained control over disabling access to an app or integration you no longer need. ## API Authentication The Prosper202 ClickServer uses a simple token based authentication system. The API keys that you generate are used to authenticate and app and allow the pulling of reports from your system. With that in mind it’s important to keep the tokens secure and limit token use to one per app or integration. ## API Endpoint The API endpoint for Prosper202 will depend up your tracking domain, however the general form is as follows: **http://[[your­Prosper202­domain]]/api/v1/** ## Methods As of now the only support method is the reports method Method Name: reports Required: Yes ## Arguments **Argument name:** type (Required) - Specifies the type of report you'd like to run. The current valid values are as follows * keywords ­- Keyword report * ips ­- IP report * text_ads -­ text ad report * referers ­- Referrer report * countries -­ Country report * cities ­- Cities report * carriers -­ Carrier and ISP report * landing_pages -­ Landing page report **Argument name: **apikey (Required) - API key generated in Prosper202 and used for authentication. **Argument name:** date_from (Optional) - Start date for the report you’d like to run. If left blank the system will default to the start of the current day. A valid date should be in the following format: mm/dd/yyyy **Argument name:** date_to (Optional) - End date for the report you’d like to run. If left blank the system will default to the end of the current day. A valid date should be in the following format: mm/dd/yyyy **Argument name: **cid (Optional) - Campaign id to filter your report by. If this is blank, data from all campaigns will be returned. **Argument name:** c1,c2,c3,c4 (Optional) - Filters by value stored in the corresponding c1-4 variable. If this is blank, data from all campaigns will be returned. ## Example of a validly formatted API call **http://prosper202.com/api/v1/reports/?type=countries&apikey=6cvyz0ckgpylum2ira502jap6w6ou412&date_from=03/24/2014&date_to=04/27/2014&cid=1&c1=c1­var&c2=c2­var&c3=c3­var&c4=c4­var**