Introduction
Versioning
Quick Start
API Change Management Policy
Types of changes
API resource deprecation
Common API Conventions
Terminology
Access and Authentication
Requests
Standard Pagination
Cursor Pagination
Rate Limits
Version 1 API Conventions
Requests
Response Formats
Rate limit response
Compression
Version 2 API Conventions
Requests
Responses
Errors
Date Time
Version 3 API Conventions
Requests
Responses
Errors
Date Time
Partner Management (v1)
Partner Details
get
Retrieve Partner
post
Update Partner
Websites
get
List all Partner Websites
post
Create Partner Website
put
Update Partner Websites
get
Retrieve a Partner Website
Databases
get
List Partner Databases
post
Create Partner Database
put
Update Partner Databases
get
Retrieve a Partner Database
Campaign Management (v1 and v2)
Brand Discovery (v2)
get
List Brands & Campaigns
get
Retrieve a Brand
Campaigns (v1)
get
List Campaigns
post
Request Access to Campaigns (Obsolete)
Campaign Invitations (v2)
get
List Invitations
post
Accept Campaign Invitiations
post
Decline Campaign Invitiations
Campaign Requests (v2)
post
Create Campaign Requests
Campaign References (v1)
get
Lists Campaign References
Creatives (v1)
get
List all Creatives on each participating Campaign
get
List Creatives on a Campaign
Feeds (v1)
get
List all Available Feeds
Terms and Conditions
get
Retrieve Partner Custom Terms and Conditions (v1)
get
List Terms and Conditions (v2)
Voucher Codes (v1)
get
List Campaign Voucher Codes
Campaign Commissions (v2)
Commissions
get
Get Default Commissions
get
List Partner Commissions For Specific Campaign
get
List Active Partner Commissions
Voucher Commissions
get
List Partner Voucher Commissions For Specific Campaign
Promotional Commissions
get
List Partner Promotional Commissions For Specific Campaign
Tiered Commissions
get
List Partner Tiered Commissions For Specific Campaign
Commission Groups (v1)
get
List Partner Commission Groups
Payments (v1)
Transaction Queries
get
List all Transaction Queries
post
Create Transaction Queries
post
Delete a Transaction Query
Self-billing
get
List all Selfbills
get
Retrieve a Self-billing invoice.
Payment Details
get
List Payment Details
post
Create Payment Details
Available Commission
get
Retrieve Available Commission
Summary
get
Summarise value of partner's conversions
Tracking Links Management (v2)
Tracking Links
get
Retrieve Tracking Links
post
Create a Tracking Link
get
Retrieve a Tracking Link
patch
Update a Tracking Link
Reporting (v1)
Partner Overview (Deprecated)
get
Retrieve a Partner Overview Report for a date range (Deprecated)
get
Retrieve a Partner Overview Report for a specified period (Deprecated)
get
Retrieve a Partner Overview Report for multiple date ranges (Deprecated)
Partner Conversions
get
Retrieve a Partner Conversions Report
Partner Clicks
get
Retrieve a Partner Clicks Report
Partner Payable
get
Retrieve a Partner Payable Report
Exports
get
Export a Clicks Report
get
Export Conversions Report
get
Export Conversion Items Report
Analytics (v3)
Introduction
Metrics and Dimensions
Data Sources and Endpoint Types
Explode - Group By Dimension Response Values
Request Structure
Currency Conversion
Rate-limiting
Tutorials
Getting single top level metrics for multiple campaigns.
Get the total Conversion Order Value, Commission Broken Down by Campaign, Country and Currency.
Get the Campaign Commision for approved and pending Converisons for one campaign broken down by Campaign and Conversion Status
Get the total of number of clicks broken down by Campaign and day for all countries except the US
Using the TimeSeries endpoint to show the total conversion items and commission over time
Clicks
post
Count
post
Explode
post
Filter
post
Timeseries
Conversions
post
Count
post
Explode
post
Filter
post
Timeseries
Impressions
post
Count
post
Explode
post
Filter
post
Timeseries
Reference (v1)
Countries
get
List all Countries
Currencies
get
List all Currencies
Devices
get
List all Devices
Timezones
get
List all Timezones
User Contexts
get
List all User Contexts
Traffic Sources
get
List Traffic Sources
Conversion Types
get
List Conversion Type
Conversion Metrics
get
List Conversion Metrics
Partnership Models
get
List Partnership Models
Partnerize Tags (v3)
Partnerize Tags
get
List Partnerize Tags
post
Create Partnerize Tag
get
Get Partnerize Tag
patch
Update Partnerize Tag
del
Delete Partnerize Tag
Partnerize Tag Features
get
List Available Partnerize Tag Features
get
List Partnerize Tag Enabled Features
post
Enable Feature on Partnerize Tag
del
Disable Feature on Partnerize Tag
Terms and Conditions (v3)
Campaign Terms and Conditions
get
List campaign terms and conditions
get
Retrieve campaign terms and conditions
Campaign Terms and Conditions Acknowledgments