APIUser Guide

DirectTrack API Fleet User Guide
2010 Digital River Marketing Solutions, Inc., (dba) Direct Response Technologies/DirectTrack. The confidential and proprietary reference material contained herein is subject to protection by law or terms of applicable client confidentiality/non-disclosure agreements. Dissemination, distribution, or copying of this documentation beyond this use is strictly prohibited.
Table of Contents
Introduction ......................................................................................................................................1 What is REST? ....................................................................................................................................1 What is XML?.....................................................................................................................................1 Getting and Using XSDs ......................................................................................................................2 Resource Caching ...............................................................................................................................5 Metadata...........................................................................................................................................5 Accessing the API Fleet.......................................................................................................................6 Security ................................................................................................................................................... 6 Authentication ........................................................................................................................................ 6 Usage ...................................................................................................................................................... 8 Restrictions ........................................................................................................................................... 13 Errors .............................................................................................................................................. 14 Data Types....................................................................................................................................... 26 API Placeholders .............................................................................................................................. 27 Country Codes ................................................................................................................................. 30 APIs by Category .............................................................................................................................. 34 APIs by HTTP Operation ................................................................................................................... 43 API Fleet Tips and Tricks ................................................................................................................... 50 API Reference User Management .................................................................................................. 51 API Users............................................................................................................................................... 51 Add API User .................................................................................................................................. 51 List API Users ................................................................................................................................. 53 View API Users .............................................................................................................................. 55 Client User Accounts ............................................................................................................................ 57 Add Client User .............................................................................................................................. 57 Edit a Client User ........................................................................................................................... 59 Remove a Client User .................................................................................................................... 61
2010 Digital River Marketing Solutions, Inc. Proprietary and Confidential Material.
List Client Users ............................................................................................................................. 62 View Client Users .......................................................................................................................... 64 Authenticating to DirectTrack via API .................................................................................................. 66 API Reference Affiliate Management ............................................................................................. 67 Affiliates................................................................................................................................................ 67 Add Affiliate................................................................................................................................... 67 Edit Affiliate ................................................................................................................................... 71 List Affiliates .................................................................................................................................. 75 View Affiliate ................................................................................................................................. 78 Affiliate Groups..................................................................................................................................... 81 Add Affiliate Group ....................................................................................................................... 81 Edit Affiliate Group........................................................................................................................ 82 Remove Affiliate Group ................................................................................................................ 83 List Affiliate Group ........................................................................................................................ 84 View Affiliate Group...................................................................................................................... 86 Affiliate Blacklists.................................................................................................................................. 88 Add Affiliate to Blacklist................................................................................................................ 88 Edit Affiliate Blacklist .................................................................................................................... 89 Remove Affiliate from Blacklist .................................................................................................... 90 List Affiliate Blacklist ..................................................................................................................... 91 View Affiliate Blacklist .................................................................................................................. 93 Affiliate Edit Requests .......................................................................................................................... 95 Edit Affiliate Edit Requests ........................................................................................................... 95 List Affiliate Edit Requests ............................................................................................................ 97 View Affiliate Edit Requests.......................................................................................................... 99 Affiliate Campaign Access Requests ................................................................................................... 101 Create Campaign Access Requests ............................................................................................. 101 Edit Campaign Access Requests .................................................................................................. 103 List Campaign Access Requests................................................................................................... 104 Affiliate Histories ................................................................................................................................ 106
View Affiliate Histories ............................................................................................................... 106 Creative Deployments ........................................................................................................................ 108 Add Creative Deployment ........................................................................................................... 108 Edit Creative Deployment ........................................................................................................... 110 Remove Creative Deployment .................................................................................................... 112 List Creative Deployment ............................................................................................................ 113 View Creative Deployment ......................................................................................................... 115 Third Party Pixels ................................................................................................................................ 117 Add Third Party Pixel................................................................................................................... 117 Edit Third Party Pixel ................................................................................................................... 118 Remove Third Party Pixel ............................................................................................................ 119 List Third Party Pixel .................................................................................................................... 120 View Third Party Pixel ................................................................................................................. 122 Tracking .............................................................................................................................................. 124 View Tracking URL ....................................................................................................................... 124 Emailing Affiliates Creating Email Templates .................................................................................. 126 Create an Affiliate Email Template ............................................................................................. 126 Edit Affiliate Email Templates..................................................................................................... 128 Remove Affiliate Email Templates.............................................................................................. 130 List Affiliate Email Templates ..................................................................................................... 131 View Affiliate Email Templates ................................................................................................... 133 Emailing Affiliates Manual Emails.................................................................................................... 135 Add Manual Affiliate Emails ....................................................................................................... 135 Edit Manual Affiliate Emails........................................................................................................ 137 Remove Manual Affiliate Emails................................................................................................. 139 List Manual Affiliate Emails ........................................................................................................ 140 View Manual Affiliate Emails ...................................................................................................... 142 Emailing Affiliates Auto-Emails ........................................................................................................ 144 Add Affiliate Auto-Emails............................................................................................................ 144 Edit Affiliate Auto-Emails ............................................................................................................ 146
Remove Affiliate Auto-Emails ..................................................................................................... 148 List Affiliate Auto-Emails ............................................................................................................. 149 View Affiliate Auto-Emails .......................................................................................................... 151 Affiliate Emails Email History Reports ............................................................................................. 153 List Email Reports ........................................................................................................................ 153 View Email Reports ..................................................................................................................... 155 API Reference Campaign Management ........................................................................................ 157 Campaigns .......................................................................................................................................... 157 Add Campaign ............................................................................................................................. 157 Edit Campaign.............................................................................................................................. 161 List Campaigns ............................................................................................................................. 165 View Campaign ............................................................................................................................ 167 Campaign Groups ............................................................................................................................... 170 Add Campaign Group .................................................................................................................. 170 Edit Campaign Group .................................................................................................................. 171 Remove Campaign Group ........................................................................................................... 172 List Campaign Groups.................................................................................................................. 173 View Campaign Group ................................................................................................................ 175 Campaign Categories .......................................................................................................................... 176 Add Campaign Categories ........................................................................................................... 176 Edit Campaign Category .............................................................................................................. 177 List Campaign Categories ............................................................................................................ 178 View Campaign Category ............................................................................................................ 180 Creatives ............................................................................................................................................. 182 Add Creative ................................................................................................................................ 182 Edit Creative ................................................................................................................................ 186 Remove Creative ......................................................................................................................... 191 List Creatives................................................................................................................................ 192 View Creative .............................................................................................................................. 194 Mobile Creative Helpers ..................................................................................................................... 196
List SMS Short Codes ................................................................................................................... 196 View SMS Short Codes ................................................................................................................ 198 Add an SMS Contact List ............................................................................................................. 200 Update an SMS Contact List ........................................................................................................ 202 List SMS Contact Lists .................................................................................................................. 204 View an SMS Contact List ............................................................................................................ 206 Payouts ............................................................................................................................................... 208 Add Payout .................................................................................................................................. 208 Edit Payout .................................................................................................................................. 210 Remove Payout ........................................................................................................................... 212 List Payouts.................................................................................................................................. 213 View Payout................................................................................................................................. 215 Traffic Limits ....................................................................................................................................... 217 Add Traffic Limits......................................................................................................................... 217 Update Traffic Limits ................................................................................................................... 219 Remove Traffic Limits .................................................................................................................. 220 List Traffic Limits.......................................................................................................................... 221 Get Traffic Limit Details............................................................................................................... 223 API Reference Datafeeds ............................................................................................................. 225 Products.............................................................................................................................................. 225 Add a Product .............................................................................................................................. 225 Edit a Product .............................................................................................................................. 227 Remove a Product ....................................................................................................................... 229 List Products ................................................................................................................................ 230 Get Product Details ..................................................................................................................... 233 Product Brands ................................................................................................................................... 235 Add a Product Brand ................................................................................................................... 235 Edit a Product Brand ................................................................................................................... 236 List Product Brands ..................................................................................................................... 237 Get Product Brand Details .......................................................................................................... 239
Product Categories ............................................................................................................................. 241 Add a Product Category .............................................................................................................. 241 Edit a Product Category .............................................................................................................. 242 List Product Categories ............................................................................................................... 243 Get Product Category Details...................................................................................................... 245 API Reference Data Management ................................................................................................ 247 Program Impressions.......................................................................................................................... 247 Add Program Impressions ........................................................................................................... 247 List Program Impressions ............................................................................................................ 249 View Program Impressions ......................................................................................................... 252 Program Clicks .................................................................................................................................... 254 Add Program Clicks ..................................................................................................................... 254 Edit Program Clicks ...................................................................................................................... 256 List Program Clicks....................................................................................................................... 258 View Program Clicks .................................................................................................................... 260 Detailed Clicks .................................................................................................................................... 262 Add Detailed Clicks ...................................................................................................................... 262 List Detailed Clicks ....................................................................................................................... 264 View Detailed Click...................................................................................................................... 266 Program Leads .................................................................................................................................... 268 Add Program Leads ..................................................................................................................... 268 Edit Program Leads...................................................................................................................... 270 List Program Leads ...................................................................................................................... 272 View Program Leads .................................................................................................................... 274 Detailed Leads .................................................................................................................................... 276 Add Detailed Leads...................................................................................................................... 276 Edit Detailed Leads ...................................................................................................................... 278 Remove Detailed Leads ............................................................................................................... 280 List Detailed Leads....................................................................................................................... 281 View Detailed Leads .................................................................................................................... 283
Detailed Sales ..................................................................................................................................... 285 Add Detailed Sales ...................................................................................................................... 285 Edit Detailed Sales ....................................................................................................................... 288 List Detailed Sales........................................................................................................................ 290 View Detailed Sales ..................................................................................................................... 292 Edit Sale Line Items ..................................................................................................................... 294 View Sale Line Items ................................................................................................................... 296 Reporting ............................................................................................................................................ 298 Campaign Statistics ..................................................................................................................... 298 Affiliate Statistics ........................................................................................................................ 301 Super Affiliate Statistics .............................................................................................................. 304 Creative Statistics ........................................................................................................................ 309 Creative Deployment Statistics................................................................................................... 311 Product Statistics ......................................................................................................................... 313 Optional Info Statistics ................................................................................................................ 315 Click Referral Statistics ................................................................................................................ 317 View Click Referral Details .......................................................................................................... 319 Sub ID Statistics ........................................................................................................................... 321 List Statistics ................................................................................................................................ 323 Quick Reports .............................................................................................................................. 326 API Reference - CrossPublication .................................................................................................... 328 CrossPublished Offers ........................................................................................................................ 328 Add CrossPublished Offer ........................................................................................................... 328 Edit CrossPublished Offer ........................................................................................................... 330 Remove CrossPublished Offer .................................................................................................... 332 List CrossPublished Offers........................................................................................................... 333 View CrossPublished Offer.......................................................................................................... 335 CrossPublished Companies................................................................................................................. 337 List CrossPublished Companies................................................................................................... 337 View CrossPublished Company................................................................................................... 339
CrossPublication Requests ................................................................................................................. 341 Request Offer Approval .............................................................................................................. 341 Approve/Deny Offer Request ..................................................................................................... 342 List Offer Requests ...................................................................................................................... 343 View Approval Request ............................................................................................................... 345 Classifieds Listings .............................................................................................................................. 347 Create a CrossPub Classified Listing ........................................................................................... 347 Edit a CrossPub Classified Listing ................................................................................................ 349 List CrossPub Classifieds.............................................................................................................. 351 View a CrossPub Classified.......................................................................................................... 353 CrossPub Classifieds Communications ............................................................................................... 355 Create a CrossPub Communication ............................................................................................ 355 Edit a CrossPub Communication ................................................................................................. 357 List CrossPub Communications ................................................................................................... 359 View a CrossPub Communication ............................................................................................... 361 API Reference Advertiser Management........................................................................................ 363 Advertisers.......................................................................................................................................... 363 Add Advertisers ........................................................................................................................... 363 Edit Advertisers ........................................................................................................................... 365 List Advertisers ............................................................................................................................ 367 View Advertisers ......................................................................................................................... 369 Advertiser Contacts ............................................................................................................................ 371 Add Advertiser Contacts ............................................................................................................. 371 Edit Advertiser Contacts.............................................................................................................. 373 Remove Advertiser Contacts ...................................................................................................... 375 List Advertiser Contacts .............................................................................................................. 376 View Advertisers ......................................................................................................................... 378 Advertiser Groups............................................................................................................................... 380 Add Advertiser Groups ................................................................................................................ 380 Edit Advertiser Groups ................................................................................................................ 383
Remove Advertiser Groups ......................................................................................................... 386 List Advertiser Groups ................................................................................................................. 387 View Advertiser Groups .............................................................................................................. 389 API Reference Lead Management ................................................................................................ 391 Consumer Leads ................................................................................................................................. 391 Add Consumer Leads ................................................................................................................... 391 Edit Consumer Lead..................................................................................................................... 393 List Consumer Leads .................................................................................................................... 395 View Consumer Leads ................................................................................................................. 397
Introduction
This user guide contains all of the information needed to get started with the DirectTrack API Fleet.
The DirectTrack API Fleet allows clients as well as their affiliates and advertisers comprehensive access to their DirectTrack accounts through Application Programming Interface (API) calls. These API calls are built using REST and can be incorporated into custom applications, allowing DirectTrack to become a perfect fit for every unique workflow.
What is REST?
The DirectTrack API Fleet is built using a RESTful architecture that provides flexibility, performance and reusability. REST is an acronym for Representational State Transfer, the name given to a set of architectural principles by which all application functionality can be considered resources. According to REST, each campaign, creative, payout, CrossPublication, etc in DirectTrack can be called and treated as a resource. Each resource is assigned a Unique Resource Identifier (URI) which is very much like a website URL. REST resources can be accessed through four http operations: POST (Create), GET (Read), PUT (Update), and DELETE (Delete). When an application calls upon a REST resource, that application receives a response that represents the resource, in this case, XML. This response can be used by your application as needed or used to make additional API calls.
What is XML?
REST resources are defined using Extensible Markup Language, or XML. XML provides a useful way to share structured data via the Internet, encode documents, and serialize data. XML is also very flexible in that it allows for the definition of custom elements. In this case, each piece of a campaign, creative, payout and CrossPublication such as type, status, etc becomes an element. All of these elements and their attributes are defined via an XML Schema Definition file, or XSD.
Getting and Using XSDs

These XSDs should be used to programmatically validate the XML documents that are being submitted to the APIs. XSDs can be found for each resource type within your DirectTrack account at the following locations: XSD Locations API Users https://[client_domain]/apifleet/xsd/[version]/apiUser.xsd Client Users https://[client_domain]/apifleet/xsd/[version]/client.xsd Affiliates https://[client_domain]/apifleet/xsd/[version]/affiliate.xsd Affiliate Groups https://[client_domain]/apifleet/xsd/[version]/affiliateGroup.xsd Affiliate Blacklists https://[client_domain]/apifleet/xsd/[version]/affiliateBlacklist.xsd Affiliate Edit Requests https://[client_domain]/apifleet/xsd/[version]/affiliateEditRequest.xsd Affiliate Campaign Access Requests https://[client_domain]/apifleet/xsd/[version]/campaignAccessRequest.xsd Creative Deployments https://[client_domain]/apifleet/xsd/[version]/creativeDeployment.xsd Third Party Pixels https://[client_domain]/apifleet/xsd/[version]/thirdPartyPixel.xsd Tracking URLs https://[client_domain]/apifleet/xsd/[version]/trackingURL.xsd Emailing Affiliates https://[client_domain]/apifleet/xsd/[version]/affiliateEmailTemplate.xsd https://[client_domain]/apifleet/xsd/[version]/affiliateManualEmail.xsd https://[client_domain]/apifleet/xsd/[version]/affiliateAutoEmail.xsd https://[client_domain]/apifleet/xsd/[version]/emailReport.xsd Affiliate Histories https://[client_domain]/apifleet/xsd/[version]/affiliateHistory.xsd Campaigns https://[client_domain]/apifleet/xsd/[version]/campaign.xsd Campaign Groups https://[client_domain]/apifleet/xsd/[version]/campaignGroup.xsd Campaign Categories https://[client_domain]/apifleet/xsd/[version]/campaignCategory.xsd Creatives https://[client_domain]/apifleet/xsd/[version]/creative.xsd
XSD Locations Mobile Creative Helper SMS Short Codes https://[client_domain]/apifleet/xsd/[version]/smsShortCode.xsd Mobile Creative Helper SMS Contact Lists https://[client_domain]/apifleet/xsd/[version]/smsContactList.xsd Payouts https://[client_domain]/apifleet/xsd/[version]/payout.xsd Products https://[client_domain]/apifleet/xsd/[version]/product.xsd Product Brands https://[client_domain]/apifleet/xsd/[version]/productBrand.xsd Product Categories https://[client_domain]/apifleet/xsd/[version]/productCategory.xsd Program Impressions https://[client_domain]/apifleet/xsd/[version]/programImpression.xsd Program Clicks https://[client_domain]/apifleet/xsd/[version]/programClick.xsd Detailed Clicks https://[client_domain]/apifleet/xsd/[version]/clickDetail.xsd Program Leads https://[client_domain]/apifleet/xsd/[version]/programLead.xsd Detailed Leads https://[client_domain]/apifleet/xsd/[version]/leadDetail.xsd Detailed Sales https://[client_domain]/apifleet/xsd/[version]/saleDetail.xsd Sale Line Items https://[client_domain]/apifleet/xsd/[version]/saleLineItem.xsd Campaign, Affiliate, Creative and Creative Deployment Statistics https://[client_domain]/apifleet/xsd/[version]/stats.xsd Super Affiliate Statistics https://[client_domain]/apifleet/xsd/[version]/statSuperAffiliate.xsd Product Statistics https://[client_domain]/apifleet/xsd/[version]/statProduct.xsd Optional Info Statistics https://[client_domain]/apifleet/xsd/[version]/optInfo.xsd Click Referral Statistics https://[client_domain]/apifleet/xsd/[version]/statClickReferral.xsd Click Referral Details https://[client_domain]/apifleet/xsd/[version]/clickReferral.xsd CrossPublication https://[client_domain]/apifleet/xsd/[version]/xpubCompany.xsd https://[client_domain]/apifleet/xsd/[version]/xpubOffer.xsd https://[client_domain]/apifleet/xsd/[version]/xpubRequest.xsd https://[client_domain]/apifleet/xsd/[version]/xpubClassified.xsd
XSD Locations https://[client_domain]/apifleet/xsd/[version]/xpubCommunication.xsd Advertisers https://[client_domain]/apifleet/xsd/[version]/advertiser.xsd Advertiser Contacts https://[client_domain]/apifleet/xsd/[version]/advertiserContact.xsd Affiliate Groups https://[client_domain]/apifleet/xsd/[version]/advertiserGroup.xsd Consumer Leads https://[client_domain]/apifleet/xsd/[version]/consumerLead.xsd
Resource Caching
The DirectTrack API Fleet makes use of resource caching which means that frequently accessed data from your DirectTrack account is temporarily stored in memory. The first time that a specific set of data is retrieved using an API the set is automatically placed into memory. If that same call is made for the same set of data and the data has not expired since the last call, the snapshot from the cache is returned instead. You do not need to do any additional development to take advantage of resource caching, it is all handled automatically! Caching provides several benefits to the user: Accessing the cached information for your account is much more rapid than the traditional APIs, resulting in better performance for your application. API points are not accrued when data is retrieved from the cache, only when the API retrieves a specific set of information for the first time, the data has changed, or an extended period of time has passed since the last call for that same set of data.
How do you know if the data that is being returned is coming from the cache? Some resources will include an Age HTTP header that will indicate how long the data has been stored in the cache. You can use this information to estimate whether or not to pull fresh data. To pull fresh data and bypass the cache, simply add a Cache-Control:No-Cache header to your HTTP request. Be sure to remove this header once the fresh data has been pulled, or the cache will always be bypassed and API points will be consumed on each call.
Metadata
The term Metadata refers to the small chunks of data that are returned in addition to a REST URL with most list resources. These small chunks of data are taken from the resource that the REST URL points to and provide frequently used information such as ID, type or name of the resource. Why is this important? It means that more information can be retrieved with fewer API calls!
Each list resource that offers metadata in its response will provide up to three metadata values. These values are static and cannot be changed. For more information on metadata values returned for specific list resources, please consult the API Reference section for that resource.
Accessing the API Fleet

Security
The security of your information as well as that of your affiliates and advertisers is extremely important. Because the API Fleet has the capability to transmit massive amounts of sensitive information, it makes use of a security protocol called Secure Sockets Layer, or SSL. This protocol encrypts and decrypts sent messages automatically by simply specifying https instead of http at the beginning of each REST URL.
Note: If https is not specified, no response will be returned from API Fleet
calls.
Authentication
For Clients
DirectTrack clients should contact an account executive to discuss activating the API Fleet for your DirectTrack account. Once the APIs have been activated, you will be required to set up a username and password from within your DirectTrack admin interface to access the APIs. During this initial setup, a username AND password MUST be supplied. This username and password will be used for API access only. An access ID will also be provided to you. These credentials must be supplied for every single call made to the APIs. Optionally, you may also choose to permit your advertisers and affiliates to use the APIs. Access can be controlled per advertiser/affiliate for each individual API.
Note: The Limited Security Access Module does not apply to the API Fleet.
For Advertisers and Affiliates

If a DirectTrack client has opted to allow advertiser and affiliate access to the APIs, the affiliates and advertisers must go through a two-step signup process if they wish to use those APIs. For affiliates, the DirectTrack client must first activate the signup form in the user interface. This can be accomplished by navigating to Account Setup > Configure Appearance > Affiliate Interface Content > Tools and placing a checkmark in the Display? column next to the API Fleet tool option:
This will display a setup option that provides a way for the affiliate to create an API Fleet username and password. During this initial setup, a username AND password MUST be supplied. This username and password will be used for API access only. An access ID will also be provided. These credentials must be supplied for every call made to the APIs. For advertisers, clients must either incorporate a link to /secure/webservices/api_access_setup.html in their advertiser interface setup, or direct their advertisers to navigate to this page where the advertiser may create their credentials. Once an affiliate or advertiser user has created their credentials, clients must approve the user for access to the API Fleet via their DirectTrack administrative interface. Users that have created credentials will appear on the API Security Settings page located at API Management > Web Services Setup. This is done on a per-user basis, and access can be granted on a per-API basis. Once approved, the advertiser or affiliate will be free to use those approved APIs as needed.
Access IDs
An access ID is a unique numerical identifier that is required to be provided to REST URLs that retrieve campaign, creative, payout or CrossPublication lists. When specifying an access ID of 1234 through the REST URL, the REST URL might look like: https://[client_domain]/apifleet/rest/[client_id]/1234/campaign/active/ Access IDs are used to ensure that the content that is being provided is only the content that is pertinent to the user that requested it. Access IDs have additional uses to DirectTrack clients above accessing the API Fleet. Namely, a client may also call upon a REST resource using one of their advertisers or affiliates access IDs to verify the content that is being provided to those users.
Usage
API usage is tallied using a points system. Each API call has a specified point value associated with it and can be either a flat rate for each call or a variable rate based on the number of rows of data returned. The total points for each call made will be recorded to your DirectTrack account. Each API and associated point value is as follows:
Campaign Management
Campaigns API Name createCampaign editCampaign listCampaign getCampaignDetail Campaign Groups API Name createCampaignGroup editCampaignGroup removeCampaignGroup listCampaignGroup getCampaignGroupDetail Campaign Categories API Name createCampaignCategory editCampaignCategory listCampaignCategory getCampaignCategoryDetail Creatives API Name createCreative editCreative removeCreative listCreative getCreativeDetail Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat
Mobile Creative Helper SMS Short Code API Name listSMSShortCode getSMSShortCode API Name createSMSContactList editSMSContactList listSMSContactList getSMSContactList Payouts API Name createPayout editPayout removePayout listPayout getPayout Traffic Limits API Name createTrafficLimit editTrafficLimit removeTrafficLimit listTrafficLimit getTrafficLimitDetail Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 1 10 Points 10 10 1 10 Rate Type Per Row Flat Rate Type Flat Flat Per Row Flat
Mobile Creative Helper SMS Contact List
Affiliate Management
Affiliates API Name createAffiliate editAffiliate listAffiliate getAffiliateDetail Affiliate Groups API Name createAffiliateGroup editAffiliateGroup removeAffiliateGroup listAffiliateGroup getAffiliateGroupDetail Affiliate Blacklist API Name createAffiliateOnBlacklist removeAffiliateOnBlacklist listAffiliateBlacklist Affiliate Edit Requests API Name editAffiliateEditRequest listAffiliateEditRequest getAffiliateEditRequestDetail Affiliate Campaign Requests API Name createCampaignAccessRequest editCampaignAccessRequest listCampaignAccessRequest getCampaignAccessRequestpDetail Creative Deployments API Name createCreativeDeployment editCreativeDeployment removeCreativeDeployment listCreativeDeployment getCreativeDeploymentDetail Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat Points 10 1 10 Rate Type Flat Per Row Flat Points 10 10 1 Rate Type Flat Flat Per Row Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat Third Party Pixels API Name createThirdPartyPixel removeThirdPartyPixel listThirdPartyPixel getThirdPartyPixelDetail Tracking URLs API Name getTrackingURLDetail Emailing Affiliates API Name createAffiliateEmailTemplate editAffiliateEmailTemplate removeAffiliateEmailTemplate listAffiliateEmailTemplate getAffiliateEmailTemplateDetail createAffiliateManualEmail editAffiliateManualEmail removeAffiliateManualEmail listAffiliateManualEmail getAffiliateManualEmailDetail createAffiliateAutoEmail editAffiliateAutoEmail removeAffiliateAutoEmail listAffiliateAutoEmail getAffiliateAutoEmailDetail listEmailReport getEmailReportDetail Affiliate Histories API Name getAffiliate History Points 10 Rate Type Flat Points 10 10 10 1 10 10 10 10 1 10 10 10 10 1 10 1 10 Rate Type Flat Flat Flat Per Row Flat Flat Flat Flat Per Row Flat Flat Flat Flat Per Row Flat Per Row Flat Points 10 Rate Type Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat
Advertiser Management
Advertisers API Name createAdvertiser editAdvertiser listAdvertiser getAdvertiser Advertiser Contacts API Name createAdvertiserContact editAdvertiserContact removeAdvertiserContact listAdvertiserContact getAdvertiserContact Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat Advertiser Groups API Name createAdvertiserGroup editAdvertiserGroup removeAdvertiserGroup listAdvertiserGroup getAdvertiserGroupDetail Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat
10
Data Management
Program Impressions API Name createProgramImpression listProgramImpression getProgramImpression Program Clicks API Name createProgramClick editProgramClick listProgramClick getProgramClick Detailed Clicks API Name createClickDetail listClickDetail getClickDetail Program Leads API Name createProgramLead editProgramLead listProgramLead getProgramLead Detailed Leads API Name createLeadDetail editLeadDetail removeLeadDetail listLeadDetail getLeadDetail Detailed Sales API Name createSaleDetail editSaleDetail listSaleDetail getSaleDetail Points 10 10 1 10 Rate Type Flat Flat Per Row Flat Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 10 1 1 Rate Type Flat Flat Per Row Per Row Points 10 1 10 Rate Type Flat Per Row Flat Points 10 10 1 10 Rate Type Flat Flat Per Row Flat Points 10 1 10 Rate Type Flat Per Row Flat Reporting API Name getCampaignStatistics getAffiliateStatistics getSuperAffiliateStatistics getCreativeStatistics getCreative DeploymentStatistics getProductStatistics getOptInfoStatistics getClickReferralStatistics getClickReferralDetail getSubIDStatistics listStatistics getQuickReport Points 10 10 10 10 10 10 10 10 10 10 1 10 Rate Type Flat Flat Flat Flat Flat Flat Flat Flat Flat Flat Per Row Flat
User Management
API Users API Name createAPIUser listAPIUser getAPIUser Client User Accounts API Name createClientUser editClientUser removeClientUser listClientUser getClientUserDetail Points 10 10 10 1 10 Rate Type Flat Flat Flat Per Row Flat Points 10 1 10 Rate Type Flat Per Row Flat
11
CrossPublication
CrossPublication API Name createXpubOffer editXpubOffer removeXpubOffer listXpubOffer getXpubOffer listXpubCompany getXpubCompany createXpubRequest editXpubRequest listXpubRequest getXpubRequest createXpubClassified editXpubClassified listXpubClassified getXpubClassifiedDetail createXpubCommunication editXpubCommunication listXpubCommunication getXpubCommunication
Datafeeds
Products
Points 10 10 10 1 10 1 10 10 10 1 10 10 10 1 10 10 10 1 10
Rate Type Flat Flat Flat Per Row Flat Per Row Flat Flat Flat Per Row Flat Flat Flat Per Row Flat Flat Flat Per Row Flat
API Name createProduct editProduct removeProduct listProduct getProductDetail Product Brands API Name createProductBrand editProductBrand listProductBrand getProductBrandDetail Product Categories API Name createProductCategory editProductCategory listProductCategory getProductCategoryDetail
Points 10 10 10 1 10 Points 10 10 1 10 Points 10 10 1 10
Rate Type Flat Flat Flat Per Row Flat Rate Type Flat Flat Per Row Flat Rate Type Flat Flat Per Row Flat
Lead Management
ConsumerLeads API Name createConsumerLead editConsumerLead listConsumerLead getConsumerLeadDetail Points 10 10 1 10 Rate Type Flat Flat Per Row Flat
12
Restrictions
The API Fleet limits the number of calls that can be made per hour using a soft and hard threshold. At 150,000 points used, the soft threshold will be reached and a warning email will be sent to the notification email set in your DirectTrack account under API Management > Web Services Setup > API Admin Email. If excessive usage continues, the API account will be locked for up to 2 hours once the hard threshold of 225,000 points is met. Repeated excessive usage and hard threshold lockouts can result in a permanent cancellation of the offending API account. You may be eligible for threshold increases under certain circumstances. Contact your Account Executive for more information.
13
Errors
APIs may generate HTTP errors and/or API Fleet specific errors. In the event that an API request generates an error, the following are HTTP error codes that may be returned:
HTTP Error Code 400 400 400 400 400 400 400 400 401 401 401 401 401 403 403 404 404 404 404 404 500 500 500 500
API Fleet Error Message API Fleet not enabled. Could not find Access ID - %s Document supplied does not comply with the XML Schema for this resource Reason: %s Document validation failed: %s Please supply a document to modify this resource. Record could not be created - %s Record could not be removed - %s Record could not be updated - Reason: %s Authorization Header Not Found Invalid Authorization String Invalid Developer Token Invalid LDAP Credentials Invalid Username or Password Account Locked You do not have permission to use this resource. %s not found or access denied. API does not exist. Invalid Client Domain Invalid Interface Invalid Version An internal error has been encountered. Cannot connect to LDAP server - %s Server did not return a response. The request could not be completed.
Note: %s would be replaced by data from the specific call that generated
the error.
14
In the event that an API request generates an error, the following are API Fleet specific error messages that may be returned:
Campaign ADD The location attribute is not valid when adding new resources. The campaign name is required when adding a new campaign. A campaign cannot be created with a status of 'deleted'. The primary advertiser email address (xxxxx) is not valid. A campaign image element cannot be modified directly. Please use the 'newImageFile' element to set a campaign image. removeExisting is not a valid image option during campaign creation. A file method is required when using the 'newImageFile' element. A file location is required when using the 'newImageFile' element. An FTP Server is required when using the 'newImageFile' element and method 'ftp'. An FTP Username is required when using the 'newImageFile' element and method 'ftp'. An FTP Password is required when using the 'newImageFile' element and method 'ftp'. When using the 'newImageFile' element and method 'globalftp' your account must have FTP credentials stored in the system. The category (xxxxxx) is not valid. The campaign group address (xxxxxxx) is malformed. The campaign group address (xxxxxxxx) is not valid. A campaign cannot be assigned to all countries and a specific list of countries at the same time. The country (xxxxxxxxx) is not valid. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: xxxxxxx The campaign name is required. The location attribute is not valid when adding new resources. The campaign address (xxxxxxxxx) is malformed. The campaign address (xxxxxxxxxx) is not valid. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: xxxxxxx
EDIT
CampaignGroup ADD
15
Creative ADD The campaign location is required. The campaign address (xxxxxxx) is malformed. The campaign address (xxxxxxxxx) is not valid or access denied to the campaign. The campaign location is required. The campaign address (xxxxxxxxx) is malformed. The campaign address (xxxxxxxxx) is not valid or access denied to the campaign. The location attribute is not valid when adding new resources. The campaign address (xxxxxxxxx) is malformed. The campaign address (xxxxxxxxx) is not valid or access denied to the campaign. A payout cannot be assigned to all affiliates and a single affiliate code at the same time. A payout must be assigned to either all affiliates or a single affiliate code. The affiliate code (xxxxxxxx) is not valid. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: xxxxxxx A payout type cannot be changed. Please create a new payout. A campaign payout cannot be changed to a different campaign. An affiliate payout cannot be changed to a different affiliate.
EDIT
Payout ADD
EDIT
16
Affiliate ADD The location attribute is not valid when adding new resources. The password field is required when adding a new affiliate. The state ({$return_array['state']}) is not valid. The country ({$return_array['country']}) is not valid. The category ({$return_array['category1']}) is not valid. The category ({$return_array['category2']}) is not valid. The category ({$return_array['category3']}) is not valid. You cannot have a percentage greater than 100 for a blanket commissions percent. ({$percent}) The referredBy address ({$group_location}) is malformed. The affiliate address ({$location}) is not valid. You must include the ipAddress element when adding an affiliate. The site type ({$return_array['siteType']}) is not valid. The affiliate group address ({$group_location}) is malformed. The affiliate group address ({$group_location}) is not valid. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI(); The state ({$return_array['state']}) is not valid. The country ({$return_array['country']}) is not valid. The category ({$return_array['category1']}) is not valid. The category ({$return_array['category2']}) is not valid. The category ({$return_array['category3']}) is not valid. You cannot have a percentage greater than 100 for a blanket commissions percent. ({$percent}) The referredBy address ({$group_location}) is malformed. The affiliate address ({$location}) is not valid. The site type ({$return_array['siteType']}) is not valid. The affiliate group address ({$group_location}) is malformed. The affiliate group address ({$group_location}) is not valid. The location attribute is not valid when adding new resources. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI();
EDIT
Affiliate Group ADD EDIT
17
Affiliate Blacklist ADD
The address $location is malformed. The address blacklistResourceURL is not valid or access denied to the blacklistResourceURL The blacklistResourceURL address if mandatory field. The address resourceURL is not valid or access denied to the resourceURL. The resourceURL address if mandatory field. EDIT The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI(); Creative Deployment ADD The location attribute is not valid when adding new resources. Please specify an appropriate Landing page URL Both the landingPageUrl and the campaign ID cannot be specified at the same time. Please specify either one of them Both the landingPageUrl and the campaign ID are missing. Either one of them is mandatory. The campaign location is required. The campaign address ({$return_array['campaign_location']}) is malformed. The campaign address ({$return_array['campaign_location']}) is not valid or access denied to the campaign. A valid affiliate resourceURL needs to be specified while creating a new creative deployment. The affiliate location is required. The affiliate address ({$return_array['affiliate_location']}) is malformed. The affiliate address ({$return_array['affiliate_location']}) is not valid or access denied to the affiliate. A valid creative resourceURL needs to be specified while creating a new creative deployment. The creative location is required. The creative address ({$return_array['creative_location']}) is malformed. The creative address ({$return_array['creative_location']}) is not valid or access denied to the creative. EDIT The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI(); Creative cannot be specified while editing Creative deployment Campaign cannot be specified while editing Creative deployment Affiliate cannot be specified while editing Creative deployment Active cannot be specified while editing Creative deployment
18
ThirdParty Pixel ADD The location attribute is not valid when adding new resources. The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Third Party Pixels for your own affiliate account. The campaign address ({$location}) is malformed. The campaign address ({$location}) is not valid. You do not have access the campaign specified. The affiliate does not have access to the campaign specified. You do not have access the campaign specified. The content length for pixel is larger than the maximum size - {$max}. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI(); The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. The campaign address ({$location}) is malformed. The campaign address ({$location}) is not valid. You do not have access the campaign specified. The affiliate does not have access to the campaign specified. The content length for pixel is larger than the maximum size - {$max}. The location attribute is not valid when adding new resources. The campaign address (xxxxxxx) is malformed. No Campaign is mentioned for crosspublish The company address (xxxxx) is malformed. Company should be mentioned to whom the campign is required to be crosspublished. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: xxxxxxx
EDIT
Crosspublication Offer ADD
EDIT
CrossPublication Request ADD The location attribute is not valid when adding new resources. The Child Company is required. The Company address (xxxxxxx) is malformed. The Offer is required. The offer address (xxxxxxx) is malformed. The offer address (xxxxxxx) is not a valid offer. You are not eligible for this offer EDIT The required location attribute for the resource does not match the resource you are attempting to modify. Expected: xxxxxxx You do not have access to modify this offer Invalid status
19
Program Impression ADD The location attribute is not valid when adding new resources. You cannot add more than 1000 impressions at a time. You must add at least 1 impression. The campaign address ({$location}) is malformed. The campaign address ({$location}) is not valid. The campaign is not active. You do not have access to the campaign specified. The affiliate does not have access to the campaign specified. You do not have access to the campaign specified. The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Program Leads for your own affiliate account. You do not have access to the Affiliate specified. The creative address ({$location}) is malformed. The creative address ({$location}) is not valid. The creative ({$location}) is not active. The creative ({$location}) is not a valid contextual creative. You do not have access the creative specified. The affiliate does not have access to the creative specified. You do not have access the creative specified. There are no creatives for the campaign specified. There are no contextual creatives for the campaign specified. The creative deployment address ({$location}) is malformed. The creative deployment address ({$location}) is not valid. You do not have access the campaign deployment specified. You do not have access the creative deployment specified.
20
Program Click ADD
EDIT
The affiliate location is required. The affiliate address ({$return_array['affiliate_location']}) is malformed. The affiliate address ({$return_array['affiliate_location']}) is not valid or access denied to the affiliate. The affiliate address is mandatory field. The campaign location is required. The campaign address ({$return_array['campaign_location']}) is malformed. The campaign address ({$return_array['campaign_location']}) is not valid or access denied to the campaign. The campaign address is mandatory field. The creative location is required. The creative address ({$return_array['creative_location']}) is malformed. The creative address ({$return_array['creative_location']}) is not valid or access denied to the creative. The creative address is mandatory field. The creative deployment location is required. The creative deploy address ({$return_array['creative_deploy_location']}) is malformed. The creative deploy address ({$return_array['creative_deploy_location']}) is not valid or access denied to the creative deployment. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI();
21
Detailed Click ADD
The affiliate location is required. The affiliate address ({$return_array['affiliate_location']}) is malformed. The affiliate address ({$return_array['affiliate_location']}) is not valid or access denied to the affiliate. The affiliate address is mandatory field. The campaign location is required. The campaign address ({$return_array['campaign_location']}) is malformed. The campaign address ({$return_array['campaign_location']}) is not valid or access denied to the campaign. The campaign address is mandatory field. The creative location is required. The creative address ({$return_array['creative_location']}) is malformed. The creative address ({$return_array['creative_location']}) is not valid or access denied to the creative. The creative address is mandatory field. The creative deployment location is required. The creative deploy address ({$return_array['creative_deploy_location']}) is malformed. The creative deploy address ({$return_array['creative_deploy_location']}) is not valid or access denied to the creative deployment.
22
Program Lead ADD
EDIT
The location attribute is not valid when adding new resources. You cannot add more than 1000 leads at a time. You must add at least 1 lead. The campaign address ({$location}) is malformed. The campaign address ({$location}) is not valid. The campaign is not active. You do not have access to the campaign specified. The affiliate does not have access to the campaign specified. You do not have access to the campaign specified. The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Program Leads for your own affiliate account. You do not have access to the Affiliate specified. The creative address ({$location}) is malformed. The creative address ({$location}) is not valid. You do not have access the creative specified. The affiliate does not have access to the creative specified. You do not have access the creative specified. The creative deployment address ({$location}) is malformed. The creative deployment address ({$location}) is not valid. You do not have access the campaign deployment specified. The affiliate does not have access to the creative deployment specified. You do not have access the creative deployment specified. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI();
23
Detailed Lead ADD
EDIT
The location attribute is not valid when adding new resources. The campaign address ({$location}) is malformed. The campaign address ({$location}) is not valid. The campaign is not active. You do not have access to the campaign specified. The affiliate does not have access to the campaign specified. You do not have access to the campaign specified. The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Program Leads for your own affiliate account. You do not have access to the Affiliate specified. The creative address ({$location}) is malformed. The creative address ({$location}) is not valid. You do not have access the creative specified. The affiliate does not have access to the creative specified. You do not have access the creative specified. The creative deployment address ({$location}) is malformed. The creative deployment address ({$location}) is not valid. You do not have access the campaign deployment specified. The affiliate does not have access to the creative deployment specified. You do not have access the creative deployment specified. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI(); The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Program Leads for your own affiliate account. The creative address ({$location}) is malformed. The creative address ({$location}) is not valid. You must pass either an affiliate, creative or both when editing a Lead Detail.
24
Detailed Sale ADD
EDIT
The location attribute is not valid when adding new resources. You must pass both a quantity and amount in the lineItem node. You must include the lineItems node when adding a new Sale Detail. The campaign address ({$location}) is malformed. The campaign address ({$location}) is not valid. The campaign is not active. You do not have access to the campaign specified. The affiliate does not have access to the campaign specified. You do not have access to the campaign specified. The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Sale Details for your own affiliate account. You do not have access to the Affiliate specified. The creative address ({$location}) is malformed. The creative address ({$location}) is not valid. You do not have access the creative specified. The affiliate does not have access to the creative specified. You do not have access the creative specified. The creative deployment address ({$location}) is malformed. The creative deployment address ({$location}) is not valid. You do not have access the campaign deployment specified. The affiliate does not have access to the creative deployment specified. You do not have access the creative deployment specified. The sale status ({$return_array['saleStatus']}) is not valid. The salesRep passed is not a valid user in the system. The platform passed in is not valid. The required location attribute for the resource does not match the resource you are attempting to modify. Expected: " . $this->getCleanURI(); The affiliate address ({$location}) is malformed. The affiliate address ({$location}) is not valid. You can only add Sale Details for your own affiliate account. You do not have access to the Affiliate specified. The creative address ({$location}) is malformed. The creative address ({$location}) is not valid. You do not have access the creative specified. The salesRep passed is not a valid user in the system.
25
Data Types
Below is a table outlining all of the data types accepted by the DirectTrack API Fleet. Data Type anyURI booleanInt decimal double integer resourceURI short string unsignedInt Description A Uniform Resource Identifier (URI) The booleanInt type is a logical type that accepts values of either 1 (true) or 0 (false). A decimal is a number value that allows fractional values. In the case of the DirectTrack APIs, 8 digits to the left of the decimal point and two to the right. A decimal is a number value that allows fractional values between +/- 1.7e308 (approximately). An integer is a whole number (not a fraction) that can be positive, negative, or zero. A Uniform Resource Identifier (URI) that points to an API Fleet resource object An integer between 0 and 32767 A sequence of alphanumeric characters with a predetermined limit. A non-negative whole number between 0 and 4294967295.
26
API Placeholders
Several placeholders have been used throughout the API documentation to indicate areas that would be filled in by your account-specific information. They are: Placeholder [access_id] [advertiser_contact_id] [advertiser_group_id] [advertiser_id] [affiliate_add_code] [affiliate_edit_request_id] [affiliate_email_template_id] [affiliate_manual_email_id] [affiliate_auto_email_id] [affiliate_group_id] Description The unique integer ID required to access lists within the API Fleet. An integer ID representing an Advertiser Contact. An integer ID representing an Advertiser Group. An integer ID representing an Advertiser. A string value used to represent an affiliate record in the DirectTrack administration interface. An integer ID representing an affiliates request to edit their account. An integer ID representing a template used to send affiliate emails. An integer ID representing a one-time affiliate email. An integer ID representing an automated recurring affiliate email. A string ID representing an affiliate group and consisting of two parts, a group owner and integer ID. For example, a clients affiliate group ID would look like C1234. Group Owner Owner Name Advertiser Client [affiliate_id] [blacklist_id]
Value Used A C
An integer ID representing an Affiliate. A string ID representing a blacklist and consisting of three parts: a blacklist target, entity type, and a underscore-separated concatenation of the distinct IDs that represent the first two parts. For example, a blacklist ID for affiliates on a campaign would look like CA12_34 where 12 would be the affiliate ID and 34 would be the campaign ID. Blacklist Target Target Name Banner (Creative) Campaign Entity Types Type Name Affiliate Affiliate Group
Value Used B C
Value Used A G
[campaign_access_request_id] [campaign_category_id] [campaign_group_id] [campaign_id]
An integer ID representing a campaign access request by an affiliate. An integer ID representing a campaign category. An integer ID representing a campaign group. An integer ID representing a campaign.
27
Placeholder [classified_id] [click_detail_id] [click_referral_id] [client_domain] [client_id] [consumer_lead_id] [country_abbreviation] [creative_deployment_id] [creative_id] [dd] [email_report_id] [info_id] [keyword] [lead_detail_id] [mm] [offer_id] [page_number] [payout_id] [product_id] [product_brand_id] [product_category_id] [program_click_id] [program_impression_id] [program_lead_id] [request_id] [sale_detail_id] [sms_short_code_id] [sms_contact_list_id] [sub_ids]
Description An integer ID representing a CrossPub Classified bid or proposal listing. An integer ID representing a detailed click. An integer ID representing a click referral record. The domain used to access DirectTrack, either [client_id].direcctrack.com or your own custom domain. Your DirectTrack client ID, which can be located under Web Services Setup > API Access Setup. An integer ID representing a consumer lead. A 2 character value - see 'Country Codes' for acceptable values. An integer ID representing a creative deployment. An integer ID representing a creative. Two-digit day value, i.e. 01 for the first day of the month An integer ID representing an email report An integer ID representing optional info for leads or sales A string used for searching Sub ID information An integer ID representing a detailed lead. Two-digit month value, i.e. 01 for January An integer ID representing a CrossPublished offer. For list resources that implement pagination this is an interger ID representing a single page. A string ID representing a payout. An integer ID representing a product. An integer ID representing a product category. An integer ID representing a product category. An integer ID representing a program click instance. An integer ID representing a program impression instance. An integer ID representing a program lead instance. An integer ID representing a CrossPublication request. An integer ID representing a detailed sale. An integer ID representing an SMS Short Code An integer ID representing an SMS Contact List An integer representing Sub ID values in the format 12345, where the first number is always the primary lookup. Example: Passing 254 would make '2' the primary lookup and return the '5' and '4' position sub ids. An integer ID representing a third party pixel. A string ID representing a tracking URL and consisting of the concatenation of an affiliate ID and a creative ID.
[third_party_pixel_id] [tracking_url_id]
28
Placeholder [traffic_limit_id] [version] [version_id] [xpub_communication_id] [xpub_company_id] [yyyy]
Description An integer ID representing a campaign traffic limit. The API Fleet version number being used, formatted 1_0. The API Fleet version number being used, formatted v1_0. An integer ID representing a CrossPub Communication message. An integer ID representing a company offering CrossPublications. Four-digit year value
29
Country Codes
Several API calls within the API Fleet accept 2-character country codes as parameters. The list below outlines valid country code values. Code AW AO AI AL AD AN AE AR AM AS AQ TF AG AU AT AZ BI BE BJ BF BD BG BH BS BA BY BZ BM BO BR BB BN Country Name Aruba Angola Anguilla Albania Andorra Netherlands Ant United Arab Emirates Argentina Armenia American Samoa Antarctica French Southern Territories Antigua and Barbuda Australia Austria Azerbaijan Burundi Belgium Benin Burkina Faso Bangladesh Bulgaria Bahrain Bahamas Bosnia And Herzegovina Belarus Belize Bermuda Bolivia Brazil Barbados Brunei Code BT BV BW CF CA CC CH CL CN CI CM CG CK CO KM CV CR CX KY CY CZ DE DJ DM DK DO DZ EC EG ER EH ES Country Name Bhutan Bouvet Island Botswana Central African Republic Canada Cocos(Keeling) Islands Switzerland Chile China Ivory Coast Cameroon Congo Cook Islands Columbia Comoros Cape Verde Costa Rica Christmas Island Cayman Islands Cyprus Czech Republic Germany Djibouti Dominica Denmark Dominican Republic Algeria Ecuador Egypt Eritrea Western Sahara Spain
30
Code EE ET FI FJ FK FR FO FM GA GB GE GH GI GN GP GM GW GQ GR GD GL GT GF GU GY HK HM HN HR HT HU ID IN IO IE IS IL IT
Country Name Estonia Ethiopia Finland Fiji Falkland Islands France Faeroe (Faroe) Islands Micronesia Gabon United Kingdom Georgia Ghana Gibraltar Guinea Guadeloupe Gambia Guinea-Bissau Equatorial Guinea Greece Grenada Greenland Guatemala French Guyana Guam Guyana Hong Kong Heard and McDonald Islands Honduras Croatia Haiti Hungary Indonesia India British Indian Ocean Terr. Ireland Iceland Israel Italy
Code JM JO JP KZ KE KG KH KI KN KR KW LA LB LR LC LI LK LS LT LU LV MO MA MC MD MG MV MX MH MK ML MT MM MN MP MZ MR MS
Country Name Jamaica Jordan Japan Kazakhstan Kenya Kyrgyzstan Cambodia Kiribati St.Kitts-Nevis-Anguilla Korea Republic Of Kuwait Laos Peoples Dem. Rep. Lebanon Liberia St. Lucia Liechtenstein Sri Lanka Lesotho Lithuania Luxembourg Latvia Macao Morocco Monaco Moldova Madagascar Maldives Mexico Marshall Islands Macedonia Mali Malta Myanmar Mongolia Northern Mariana Island Mozambique Mauritania Montserrat
31
Code MQ MU MW MY YT NA NC NE NF NG NI NU NL NO NP NR NZ OM PK PA PN PE PH PW PG PL PR PT PY PF QA RE RU RW SA SN SG
Country Name Martinique Mauritius Malawi Malaysia Mayotte Namibia New Caledonia Niger Norfolk Island Nigeria Nicaragua Niue Netherlands Norway Nepal Nauru New Zealand Oman Pakistan Panama Pitcairn Island Peru Philippines Palau Papuan W Guinea Poland Puerto Rico Portugal Paraguay French Polynesia Qatar Reunion Russian Federation Rwanda Saudi Arabia Senegal Singapore
Code GS SH SJ SB SL SV SM SO PM ST SR SK SI SE SZ SC TC TD TG TH TJ TK TM TO TT TN TR TV TW TZ UG UA UM UY US UZ VA
Country Name S. Georgia and the S. Sandwich Island St. Helena Svalbard and Janmayen Islands Solomon Islands Sierra Leone El Salvador San Marino Somalia St .Pierre and Miquelon Saotome and Principe Suriname Slovakia Slovenia Sweden Swaziland Seychelles Turks and Caicos Islands Chad Togo Thailand Tajikistan Tokelau Turkmenistan Tonga Trinidad and Tobago Tunisia Turkey Tuvalu Taiwan Tanzania Uganda Ukraine United States Minor Outlying Island Uruguay United States Uzbekistan Vatican City-State
32
Code VC VE VG VI VN VU
Country Name St.Vincent and the Grenadines Venezuela Virgin Islands (British) Virgin Islands (U.S.) Vietnam Vanuatu
Code WF WS YE ZA ZM ZW
Country Name Wallis And Futuna Islands Samoa Yemen South Africa Zambia Zimbabwe
33
APIs by Category
Below is a list of the APIs grouped by the functional category within DirectTrack: API Users API Name createAPIUser listAPIUser getAPIUser Client User Accounts API Name createClientUser editClientUser removeClientUser listClientUser getClientUser Affiliates API Name createAffiliate editAffiliate listAffiliate getAffiliateDetail
Description Creates a new API User account. Retrieves the API Fleet REST URL for a provided username and password Gets details about a specific API user
Description Creates a new client user account Edits an existing client user account Deletes a client user account Lists client users in DirectTrack Gets details about a specific client user
Description Creates a new affiliate Edits an existing affiliate Lists affiliates matching user specified criteria Gets details for a specific affiliate
Affiliate Groups API Name createAffiliateGroup editAffiliateGroup removeAffiliateGroup listAffiliateGroup getAffiliateGroupDetail
Description Creates a new affiliate group Edits an existing affiliate group Removes an affiliate group Lists affiliate groups matching user specified criteria Gets details for a specific affiliate group
34
Affiliate Blacklist API Name createAffiliateOnBlacklist removeAffiliateOnBlacklist listAffiliateBlacklist
Description Adds an affiliate to an existing blacklist Removes an affiliate from a blacklist Lists affiliate blacklists matching user specified criteria
Affiliate Edit Requests API Name editAffiliateEditRequest listAffiliateEditRequest getAffiliateEditRequestDetail
Description Updates an affiliate edit request to approved or denied Lists pending affiliate edit requests Retrieves detailed information about a specified affiliate edit request
Campaign Access Requests API Name createCampaignAccessRequest editCampaignAccessRequest listCampaignAccessRequest getCampaignAccessRequestDetail
Description Creates a new campaign access request Updates an existing campaign access request Lists campaign access requests matching user specified criteria Gets details for a specific campaign access request
Creative Deployment API Name createCreativeDeployment editCreativeDeployment listCreativeDeployment getCreativeDeploymentDetail
Description Creates a new creative deployment Updates an existing creative deployment Lists creative deployments matching user specified criteria Gets details for a specific creative deployment
Third Party Pixels API Name createThirdPartyPixel removeThirdPartyPixel listThirdPartyPixel getThirdPartyPixelDetail
Description Creates a new third party pixel Removes an existing third party pixel Lists third party pixels matching user specified criteria Gets details for a specific third party pixel
35
Tracking URLs API Name getTrackingURLDetail
Description Gets details for a specific Tracking URL
Emailing Affiliates API Name createAffiliateEmailTemplate editAffiliateEmailTemplate removeAffiliateEmailTemplate listAffiliateEmailTemplate getAffiliateEmailTemplateDetail createAffiliateManualEmail editAffiliateManualEmail removeAffiliateManualEmail listAffiliateManualEmail getAffiliateManualEmailDetail createAffiliateAutoEmail editAffiliateAutoEmail removeAffiliateAutoEmail listAffiliateAutoEmail getAffiliateAutoEmailDetail listEmailReport getEmailReportDetail
Description Creates a new affiliate email template Edits an existing affiliate email template Removes an affiliate email template Lists affiliate email templates matching user specified criteria Gets details for a specific affiliate email template Creates a new affiliate manual email Edits an existing affiliate manual email Removes an affiliate manual email Lists affiliate manual emails matching user specified criteria Gets details for a specific affiliate manual email Creates a new affiliate auto email Edits an existing affiliate affiliate auto email Removes an affiliate affiliate auto email Lists affiliate affiliate auto emails matching user specified criteria Gets details for a specific affiliate affiliate auto email Lists a history of emails that have been sent Gets details about a specific email within the email history
Affiliate Histories API Name getAffiliateHistory
Description Gets a list of past changes to an affiliates record
Campaigns API Name createCampaign editCampaign listCampaign getCampaignDetail Description Creates a new campaign Edits an existing campaign Lists campaigns matching user specified criteria Gets details for a specific campaign
36
Campaign Groups API Name createCampaignGroup editCampaignGroup removeCampaignGroup listCampaignGroup getCampaignGroupDetail
Description Creates a new campaign group Edits an existing campaign group Removes a campaign group Lists campaign groups matching user specified criteria Gets details for specific campaign groups
Campaign Categories API Name createCampaignCategory editCampaignCategory listCampaignCategory getCampaignCategoryDetail Description Creates a new campaign category Edits an existing campaign category Lists campaign category matching user specified criteria Gets details for a specific campaign category
Creatives API Name createCreative editCreative removeCreative listCreative getCreativeDetail
Description Creates a new creative Edits an existing creative Removes a creative Lists creatives matching user specified criteria Gets details for a specific creative
Mobile Creative Helpers API Name listSMSShortCode getSMSShortCode createSMSContactList editSMSContactList listSMSContactList getSMSContactList
Description Lists all SMS short codes Gets details for a specific SMS short code Creates a new SMS contact list Edits an existing SMS contact list Lists all SMS contact lists Gets details for a specific SMS contact list
37
Payouts API Name createPayout editPayout removePayout listPayout getPayout
Description Creates a new payout Edits an existing payout Removes a payout Lists payouts matching user specified criteria Gets details for a specific payout
Traffic Limits API Name createTrafficLimit editTrafficLimit removeTrafficLimit listTrafficLimit getTrafficLimitDetail
Description Creates a new traffic limit Edits an existing traffic limit Removes a traffic limit Lists traffic limits matching user specified criteria Gets details for a specific traffic limit
Products API Name createProduct editProduct removeProduct listProduct getProduct
Description Creates a new product Edits an existing product Removes a product Lists products matching user specified criteria Gets details for a specific product
Product Brands API Name createProductBrand editProductBrand listProductBrand getProductBrand
Description Creates a new product brand Edits an existing product brand Lists product brands matching user specified criteria Gets details for a specific product brand
38
Product Categories API Name createProductCategory editProductCategory listProductCategory getProductCategoryDetail
Description Creates a new product category Edits an existing product category Lists product categories matching user specified criteria Gets details for a specific product category
Program Impressions API Name createProgramImpression listProgramImpression getProgramImpression
Description Creates a new program impression instance Lists program impressions matching user specified criteria Gets details for a specific program impression instance
Program Clicks API Name createProgramClick editProgramClick listProgramClick getProgramClick
Description Creates a new program click instance Edits an existing program click instance Lists program clicks matching user specified criteria Gets details for a specific program click instance
Detailed Clicks API Name createClickDetail listClickDetail getClickDetail
Description Creates a new detailed click Lists detailed click matching user specified criteria Gets details for a specific detailed click
Program Leads API Name createProgramLead editProgramLead listProgramLead getProgramLead
Description Creates a new program lead instance Edits an existing program lead instance Lists program leads matching user specified criteria Gets details for a specific program lead instance
39
Detailed Leads API Name createLeadDetail editLeadDetail removeLeadDetail listLeadDetail getLeadDetail
Description Creates a new detailed lead Edits an existing detailed lead Removes an existing detailed lead Lists detailed leads matching user specified criteria Gets details for a specific detailed lead
Detailed Sales API Name createSaleDetail editSaleDetail listSaleDetail getSaleDetail
Description Creates a new detailed sale Edits an existing detailed sale Lists detailed sales matching user specified criteria Gets details for a specific detailed sale
Reporting API Name getCampaignStatistics getAffiliateStatistics getSuperAffiliateStatistics getCreativeStatistics getCreative DeploymentStatistics getProductStatistics getOptInfoStatistics getClickReferralStatistics getClickReferralDetail getSubIDStatistics listStatistics getQuickReport
Description Gets statistics for a specified campaign Gets statistics for a specified affiliate Gets statistics for super affiliates Gets statistics for creatives Gets statistics for creative deployments Gets statistics for products Gets statistics for optional information Gets statistics for click referrals Gets details for specific click referral records Gets statistics for sub IDs Lists dates for with available statistics for a specified campaign or affiliate Gets cumulative statistics for all campaigns or affiliates for a specified time period
40
CrossPublication API Name createXpubOffer editXpubOffer removeXpubOffer listXpubOffer getXpubOffer listXpubCompany getXpubCompany createXpubRequest editXpubRequest listXpubRequest getXpubRequest createXpubClassified editXpubClassified listXpubClassified getXpubClassifiedDetail createXpubCommunication editXpubCommunication listXpubCommunication getXpubCommunication
Description Creates a new CrossPublication Edits an existing CrossPublication Removes a CrossPublication Lists CrossPublications matching user specified criteria Gets details for a specific CrossPublication Lists companies offering CrossPublications matching user specified criteria Gets details for a specific CrossPublication company Creates a new CrossPublication request Edits an existing CrossPublication request Lists CrossPublication requests matching user specified criteria Gets details for a specific CrossPublication request Creates a new CrossPub Classified bid or proposal Edits an existing CrossPub Classified bid or proposal Lists CrossPub Classified bid or proposal listings Gets details for a specific CrossPub Classified bid or proposal Creates a new CrossPub Communication message Edits an existing CrossPub Communication message Lists CrossPub Communication messages Gets details for a specific CrossPub Communication message
Advertisers API Name createAdvertiser editAdvertiser listAdvertiser getAdvertiserDetail
Description Creates a new advertiser Edits an existing advertiser Lists advertisers matching user specified criteria Gets details for a specific advertiser
Advertiser Contacts API Name createAdvertiserContact editAdvertiserContact removeAdvertiserContact listAdvertiserContact getAdvertiserContactDetail
Description Creates a new advertiser contact Edits an existing advertiser contact Removes an advertiser contact Lists advertiser contacts matching user specified criteria Gets details for a specific advertiser contact
41
Advertiser Groups API Name createAdvertiserGroup editAdvertiserGroup removeAdvertiserGroup listAdvertiserGroup getAdvertiserGroupDetail
Description Creates a new advertiser group Edits an existing advertiser group Removes an advertiser group Lists advertiser groups matching user specified criteria Gets details for a specific advertiser group
Consumer Leads API Name createConsumerLead editConsumerLead listConsumerLead getConsumerLeadDetail
Description Creates a new consumer lead Edits an existing consumer lead Lists consumer leads matching user specified criteria Gets details for a specific consumer lead
42
APIs by HTTP Operation

Below is a list of the APIs grouped by the HTTP operation (POST, PUT, DELETE, GET) used within the API:
Create/Add/POST API Name createAPIUser createClientUser createAffiliate createAffiliateGroup createAffiliateOnBlacklist createCampaignAccessRequest createCreativeDeployment createThirdPartyPixel createAffiliateEmailTemplate createAffiliateManualEmail createAffiliateAutoEmail createCampaign createCampaignGroup createCampaignCategory createCreative createSMSContactList createPayout createTrafficLimit createProduct createProductBrand createProductCategory createProgramImpression createProgramClick createClickDetail createProgramLead createLeadDetail createSaleDetail createXpubOffer createXpubRequest createXpubClassified Description Creates a new API User account. Creates a new client user account Creates a new affiliate Creates a new affiliate group Adds an affiliate to an existing blacklist Creates a new campaign access request Creates a new creative deployment Creates a new third party pixel Creates a new affiliate email template Creates a new affiliate manual email Creates a new affiliate auto email Creates a new campaign Creates a new campaign group Creates a new campaign category Creates a new creative Creates a new SMS contact list Creates a new payout Creates a new traffic limit Creates a new product Creates a new product brand Creates a new product category Creates a new program impression instance Creates a new program click instance Creates a new detailed click Creates a new program lead instance Creates a new detailed lead Creates a new detailed sale Creates a new CrossPublication Creates a new CrossPublication request Creates a new CrossPub Classified bid or proposal
43
createXpubCommunication createAdvertiser createAdvertiserContact createAdvertiserGroup createConsumerLead
Creates a new CrossPub Communication message Creates a new advertiser Creates a new advertiser contact Creates a new advertiser group Creates a new consumer lead
44
Edit/Update/PUT API Name editClientUser editAffiliate editAffiliateGroup editAffiliateEditRequest editCreativeDeployment editCampaignAccessRequest editAffiliateEmailTemplate editAffiliateManualEmail editAffiliateAutoEmail editCampaign editCampaignGroup editCampaignCategory editCreative editSMSContactList editPayout editTrafficLimit editProduct editProductBrand editProductCategory editCreativeDeployment editProgramClick editProgramLead editLeadDetail editSaleDetail editXpubOffer editXpubRequest editXpubClassified editXpubCommunication editAdvertiser editAdvertiserContact editAdvertiserGroup editConsumerLead Description Edits an existing client user account Edits an existing affiliate Edits an existing affiliate group Edit an affiliate edit request to approved or denied Edits an existing creative deployment Edits an existing campaign access request Edits an existing affiliate email template Edits an existing affiliate manual email Edits an existing affiliate affiliate auto email Edits an existing campaign Edits an existing campaign group Edits an existing campaign category Edits an existing creative Edits an existing SMS contact list Edits an existing payout Edits an existing traffic limit Edits an existing product Edits an existing product brand Edits an existing product category Updates an existing creative deployment Edits an existing program click instance Edits an existing program lead instance Edits an existing detailed lead Edits an existing detailed sale Edits an existing CrossPublication Edits an existing CrossPublication request Edits an existing CrossPub Classified bid or proposal Edits an existing CrossPub Communication message Edits an existing advertiser Edits an existing advertiser contact Edits an existing advertiser group Edits an existing consumer lead
45
Delete/Remove/DELETE API Name removeClientUser removeAffiliateGroup removeAffiliateOnBlacklist removeThirdPartyPixel removeAffiliateEmailTemplate removeAffiliateManualEmail removeAffiliateAutoEmail removeCampaignGroup removeCreative removePayout removeTrafficLimit removeProduct removeLeadDetail removeXpubOffer removeAdvertiserContact removeAdvertiserGroup Description Removes a client user account Removes an affiliate group Removes an affiliate from a blacklist Removes an existing third party pixel Removes an affiliate email template Removes an affiliate manual email Removes an affiliate affiliate auto email Removes a campaign group Removes a creative Removes a payout Removes a traffic limit Removes a product Removes an existing detailed lead Removes a CrossPublication Removes an advertiser contact Removes an advertiser group
46
Search/List/GET API Name listAPIUser getAPIUser listClientUser getClientUser listAffiliate getAffiliateDetail listAffiliateGroup getAffiliateGroupDetail listAffiliateBlacklist listAffiliateEditRequest getAffiliateEditRequestDetail listCampaignAccessRequest getCampaignAccessRequestDetail listCreativeDeployment getCreativeDeploymentDetail listThirdPartyPixel getThirdPartyPixelDetail getTrackingURLDetail listAffiliateEmailTemplate getAffiliateEmailTemplateDetail listAffiliateManualEmail getAffiliateManualEmailDetail listAffiliateAutoEmail getAffiliateAutoEmailDetail listEmailReport getEmailReportDetail getAffiliateHistory listCampaign getCampaignDetail listCampaignGroup getCampaignGroupDetail listCampaignCategory getCampaignCategoryDetail listCreative getCreativeDetail listSMSShortCode Description Retrieves the API Fleet REST URL for a provided username and password Gets details about a specific API user Lists client users in DirectTrack Gets details about a specific client user Lists affiliates matching user specified criteria Gets details for a specific affiliate Lists affiliate groups matching user specified criteria Gets details for a specific affiliate group Lists affiliate blacklists matching user specified criteria Lists pending affiliate edit requests Gets detailed information about a specified affiliate edit request Lists campaign access requests matching user specified criteria Gets details for a specific campaign access request Lists creative deployments matching user specified criteria Gets details for a specific creative deployment Lists third party pixels matching user specified criteria Gets details for a specific third party pixel Gets details for a specific Tracking URL Lists affiliate email templates matching user specified criteria Gets details for a specific affiliate email template Lists affiliate manual emails matching user specified criteria Gets details for a specific affiliate manual email Lists affiliate affiliate auto emails matching user specified criteria Gets details for a specific affiliate affiliate auto email Lists a history of emails that have been sent Gets details about a specific email within the email history Gets a list of past changes to an affiliates record Lists campaigns matching user specified criteria Gets details for a specific campaign Lists campaign groups matching user specified criteria Gets details for specific campaign groups Lists campaign categories matching user specified criteria Gets details for specific campaign categories Lists creatives matching user specified criteria Gets details for specific creatives Lists all SMS short codes
47
Search/List/GET API Name getSMSShortCode listSMSContactList getSMSContactList listPayout getPayout listTrafficLimit getTrafficLimitDetail listProduct getProduct listProductBrand getProductBrand listProductCategory getProductCategoryDetail listProgramImpression getProgramImpression listProgramClick getProgramClick listClickDetail getClickDetail listProgramLead getProgramLead listLeadDetail getLeadDetail listSaleDetail getSaleDetail getCampaignStats getAffiliateStats listStats getQuickReport getCampaignStatistics getAffiliateStatistics getSuperAffiliateStatistics getCreativeStatistics getCreative DeploymentStatistics Description Gets details for a specific SMS short code Lists all SMS contact lists Gets details for a specific SMS contact list Lists payouts matching user specified criteria Gets details for a specific payout Lists traffic limits matching user specified criteria Gets details for a specific traffic limit Lists products matching user specified criteria Gets details for a specific product Lists product brands matching user specified criteria Gets details for a specific product brand Lists product categories matching user specified criteria Gets details for a specific product category Lists program impressions matching user specified criteria Gets details for a specific program impression instance Lists program clicks matching user specified criteria Gets details for a specific program click instance Lists detailed click matching user specified criteria Gets details for a specific detailed click Lists program leads matching user specified criteria Gets details for a specific program lead instance Lists detailed leads matching user specified criteria Gets details for a specific detailed lead Lists detailed sales matching user specified criteria Gets details for a specific detailed sale Gets statistics for a specified campaign Gets statistics for a specified affiliate Lists dates for which statistics are available for a specified campaign or affiliate Gets cumulative statistics for all campaigns or affiliate for a specified time period Gets statistics for a specified campaign Gets statistics for a specified affiliate Gets statistics for super affiliates Gets statistics for creatives Gets statistics for creative deployments
48
Search/List/GET API Name getProductStatistics getOptInfoStatistics getClickReferralStatistics getClickReferralDetail getSubIDStatistics listStatistics getQuickReport listXpubOffer getXpubOffer listXpubCompany getXpubCompany listXpubRequest getXpubRequest listXpubClassified getXpubClassifiedDetail listXpubCommunication getXpubCommunication listAdvertiser getAdvertiserDetail listAdvertiserContact getAdvertiserContactDetail listAdvertiserGroup getAdvertiserGroupDetail listConsumerLead getConsumerLeadDetail Description Gets statistics for products Gets statistics for optional information Gets statistics for click referrals Gets details for specific click referral records Gets statistics for sub IDs Lists dates for which statistics are available for a specified campaign or affiliate Gets cumulative statistics for all campaigns or affiliate for a specified time period Lists CrossPublications matching user specified criteria Gets details for a specific CrossPublication Lists companies offering CrossPublications matching user specified criteria Gets details for a specific CrossPublication company Lists CrossPublication requests matching user specified criteria Gets details for a specific CrossPublication request Lists CrossPub Classified bid or proposal listings Gets details for a specific CrossPub Classified bid or proposal Lists CrossPub Communication messages Gets details for a specific CrossPub Communication message Lists advertisers matching user specified criteria Gets details for a specific advertiser Lists advertiser contacts matching user specified criteria Gets details for a specific advertiser contact Lists advertiser groups matching user specified criteria Gets details for a specific advertiser group Lists consumer leads matching user specified criteria Gets details for a specific consumer lead
49
API Fleet Tips and Tricks

Below is a summary list of the most important points to keep in mind while making use of the DirectTrack API Fleet.
Tips
1. The API Fleet uses SSL be sure to direct your requests to https instead of http. 2. REST resource URLs are case-sensitive make sure they match with what is provided in this documentation. 3. Use metadata from list resources whenever possible it will save an extra API call! 4. The authorization header is required on ALL requests, regardless of operation or resource URL. The authorization headers should consist of 'Authorization: Basic' followed by a space and their base64 encoded username and password (separated by a colon before encoding). 5. The resource URL used to get details for a resource should never contain a trailing slash. For lists, the trailing slash is always required. Making either of these errors will most likely result in a failure, or at least different data coming back than the user expected. 6. Always verify that the URL for the resource and operation you are acting against matches the resource URL shown in the API documentation. 7. When making any Edit/PUT call, you must pass all of the parameters that are required on a Create/POST or XSD validation will fail. If you don't know the values that were originally entered for the parameters, you may pass a blank value like <parameter></parameter> which will be ignored by the API and satisfy XSD validation. 8. If you need to clone a campaign, make a call to getCampaignDetail on the campaign you wish to clone. Then, use the response XML to make a call to the createCampaign API. 9. Resource documents are often cached to improve performance. To force the API to bypass cached documents, include the Cache-Control: no-cache HTTP header on the GET operations. NOTE: This should only be used sparingly as it increases API point usage and threshold calculations.
50
API Reference User Management

API Users
Add API User
API Name: createAPIUser Description: Adds a new API Fleet user. REST URL: https://[client_domain]/apifleet/rest/[client_id]/apiUser/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field userType Data Type string Limit/Size Values client affiliate advertiser
Optional Parameters: Field resourceURL Data Type Limit/Size Values resourceURI REQUIRED if userType is affiliate or advertiser alphanumeric value (relative URL) pointing to an advertiser or affiliate resource string 255 alphanumeric value string 32 alphanumeric value Default
userName password
51
Responses Success
API user created. https://[client_domain]/apifleet/rest/[client_id]/apiUser/[api_user_id]
Failure
A userType is required when adding an API user.
52
List API Users
API Name: listAPIUser Description: This API is actually used to validate an API user against the stored user credentials. The existence of a response will indicate that the user was validated against API Fleet credentials. REST URL: https://[client_domain]/apifleet/rest/[client_id]/apiUser/[username]/[password]/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field username password Data Type string string Limit/Size Values alphanumeric value, passed via the URL alphanumeric value, passed via the URL
Optional Parameters: Field Data Type Limit/Size Values Default
53
Responses XML Example
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/apiUser/[username]/[password]/"> <resourceURL location="../../apiUser/1"/> </resourceList>
Failure
The API user at https://[client_domain]/apifleet/rest/[client_id]/apiUser/[username]/[password]/ does not exist.
54
View API Users
API Name: getAPIUser Description: Returns information about a specified API user.
Note: The username and password that are returned via this API call are
the DirectTrack username and password, NOT the API Fleet username and password.
REST URL: https://[client_domain]/apifleet/rest/[client_id]/apiUser/[access_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field access_id Data Type string Limit/Size Values Numeric value, passed via the URL. This value should be the access ID of the user record that should be returned, not the user making the call.
55
<apiUser xmlns="http://www.digitalriver.com/directtrack/api/apiUser/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/apiUser/[v ersion_id] apiUser.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/apiUser/[access_id]/"> <username>myUserName</userName> <password>[hashed password]</password> <userType>affiliate</userType> <resourceURL location="../../affiliate/123"/> </apiUser>
Failure
The API User address https://[client_domain]/apifleet/rest/[client_id]/apiUser/[access_id] is not valid.
56
Client User Accounts
Add Client User
API Name: createClientUser Description: Adds a new DirectTrack client user.
Note: Only master client accounts will have access to this operation and a
master account must exist in DirectTrack before this API resource will become accessible. A client user cannot be changed to a master user via this API.
REST URL: https://[client_domain]/apifleet/rest/[client_id]/client/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field userName password Data Type string string Limit/Size 255 50 Values alphanumeric value alphanumeric value
Optional Parameters: Field email Data Type string Limit/Size Values 255 alphanumeric value Default
57
Responses Success
Client user created. https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id]
Failure
A userName is required when adding a client user.
58
Edit a Client User
API Name: editClientUser Description: Updates an existing DirectTrack client user.
Note: Only master client accounts will have access to this operation and a
master account must exist in DirectTrack before this API resource will become accessible. A client user cannot be changed to a master user via this API.
REST URL: https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field Data Type Limit/Size Values
Optional Parameters: Field email password Data Type string string Limit/Size Values 255 alphanumeric value 50 alphanumeric value Default
59
Responses Success
Client user updated - [client_user_id]
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id]
60
Remove a Client User
API Name: removeClientUser Description: Deletes an existing DirectTrack client user.
Note: Only master client accounts will have access to this operation.
REST URL: https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type [client_user_id] integer Limit/Size Values valid client user id, passed via the URL
Responses Success
Client user deleted - [client_user_id]
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id]
61
List Client Users
API Name: listClientUser Description: Returns a list of REST resource URLs pointing to client users. The list returned can include all client users or be filtered to include only admin users by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Client User List Resources List Name All Client Users Admin Client Users REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/client/ /rest/[client_id]/[access_id]/client/admin/
HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Metadata: Field metaData1 metaData2 metaData3 Values Client User ID Username Email
Required Parameters: Field Data Type Limit/Size Values
62
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.com/apifleet/rest/[client_id] /client/"> <resourceURL location="../../client/1" metadata1=1 metadata2=myUserName metadata3=client1@domain.com /> </resourceList>
Failure
The client user list at https://[client_domain]/apifleet/rest/[client_id]/client/admin/ does not exist.
63
View Client Users
API Name: getClientUser Description: Returns information about a specified client user. REST URL: https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field client_user_id Data Type integer Limit/Size Values Numeric value, passed via the URL.
64
<client xmlns="http://www.digitalriver.com/directtrack/api/client/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/client/[ve rsion_id] apiUser.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/client/[client_user_id]/"> <username>myUserName</userName> <email></email> <password>[hashed password]</password> <isAdmin>1</isAdmin> <accessID>1</accessID> </client>
Failure
The client user address https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id] is not valid.
65
Authenticating to DirectTrack via API

You may wish to create your own DirectTrack interfaces using the API. In order to do this, you will need to create your own login form for internal (client), affiliate and advertiser users of that interface that can authenticate against DirectTrack login credentials. To faciliatate this: 1. An additional authorization path exists such that you may pass in a username preceded by the user type requesting authentication (CLI_/AFF_/ADV_) and a plain-text password via the existing authorization header. For example: $headers[] = "Authorization: Basic ".base64_encode(.AFF_myUserName:myPassword.); 2. The API Fleet will recognize this format as a DirectTrack login rather than an API Fleet login and will validate against DirectTrack credentials. Once the user is validated against DirectTrack, the API Fleet will try to retrieve the users API Fleet access_id. This will be needed in order to display data from DirectTrack that is pertinent to the user that is logged into your custom interface. That is, all subsequent calls would be made using the currently logged-in users access ID, instead of your access ID. o If there is no existing API Fleet account for the user and the user DOES NOT have an access_id, that user will need to create an API account. You may choose to create this account for the authenticating user (aff/adv) transparently and automatically OR You may choose to redirect the authenticating user (aff/adv) to a form where they may create their own API credentials. Both options will make use of the createAPIUser call. o If the user DOES have an existing API Fleet account and an access_id, it will be returned for you to use in the REST URLs of subsequent API Fleet calls.
3.
66
API Reference Affiliate Management

Affiliates
Add Affiliate
API Name: createAffiliate Description: Adds a new Affiliate. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliate/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field email password Data Type string string Limit/Size 255 15 Values email-formatted alphanumeric value alphanumeric value
Optional Parameters: Field addCode Data Type string Limit/Size Values 20 alphanumeric value, only applicable to clients using the Custom Add Code module. approved inactive denied pending terminated Sales/Leads Only Sales/Leads and Clicks 20 alphanumeric value 30 alphanumeric value 100 alphanumeric value Default
status
string
approval firstName lastName company
string string string string
67
Field address address2 city state zip country outsideNA stateOther phone fax ssn affiliateWebsites
Data Type string string string string string string booleanInt string string string string Field id url approved
Limit/Size 80 80 50 2 20 50
30 25 25 30
Values alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value 1 0 alphanumeric value alphanumeric value alphanumeric value alphanumeric value Values alphanumeric value 1 0
Default
Data Type unsignedInt string booleanInt
filterWebsite category1 category2 category3 blanketCommissions
booleanInt string 155 string 155 string 155 Field id effectiveDate
percent internalComments approvalNotes watchMe referredBy agreedTerms w9OnFile signUpDate string string booleanInt anyURI booleanInt booleanInt string 19 2000 2000
1 0 0 alphanumeric value alphanumeric value alphanumeric value Data Type Values unsignedInt string date value formatted as YYYYMM-DD string numeric value formatted ###.## alphanumeric value alphanumeric value 1 0 0 alphanumeric value (relative URL) 1 0 0 1 0 0 date value formatted as YYYYMM-DD
68
Field ipAddress siteType siteDescription siteViews affiliateGroups languageContent globalPop hideAdserving allowThirdPartyUpload sendApprovalEmail redirectURL datafeedApproval paypalEmail paymentThreshold paymentFrequency
Data Type string string string unsignedInt anyURI string booleanInt booleanInt booleanInt booleanInt string booleanInt string short string
Limit/Size 20 32 255
255
255
255
paymentTo paymentMethod
string string
paymentStatus
string
form1099Required taxIDIsSSN
booleanInt booleanInt
Values IP Address formatted value alphanumeric value alphanumeric value numeric value alphanumeric value (relative URL) alphanumeric value 1 0 1 0 1 0 1 0 alphanumeric value (URL) 1 0 email-formatted alphanumeric value numeric value monthly weekly biweekly quarterly personal company check paypal directDeposit Paid Under Review No W9 Pending First Payment Pending Payment Approved for First Payment Terminated Company Account Not Paid Export to Quickbooks 1 0 1 0
Default
0 0 0 0
0 0
69
Field currency terminateAffiliateReason resetPassword manualEmail updatesNotification paymentNotification conversionNotification customFields
Data Type string string booleanInt
Limit/Size Values 3 alphanumeric value 2000 alphanumeric value 1 0 booleanInt 1 0 booleanInt 1 0 unsignedInt numeric value booleanInt 1 0 customField Attributes Attribute Data Type id unsignedInt name string Values
Default
0 0 0
customFields accepts any number of customField elements with the attributes above. The value to be entered into the customField can be passed between the start and end tags for the element.
Responses Success
Affiliate created. https://[client_domain]/apifleet/rest/[client_id]/affiliate/[affiliate_id]
Failure
An email is required when adding an affiliate.
70
Edit Affiliate
API Name: editAffiliate Description: Updates the specified affiliate record REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliate/[affiliate_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field affiliate_id Data Type string Limit/Size Values alphanumeric value
Optional Parameters: Field email password addCode Data Type string string string Limit/Size Values 255 email-formatted alphanumeric value 15 alphanumeric value 20 alphanumeric value, only applicable to clients using the Custom Add Code module. approved inactive denied pending terminated Sales/Leads Only Sales/Leads and Clicks 20 alphanumeric value 30 alphanumeric value 100 alphanumeric value 80 alphanumeric value 80 alphanumeric value 50 alphanumeric value 2 alphanumeric value 20 alphanumeric value 50 alphanumeric value Default
status
string
approval firstName lastName company address address2 city state zip country
string string string string string string string string string string
71
Field outsideNA stateOther phone fax ssn affiliateWebsites
Data Type booleanInt string string string string Field id url approved
Limit/Size Values 1 0 30 alphanumeric value 25 alphanumeric value 25 alphanumeric value 30 alphanumeric value Data Type unsignedInt string booleanInt Values alphanumeric value 1 0
Default 1
filterWebsite category1 category2 category3 blanketCommissions
booleanInt string string string 155 155 155
1 0 alphanumeric value alphanumeric value alphanumeric value Data Type unsignedInt string Values
Field id effectiveDate
percent internalComments approvalNotes watchMe referredBy agreedTerms w9OnFile signUpDate ipAddress siteType siteDescription siteViews string string booleanInt anyURI booleanInt booleanInt string 19 2000 2000
string
date value formatted as YYYYMM-DD numeric value formatted ###.##
string 20 string 32 string 255 unsignedInt
alphanumeric value alphanumeric value 1 0 alphanumeric value (relative URL) 1 0 1 0 date value formatted as YYYYMM-DD IP Address formatted value alphanumeric value alphanumeric value numeric value
0 0
72
Field affiliateGroups languageContent globalPop hideAdserving allowThirdPartyUpload sendApprovalEmail redirectURL datafeedApproval paypalEmail paymentThreshold paymentFrequency
Data Type anyURI string booleanInt booleanInt booleanInt booleanInt string booleanInt string short string
paymentTo paymentMethod
string string
paymentStatus
string
form1099Required taxIDIsSSN
booleanInt booleanInt
currency string terminateAffiliateReason string resetPassword booleanInt
Limit/Size Values alphanumeric value (relative URL) 255 1 0 1 0 1 0 1 0 255 alphanumeric value (URL) 1 0 255 email-formatted alphanumeric value numeric value monthly weekly biweekly quarterly personal company check paypal directDeposit Paid Under Review No W9 Pending First Payment Pending Payment Approved for First Payment Terminated Company Account Not Paid Export to Quickbooks 1 0 1 0 3 alphanumeric value 2000 alphanumeric value 1 0
Default
0 0 0 0
0 0
73
Field manualEmail updatesNotification paymentNotification conversionNotification customFields
Data Type booleanInt
Limit/Size Values 1 0 booleanInt 1 0 unsignedInt numeric value booleanInt 1 0 customField Attributes Attribute Data Type id unsignedInt name string Values
Default 0 0
customFields accepts any number of customField elements with the attributes above. The value to be entered into the customField can be passed between the start and end tags for the element.
Responses Success
Affiliate updated [affiliate_id].
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/affiliate/[affiliate_id]
74
List Affiliates
API Name: listAffiliate Description: Returns a list of REST resource URLs pointing to affiliates. The list returned can include all affiliates or be filtered by a single affiliate in order to view sub-affiliates by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Affiliate List Resources List Name All Affiliates Affiliates by Add Code Affiliates by Date Approved Affiliates Inactive Affiliates Pending Affiliates Denied Affiliates Terminated Affiliates Approved Affiliates by Date Inactive Affiliates by Date Pending Affiliates by Date Denied Affiliates by Date Terminated Affiliates by Date Affiliates by Campaign Affiliates Pending Campaign Approval Affiliates by Affiliate Group REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/affiliate/ /rest/[client_id]/[access_id]/affiliate/addCode/[affiliate_add_code]/ /rest/[client_id]/[access_id]/affiliate/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/affiliate/approved/ /rest/[client_id]/[access_id]/affiliate/inactive/ /rest/[client_id]/[access_id]/affiliate/pending/ /rest/[client_id]/[access_id]/affiliate/denied/ /rest/[client_id]/[access_id]/affiliate/terminated/ /rest/[client_id]/[access_id]/affiliate/approved/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/affiliate/inactive/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/affiliate/pending/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/affiliate/denied/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/affiliate/terminated/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/affiliate/campaign/[campaign_id] /rest/[client_id]/[access_id]/affiliate/pending/campaign/[campaign_id]/ /rest/[client_id]/[access_id]/affiliate/affiliateGroup/[affiliate_group_id]/
HTTP Method: GET Cache Lifetimes: API Call Affiliates by Date For a Date Within the Current Month Previous Month Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Month
75
API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Optional Parameters: Field Metadata: Field metaData1 metaData2 metaData3 Values Affiliate ID Name (First Last) Email Data Type Limit/Size Values Default
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/[access_id]/affiliate/2009-07/"> <resourceURL location="../../../affiliate/61" metaData1="bob" metaData2="bob Kanade" metaData3="achitambar@digitalriver.com"/> <resourceURL location="../../../affiliate/62" metaData1="dobby" metaData2="Hermoine Granger" metaData3="tshields@digitalriver.com"/> <resourceURL location="../../../affiliate/63" metaData1="onenetworkdev" metaData2="Alex Danzberger" metaData3="dtdev_ond@directresponse.com"/> <resourceURL location="../../../affiliate/64" metaData1="" metaData2="" metaData3=""/> <resourceURL location="../../../affiliate/65" metaData1="" metaData2="" metaData3=""/> </resourceList>
76
Failure
The affiliate list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliate/ does not exist.
77
View Affiliate
API Name: getAffiliateDetails Description: Returns all information about a specified affiliate. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliate/[affiliate_id] HTTP Method: GET Cache Lifetime: 1 Day API Rate: 10 points per call Required Parameters: Field affiliate_id Data Type string Limit/Size Values alphanumeric value
<affiliate xmlns="http://www.digitalriver.com/directtrack/api/affiliate/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/affiliate/ [version_id] affiliate.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/affiliate/[aff iliate_id]"> <addCode>bob</addCode> <email>achitambar@digitalriver.com</email> <status>approved</status> <approval>Sales/Leads and Clicks</approval> <password></password> <firstName><![CDATA[bob]]></firstName> <lastName><![CDATA[Kanade]]></lastName> <company><![CDATA[DRT - Test Account Bob]]></company> <address><![CDATA[Do]]></address>
78
<address2><![CDATA[Not]]></address2> <city><![CDATA[Delete!]]></city> <state><![CDATA[PA]]></state> <zip><![CDATA[ease]]></zip> <country><![CDATA[United States]]></country> <outsideNA>0</outsideNA> <stateOther></stateOther> <phone><![CDATA[412-390-0990]]></phone> <fax/> <ssn/> <affiliateWebsites> <website id="732" url="http://www.google.com" approved="1"/> </affiliateWebsites> <filterWebsite>0</filterWebsite> <category1/> <category2/> <category3/> <blanketCommissions/> <internalComments/> <approvalNotes/> <watchMe>0</watchMe> <referredBy location=""/> <agreedTerms>1</agreedTerms> <w9OnFile>0</w9OnFile> <signUpDate>2009-07-06 15:45:31</signUpDate> <ipAddress></ipAddress> <siteType/> <siteDescription/> <siteViews>0</siteViews> <affiliateGroups/> <languageContent><![CDATA[Default]]></languageContent> <globalPop>0</globalPop> <hideAdserving>1</hideAdserving> <allowThirdPartyUpload>1</allowThirdPartyUpload> <redirectURL/> <datafeedApproval>0</datafeedApproval> <paypalEmail/> <paymentThreshold>2</paymentThreshold> <paymentFrequency>monthly</paymentFrequency> <paymentTo>company</paymentTo> <paymentMethod>check</paymentMethod> <paymentStatus>Pending First Payment</paymentStatus> <form1099Required>1</form1099Required> <taxIDIsSSN>1</taxIDIsSSN> <currency/> <directDepositDetails> <bankName/> <accountName/> <bankAccountNumber/> <IBAN/> <routingNumber/> <bankAddress/> <bankAddress2/> <bankCity/>
79
<bankState/> <bankZip/> <bankCountry/> </directDepositDetails> <wireTransferDetails> <bankName/> <accountName/> <bankAccountNumber/> <IBAN/> <routingNumber/> <bankAddress/> <bankAddress2/> <bankCity/> <bankState/> <bankZip/> <bankCountry/> <intBankCode/> <intBankAddress/> <intBankAddress2/> <intBankAddress3/> <instructions/> <wireCurrency/> </wireTransferDetails> <terminateAffiliateReason/> <manualEmail>1</manualEmail> <updatesNotification>1</updatesNotification> <paymentNotification>1</paymentNotification> <conversionNotification>0</conversionNotification> <customFields> <customField id="34" name="Alt Phone"/> <customField id="36" name="File Number"/> <customField id="35" name="Payment Type"/> <customField id="39" name="Monthly Circulation"/> <customField id="38" name="Publication Name"/> <customField id="37" name="Publication Type"/> <customField id="40" name="Monthly budget"/> </customFields> <accessID>12</accessID> </affiliate>
Failure
The affiliate address https://[client_domain]/apifleet/rest/[client_id]/affiliate/[affiliate_id] is not valid.
80
Affiliate Groups
Add Affiliate Group
API Name: createAffiliateGroup Description: Adds a new affiliate group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field groupName groupType Data Type string string Limit/Size 255 Values alphanumeric value client advertiser
Responses Success
Affiliate group created. https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id]
Failure
A group name is required when adding an affiliate group.
81
Edit Affiliate Group
API Name: editAffiliateGroup Description: Updates the specified affiliate group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field Data Type affiliate_group_id string Limit/Size Values alphanumeric value
Optional Parameters: Field groupName groupType Data Type string string Limit/Size Values 255 alphanumeric value alphanumeric value Default
Responses Success
Affiliate group updated [affiliate_group_id].
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id]
82
Remove Affiliate Group
API Name: removeAffiliateGroup Description: Deletes an affiliate group using the affiliate group ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type affiliate_group_id string Limit/Size Values valid affiliate group ID
Responses Success
The affiliate group has been deleted [affiliate_group_id].
Failure
The affiliate group address https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id] is not valid.
83
List Affiliate Group
API Name: listAffiliateGroup Description: Returns a list of REST resource URLs pointing to affiliate groups. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateGroup/ HTTP Method: GET Cache Lifetime: 8 Hours API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Group Name Group ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]]/a
84
ffiliateGroup/"> <resourceURL location="../../affiliateGroup/(A or C)+[affiliate_group_id]" metaData1="Platinum" metaData2="c1"/> <resourceURL location="../../affiliateGroup/(A or C)+[affiliate_group_id]" metaData1="Gold" metaData2="c2"/> <resourceURL location="../../affiliateGroup/(A or C)+[affiliate_group_id]" metaData1="Silver" metaData2="c3"/> </resourceList>
Failure
The affiliate group list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateGroup/ does not exist.
85
View Affiliate Group
API Name: getAffiliateGroupDetail Description: Retrieves detailed information for a specified affiliate group ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id] HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field Data Type affiliate_group_id string Optional Parameters: Field Data Type Limit/Size Values Default Limit/Size Values valid affiliate group ID
86
<affiliateGroup xmlns="http://www.digitalriver.com/directtrack/api/affiliateGroup/[version _id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.digitalriver.com/directtrack/api/affiliate Group/[version_id] affiliateGroup.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/ [affiliate_group_id]"> <groupType>Gold</groupType> <groupName>Platinum</groupName> </affiliateGroup>
Failure
The affiliate group address https://[client_domain]/apifleet/rest/[client_id]/affiliateGroup/[affiliate_group_id] is not valid.
87
Affiliate Blacklists
Add Affiliate to Blacklist

API Name: createAffiliateOnBlacklist Description: Adds an affiliate to a blacklist REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateBlacklist/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field Data Type blacklistResourceURL anyURI resourceURL anyURI Limit/Size Values alphanumeric value (relative URL) alphanumeric value (relative URL to the affiliate resource)
Optional Parameters: Field redirectURL Responses Success Affiliate added to blacklist. https://[client_domain]/apifleet/rest/client/[access_id]/affiliateBlacklist/affiliate/[affiliate_id] Data Type anyURI Limit/Size Values alphanumeric value (URL) Default
Failure The affiliate blacklist at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateBlacklist/campaign/[campaign_id]/ does not exist.
88
Edit Affiliate Blacklist

API Name: editAffiliateBlacklist Description: Updates an affiliate blacklist REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateBlacklist/[blacklist_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field blacklist_id Data Type string Limit/Size Values see API Placeholders for blacklist ID values
Optional Parameters: Field Data Type blacklistResourceURL anyURI resourceURL anyURI redirectURL Responses Success Affiliate blacklist updated [blacklist_id]. anyURI Limit/Size Values alphanumeric value (relative URL) alphanumeric value (relative URL to the affiliate resource) alphanumeric value (URL) Default
Failure The affiliate blacklist at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateBlacklist/campaign/[campaign_ id]/ does not exist.
89
Remove Affiliate from Blacklist
API Name: removeAffiliateOnBlacklist Description: Deletes an affiliate from a specified blacklist. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateBlacklist/[blacklist_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field blacklist_id Data Type Limit/Size Values see API Placeholders for blacklist ID values
Responses Success
The affiliate has been deleted from the blacklist- [blacklist_id].
Failure
The affiliate blacklist at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateBlacklist/campaign/[campaign_i d]/ does not exist.
90
List Affiliate Blacklist
API Name: listAffiliateBlacklist Description: Returns a list of REST resource URLs pointing to blacklists. The list returned can be requested for campaigns, campaign groups, creatives or affiliates by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Affiliate List Resources List Name Affiliate Blacklist by Campaign ID Affiliate Blacklist by Campaign Group ID Affiliate Blacklist by Creative ID Affiliate Blacklist by Affiliate ID REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/affiliateBlacklist/campaign/[campaign_id]/ /rest/[client_id]/[access_id]/affiliateBlacklist/campaignGroup/[campaign_ group_id]/ /rest/[client_id]/[access_id]/affiliateBlacklist/creative/[creative_id]/ /rest/[client_id]/[access_id]/affiliateBlacklist/affiliate/[affiliate_id]/
HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
91
Metadata Filter Applied Campaign Field metaData1 metaData2 metaData3 metaData1 metaData2 metaData3 metaData1 metaData2 metaData3 metaData1 metaData2 metaData3 Values Campaign ID Campaign Name Campaign Type Campaign Group ID Campaign Group Name Creative ID Creative Type Creative Size Affiliate ID Name (First Last) Email
Campaign Group
Creative
Affiliate
Responses Success
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/[access_id]/aff iliateBlacklist/campaign/"> <resourceURL location="../../affiliateBlacklist/campaign/1/" metaData1="1" metaData2="My Campaign" metaData3="CPC"/> <resourceURL location="../../affiliateBlacklist/campaign/3/" metaData1="3" metaData2="Click Campaign" metaData3="CPC"/> <resourceURL location="../../affiliateBlacklist/campaign/4/" metaData1="4" metaData2="Sale Campaign" metaData3="CPS"/> </resourceList>
Failure
The affiliate blacklist at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateBlacklist/campaign/[campaign_i d]/ does not exist.
92
View Affiliate Blacklist
API Name: getAffiliateBlacklistDetail Description: Retrieves detailed information for a specified blacklist. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateBlacklist/[blacklist_id] HTTP Method: GET Cache Lifetime: 1 Hour API Rate: 10 points per call Required Parameters: Field blacklist_id Data Type Limit/Size Values see API Placeholders for blacklist ID values
<affiliateBlacklist xmlns="http://www.digitalriver.com/directtrack/api/affiliateBlacklist/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/affiliateBlacklist/ [version_id] affiliateBlacklist.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/affiliateBlacklist/[bla cklist_id]"> <redirectURL>http://www.example.com</redirectURL> <blacklistResourceURL location="../affiliateBlacklist/campaign/[campaign_id]/"/> <resourceURL location="../affiliateBlacklist/[blacklist_id]"/> </creativeDeployment>
93
Failure
The affiliate blacklist at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateBlacklist/[blacklist_id]/ does not exist.
94
Affiliate Edit Requests

When affiliates change their information, an affiliate edit request is generated that requires approval by the DirectTrack client before the changes can be confirmed. This resource manages those automated requests.
Edit Affiliate Edit Requests
API Name: editAffiliateEditRequest Description: Updates the specified affiliate edit request. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEditRequest/[affiliate_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field affiliate_id approval Data Type string string Limit/Size Values alphanumeric value, passed via the URL Approved Denied
Responses Success
Affiliate edit request updated [affiliate_id].
95
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/affiliateEditRequest/[affiliate_id]
96
List Affiliate Edit Requests
API Name: listAffiliateEditRequest Description: Returns a list of REST resource URLs pointing to pending affiliate edit request records. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateEditRequest/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
97
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/[access_id]/affiliateEditRequest/"> <resourceURL location="../../../affiliateEditRequest/61" /> <resourceURL location="../../../affiliateEditRequest/62" /> <resourceURL location="../../../affiliateEditRequest/63" /> <resourceURL location="../../../affiliateEditRequest/64" /> <resourceURL location="../../../affiliateEditRequest/65" /> </resourceList>
Failure
The affiliate edit request list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateEditRequest/ does not exist.
98
View Affiliate Edit Requests
API Name: getAffiliateEditRequestDetail Description: Returns all information about a specified affiliate edit request. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEditRequest/[affiliate_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field affiliate_id Data Type string Limit/Size Values alphanumeric value, passed via the URL
99

<affiliateEditRequest xmlns="http://www.digitalriver.com/directtrack/api/affiliateEditRequest/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/affiliateEditRequest/[version _id] affiliateEditRequest.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/affiliateEditRequest/[affiliate_i d]"> <approval>Pending</approval> <information> <field name="password"/> <field name="firstName"><![CDATA[John]]></field> <field name="lastName"><![CDATA[Smith]]></field> <field name="address"><![CDATA[123 Elm Street]]></field> <field name="address2"><![CDATA[address2]]></field> <field name="city"><![CDATA[Pittsburgh]]></field> <field name="zip"><![CDATA[15220]]></field> <field name="country"><![CDATA[US]]></field> <field name="email"><![CDATA[myemail@example.com]]></field> <field name="phone"><![CDATA[09102910290]]></field> <field name="fax"><![CDATA[10292398348]]></field> <field name="paymentThreshold"><![CDATA[1]]></field> <field name="company"><![CDATA[DirectTrack]]></field> <field name="ssn"><![CDATA[3r2323c2d]]></field> <field name="url"><![CDATA[http://www.google.com]]></field> <field name="state"><![CDATA[3]]></field> <field name="category1"><![CDATA[3]]></field> <field name="category2"><![CDATA[2]]></field> <field name="category3"><![CDATA[0]]></field> <field name="url2"/> <field name="url3"/> <field name="redirectURL"/> <field name="outsideNA"><![CDATA[1]]></field> <field name="paymentTo"><![CDATA[1]]></field> <field name="siteType"><![CDATA[2]]></field> <field name="stateOther"/> <field name="paymentMethod"><![CDATA[A]]></field> <field name="paypalEmail"/> <field name="currency"><![CDATA[USD]]></field> </information> <wireDetails/> <bankingDetails/> <websites> <website website="http://www.google.com" id="2663" action="edit"/> </websites> </affiliateEditRequest>
Failure
The affiliate edit request address https://[client_domain]/apifleet/rest/[client_id]/affiliateEditRequest/[affiliate_id] is not valid.
100
Affiliate Campaign Access Requests

Campaigns that are set up as click (CPC) or select require affiliates to be approved before they may run the campaign. This resource will handle the creation and management of these requests.
Create Campaign Access Requests
API Name: createCampaignAccessRequest Description: Creates a request for an affiliate to run a click or select campaign. This create API call is intended for affiliate use only. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignAccessRequest/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field affiliateResourceURL Data Type resourceURI Limit/Size Values relative URL pointing to the affiliate requesting approval relative URL pointing to the campaign which the affiliate wishes to run
campaignResourceURL resourceURI
101
Responses Success
Campaign access requested created https://[client_domain]/apifleet/rest/[client_id]/campaignAccessRequest/[campaign_access_reques t_id].
Failure
An affiliateResourceURL is required when creating a campaign access request.
102
Edit Campaign Access Requests
API Name: editCampaignAccessRequest Description: Updates the specified campaign access request. REST URL:
https://[client_domain]/apifleet/rest/[client_id]/campaignAccessRequest/[campaign_access_request_id]
HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field requestStatus Data Type string Limit/Size Values denied approved
Optional Parameters: Field commentToAffiliate Data Type string Limit/Size Values 255 alphanumeric value Default
Responses Success
Campaign access request updated [campaign_access_request_id].
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/campaignAccessRequest/[campaign_access_reques t_id]
103
List Campaign Access Requests
API Name: listCampaignAccessRequest Description: Returns a list of REST resource URLs pointing to campaign access request records. The list returned can include all pending click or select campaign requests or filter select campaign requests by campaign status or campaign ID by requesting the appropriate REST resource URL as shown in the chart below. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/campaignAccessRequest/ Campaign Access Request List Resources List Name Pending Click Campaign Access Requests Pending Select Campaign Access Requests Pending Select Campaign Access Requests by Campaign Status Pending Select Campaign Access Requests by Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/campaignAccessRequest/click/ /rest/[client_id]/[access_id]/campaignAccessRequest/select/ /rest/[client_id]/[access_id]/campaignAccessRequest/select/campaign/[ active|inactive|pending|deleted]/ /rest/[client_id]/[access_id]/campaignAccessRequest/select/campaign/[ campaign_id]/
104
Metadata: Field metaData1 metaData2 metaData3 Values Affiliate ID Date Requested
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/[access_id]/affiliateEditRequest/"> <resourceURL location="../../../campaignAccessRequest/1" metadata1=9 metadata2=2010-01-01 metadata3= /> <resourceURL location="../../../campaignAccessRequest/2" metadata1=8 metadata2=2010-01-12 metadata3= /> <resourceURL location="../../../campaignAccessRequest/3" metadata1=7 metadata2=2010-01-13 metadata3= /> </resourceList>
Failure
The campaign access request list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/campaignAccessRequest/click/ does not exist.
105
Affiliate Histories
DirectTrack automatically keeps a record of all changes that have been made to an affiliate record. This API will allow access to that data as it is made available in the DirectTrack interface.
View Affiliate Histories
API Name: getAffiliateHistory Description: Returns information about all changes that have been made to an affiliate record. REST URL: Affiliate History List Resources List Name History for a Single Affiliate Histories by Affiliate Group History for a Single Campaign Histories for a Single Day REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/affiliateHistory/affiliate/[affiliate_id]/ /rest/[client_id]/[access_id]/affiliateHistory/affiliateGroup/[affiliate_group_id]/ /rest/[client_id]/[access_id]/affiliateHistory/campaign/[campaign_id]/ /rest/[client_id]/[access_id]/affiliateHistory/[YYYY]-[MM]-[DD]/
HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type Limit/Size Values
106
<affiliateHistory xmlns="http://www.digitalriver.com/directtrack/api/affiliateHistory/[versi on_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/affiliateH istory/[version_id] affiliateHistory.xsd" location="https://[client_domain/apifleet/rest/[client_id]/[access_id]/aff iliateHistory/[affiliate_id]/[yyyy]-[mm]/"> <resource timestamp="2009-02-10 11:03:14"> <affiliateResourceURL location="../../../../../affiliate/13" /> <campaignResourceURL location=../../campaign/555/> <username></username> <actionTaken>[System] Email sent Notifying Affiliate of signup approval for both the network and campaign</actionTaken> </resource> <resource timestamp="2009-08-04 15:03:43"> <affiliateResourceURL location="../../../../../affiliate/16" /> <campaignResourceURL location=../../campaign/555/> <username></username> <actionTaken>[System] Email sent Notifying Affiliate of signup approval for both the network and campaign</actionTaken> </resource> </affiliateHistory>
Failure
The affiliate history address https://[client_domain]/apifleet/rest/[client_id]/affiliateHistory/affiliate/[affiliate_id]/ is not valid.
107
Creative Deployments
Add Creative Deployment
API Name: createCreativeDeployment Description: Adds a new creative deployment. REST URL: https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field deployName Data Type string Limit/Size 255 Values The name of the creative deployment
Optional Parameters: Field password active affiliateResourceURL creativeResourceURL Data Type string booleanInt anyURI anyURI Limit/Size Values 255 1 0 alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value (URL) Default
campaignResourceURL anyURI landingPageURL anyURI
108
Responses Success
Creative deployment created. https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[creative_deployment_id]
Failure
A deployment name is required when adding a creative deployment.
109
Edit Creative Deployment
API Name: editCreativeDeployment Description: Edits an existing creative deployment. REST URL: https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[creative_deployment_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field Data Type creative_deployment_id string Limit/Size Values The ID of the creative deployment
Optional Parameters: Field deployName Data Type string Limit/Size Values 255 The name of the creative deployment 255 1 0 alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value (URL) Default
password active affiliateResourceURL creativeResourceURL
string booleanInt anyURI anyURI
campaignResourceURL anyURI landingPageURL anyURI
110
Responses Success
The creative deployment has been updated - [creative_deployment_id].
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[creative_deployment_id]
111
Remove Creative Deployment
API Name: removeCreativeDeployment Description: Deletes an existing creative deployment. REST URL: https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[creative_deployment_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type creative_deployment_id string Limit/Size Values The ID of the creative deployment
Responses Success
The creative deployment has been deleted - [creative_deployment_id].
Failure
The creative deployment address https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[creative_deployment_id] is not valid.
112
List Creative Deployment
API Name: listCreativeDeployment Description: Returns a list of REST resource URLs pointing to creative deployments. The list returned can include all creative deployments for a given year-month combination, or be filtered by campaign by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Creative Deployment List Resources List Name All Creative Deployments Creative Deployments by Date Creative Deployments by Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/creativeDeployment/ /rest/[client_id]/[access_id]/creativeDeployment/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/creativeDeployment/campaign/[campaign_id] /
HTTP Method: GET Cache Lifetimes: API Call All Creative Deployments Creative Deployments by Date Creative Deployments by Campaign For a Date Within the N/A Current Month Previous Month Month Prior to 60 Days N/A Lifetime 1 Day 1 Day 1 Week 1 Year 1 Day
113
Metadata: Field metaData1 metaData2 metaData3 Values Deployment Name Affiliate ID Campaign ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/cr eativeDeployment/[yyyy]-[mm]/"> <resourceURL location="../../../creativeDeployment/[creative_deployment_id]" metaData1="Deployment 1" metaData2="1" metaData3="32"/> <resourceURL location="../../../creativeDeployment/[creative_deployment_id]" metaData1="Deployment 2" metaData2="1" metaData3="6157"/> <resourceURL location="../../../creativeDeployment/[creative_deployment_id]" metaData1="Deployment 3" metaData2="1" metaData3="6157"/> </resourceList>
Failure
The creative deployment list at https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[yyyy]-[mm] does not exist.
114
View Creative Deployment
API Name: getCreativeDeploymentDetail Description: Retrieves detailed information about a specified creative deployment. REST URL: https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/{creative_deployment_id]/ HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field Data Type creative_deployment_id integer Limit/Size Values valid creative deployment Id
<creativeDeployment xmlns="http://www.digitalriver.com/directtrack/api/creativeDeployment/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/creativeDeployment/ [version_id] creativeDeployment.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[cre ative_deployment_id]"> <deployName><![CDATA[Hello Edited]]></deployName> <password></password> <active>1</active> <affiliateResourceURL location="../affiliate/[affiliate_id]"/> <creativeResourceURL location="../creative/[creative_id]"/> <campaignResourceURL location="../campaign/[campaign_id]"/> </creativeDeployment>
115
Failure
The creative deployment at https://[client_domain]/apifleet/rest/[client_id]/creativeDeployment/[creative_deployment_id] does not exist.
116
Third Party Pixels
Add Third Party Pixel
API Name: createThirdPartyPixel Description: Creates a new third party pixel for a given affiliate and campaign REST URL: https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field affiliateResourceURL pixel Data Type anyURI string Limit/Size 99999 Values alphanumeric value (relative URL)
Optional Parameters: Field Data Type campaignResourceURL anyURI Limit/Size Values alphanumeric value (relative URL) Default
Responses Success
Third party pixel created. https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/[third_party_pixel_id]
Failure
A campaign is required when adding a third party pixel.
117
Edit Third Party Pixel
API Name: editThirdPartyPixel Description: Updates an existing third party pixel for a given affiliate and campaign REST URL: https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/[third_party_pixel_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field third_party_pixel_id Data Type string Limit/Size Values
Optional Parameters: Field affiliateResourceURL pixel Data Type anyURI string Limit/Size Values alphanumeric value (relative URL) 99999 Default
Responses Success
Third party pixel updated [third_party_pixel_id]
Failure
The third party pixel address https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/[third_party_pixel_id] is not valid.
118
Remove Third Party Pixel
API Name: removeThirdPartyPixel Description: Deletes an existing third party pixel. REST URL: https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/[third_party_pixel_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type third_party_pixel_id integer Limit/Size Values valid third party pixel ID
Responses Success
Third party pixel deleted - [third_party_pixel_id].
Failure
119
List Third Party Pixel
API Name: listThirdPartyPixel Description: Returns a list of REST resource URLs pointing to third party pixels. The list returned can include all third party pixels or be filtered by campaign by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Third Party Pixel List Resources List Name All Third Party Pixels Third Party Pixels by Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/thirdPartyPixel/ /rest/[client_id]/[access_id]/thirdPartyPixel/campaign/[campaign_id ]
HTTP Method: GET Cache Lifetime: 1 Day API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Third Party Pixel ID Affiliate ID Campaign ID
120
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/th irdPartyPixel/"> <resourceURL location="../../thirdPartyPixel/75" metaData1="75" metaData2="0" metaData3="25"/> <resourceURL location="../../thirdPartyPixel/77" metaData1="77" metaData2="1" metaData3="164"/> <resourceURL location="../../thirdPartyPixel/94" metaData1="94" metaData2="100" metaData3="0"/> </resourceList>
Failure
The third party pixel list at https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/campaign/[campaign_id] does not exist.
121
View Third Party Pixel
API Name: getThirdPartyPixelDetail Description: Retrieves detailed information about a given third party pixel. REST URL: https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixel/[third_party_pixel_id] HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field Data Type third_party_pixel_id integer Limit/Size Values valid third party pixel ID
<thirdPartyPixel xmlns="http://www.digitalriver.com/directtrack/api/thirdPartyPixel/[versio n_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/thirdParty Pixel/[version_id]thirdPartyPixel.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixe l/[third_party_pixel_id]"> <affiliateResourceURL location="../affiliate/1"/> <campaignResourceURL location="../campaign/6490"/> <pixel><![CDATA[asdf]]></pixel> </thirdPartyPixel>
122
Failure
123
Tracking
View Tracking URL
API Name: getTrackingURLDetail Description: Retrieves the appropriate tracking URL for a given affiliate/creative ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/trackingURL/[tracking_url_id] HTTP Method: GET Cache Lifetime: 1 Minute API Rate: 10 points per call Required Parameters: Field tracking_url_id Data Type string Limit/Size Values a concatenation of the affiliate and creative IDs to be tracked
124
<trackingURL xmlns="http://www.digitalriver.com/directtrack/api/trackingURL/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/trackingUR L/[version_id] trackingURL.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/trackingURL/[t racking_url_id]"> <URL location="[tracking_URL]"/> </trackingURL>
Failure
The tracking URL address at https://[client_domain]/apifleet/rest/[client_id]/trackingURL/[tracking_url_id] does not exist.
125
Emailing Affiliates Creating Email Templates
Create an Affiliate Email Template
API Name: createAffiliateEmailTemplate Description: Creates a new email template to be used for sending emails to affiliates via DirectTrack. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field templateName Data Type string Limit/Size 128 Values alphanumeric value
Optional Parameters: Field subject plainTextMessage htmlMessage sendPreviewToEmail Data Type string string string string Limit/Size 128 65535 65535 100 Values alphanumeric value alphanumeric value html code to display email-formatted string Default
126
Responses Success
Affiliate email template created. https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_i d]
Failure
A template name is required when adding an affiliate email template.
127
Edit Affiliate Email Templates
API Name: editAffiliateEmailTemplate Description: Modifies an existing email template to be used for sending emails to affiliates via DirectTrack. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field templateName Data Type string Limit/Size 128 Values alphanumeric value
Optional Parameters: Field subject plainTextMessage htmlMessage sendPreviewToEmail Data Type string string string string Limit/Size 128 65535 65535 100 Values alphanumeric value alphanumeric value html code to display email-formatted string Default
128
Responses Success
Affiliate email template updated - [affiliate_email_template_id]
Failure
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_i d]
129
Remove Affiliate Email Templates
API Name: removeAffiliateEmailTemplate Description: Deletes an existing affiliate email template. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type affiliate_email_template_id integer Limit/Size Values valid template ID, passed via the URL
Responses Success
Affiliate email template deleted - [affiliate_email_template_id].
Failure
The affiliate email template address https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_i d] is not valid.
130
List Affiliate Email Templates
API Name: listAffiliateEmailTemplate Description: Returns a list of REST resource URLs pointing to affiliate email templates. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Template Name Subject
131
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/af filiateEmailTemplate/"> <resourceURL location="../../affiliateEmailTemplate/5" metaData1="WelcomeAffiliate" metaData2="Welcome to our Affiliate Program!" metaData3=""/> <resourceURL location="../../affiliateEmailTemplate/7" metaData1="CheckIn" metaData2="Checking in how are you doing?" metaData3=""/> </resourceList>
Failure
The affiliate email template list at https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/ does not exist.
132
View Affiliate Email Templates
API Name: getAffiliateEmailTemplateDetail Description: Retrieves detailed information about a given affiliate email template. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type affiliate_email_template_id integer Limit/Size Values valid affiliate email template ID, passed via the URL
133
<affiliateEmailTemplate xmlns="http://www.digitalriver.com/directtrack/api/affiliateEmailTemplate/ [version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/affiliateE mailTemplate/[version_id] affiliateEmailTemplate.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/affiliateEmail Template/[affiliate_email_template_id]"> <templateName>My affiliate e-mail template!</templateName> <subject>My Subject</subject> <plainTextMessage>Check out our new campaigns</plainTextMessage> <htmlMessage>Check out our new campaigns</htmlMessage> <sendPreviewToEmail><![CDATA[myEmail@example.com]]></sendPreviewToEm ail> </affiliateEmailTemplate>
Failure
The affiliate email template address https://[client_domain]/apifleet/rest/[client_id]/affiliateEmailTemplate/[affiliate_email_template_i d] is not valid.
134
Emailing Affiliates Manual Emails

One-time emails can be generated and sent to affiliates via the DirectTrack interface; this API resource replicates this functionality.
Add Manual Affiliate Emails
API Name: createAffiliateManualEmail Description: Creates a new one-time email to the selected affiliate(s). REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field sendTo Data Type Limit/Size Data Type resourceURI Values Limit/Size Values relative URL pointing to an affiliate resource
Field affiliateResourceURL
Optional Parameters: Field sendDate Data Type string Limit/Size Values date value formatted YYYYMM-DD alphanumeric value relative URL pointing to the template to use alphanumeric value alphanumeric value alphanumeric value Default the date of the API call
fromAddress string affiliateEmailTemplateResourceURL resourceURI subject plainTextMessage htmlMessage string string string
135
Responses Success
Affiliate manual email created. https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id]
Failure
Send to is required when creating an affiliate manual email.
136
Edit Manual Affiliate Emails
API Name: editAffiliateManualEmail Description: Updates a queued one-time email to the selected affiliate(s). REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field sendTo Data Type Limit/Size Data Type resourceURI Values Limit/Size Values relative URL pointing to an affiliate resource
Field affiliateResourceURL
Optional Parameters: Field sendDate Data Type string Limit/Size Values date value formatted YYYYMM-DD alphanumeric value relative URL pointing to the template to use alphanumeric value alphanumeric value alphanumeric value Default the date of the API call
fromAddress string affiliateEmailTemplateResourceURL resourceURI subject plainTextMessage htmlMessage string string string
137
Responses Success
Affiliate manual email updated - [affiliate_manual_email_id]
Failure
The affiliate manual email address https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id] is not valid.
138
Remove Manual Affiliate Emails
API Name: removeAffiliateManualEmail Description: Deletes a queued one-time affiliate email. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type affiliate_manual_email_id integer Limit/Size Values valid affiliate manual email ID, passed vai the URL
Responses Success
Affiliate manual email deleted - [affiliate_manual_email_id].
Failure
The affiliate manual email address https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id] does not exist.
139
List Manual Affiliate Emails
API Name: listAffiliateManualEmail Description: Returns a list of REST resource URLs pointing to currently queued one-time affiliate emails. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Send Date Subject
140
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/af filiateManualEmail/"> <resourceURL location="../../affiliateManualEmail/1" metaData1="201002-02" metaData2="Feeling like its just another Groundhog Day?" metaData3=""/> <resourceURL location="../../affiliateManualEmail/2" metaData1="201002-14" metaData2="Happy Valentines Day!" metaData3=""/> </resourceList>
Failure
The affiliate manual email list at https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/ does not exist.
141
View Manual Affiliate Emails
API Name: getAffiliateManualEmailDetail Description: Retrieves detailed information about a queued one-time affiliate email. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type affiliate_manual_email_id integer Limit/Size Values valid affiliate manual email ID, passed vai the URL
142
<affiliateManualEmail xmlns="http://www.digitalriver.com/directtrack/api/affiliateManualEmail/[v ersion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/affiliateM anualEmail/[version_id] affiliateManualEmail.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/affiliateManua lEmail/[affiliate_manual_email_id]"> <sendTo> <affiliateResourceURL location="../../affiliate/1" /> <affiliateResourceURL location="../../affiliate/2" /> <affiliateResourceURL location="../../affiliate/3" /> <affiliateResourceURL location="../../affiliate/4" /> <affiliateResourceURL location="../../affiliate/5" /> </sendTo> <sendDate>2010-01-01</sendDate> <fromAddress><![CDATA[someone@somecompany.com]]></fromAddress> <affiliateEmailTemplateResourceURL location="../../affiliateEmailTemplate/26" /> <subject><![CDATA[Some great subject!]]></subject> <plainTextMessage><![CDATA[My new affiliate email!]]></plainTextMessage> <htmlMessage><![CDATA[My new affiliate email!]]></htmlMessage> </affiliateManualEmail>
Failure
The affiliate manual email address https://[client_domain]/apifleet/rest/[client_id]/affiliateManualEmail/[affiliate_manual_email_id] is not valid.
143
Emailing Affiliates Auto-Emails
Add Affiliate Auto-Emails
API Name: createAffiliateAutoEmail Description: Creates a new automated reoccurring affiliate emailer. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateAutoEmail/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field sendCondition Data Type Limit/Size Data Type string integer integer integer Values Limit/Size Values less than at least
Field clicksThresholdType clicksThreshold daysSinceJoining reoccurDay
>0 >0 1-28
Optional Parameters: Field subject plainTextMessage htmlMessage Data Type string string string Limit/Size Values alphanumeric value alphanumeric value alphanumeric value Default
144
Responses Success
Affiliate auto email created. https://[client_domain]/apifleet/rest/[client_id]/affiliateAutoEmail/[affiliate_auto_email_id]
Failure
A send condition is required when adding an affiliate auto email.
145
Edit Affiliate Auto-Emails
API Name: editAffiliateAutoEmail Description: Updates an existing automated reoccurring affiliate emailer. REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateAutoEmail/[affiliate_auto_email_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field sendCondition Data Type Limit/Size Data Type string integer integer integer Values Limit/Size Values less than at least
Field clicksThresholdType clicksThreshold daysSinceJoining reoccurDay
>0 >0 1-28
Optional Parameters: Field subject plainTextMessage htmlMessage Data Type string string string Limit/Size Values alphanumeric value alphanumeric value alphanumeric value Default
146
Responses Success
Affiliate auto email updated [affiliate_auto_email_id]
Failure
The affiliate auto email address https://[client_domain]/apifleet/rest/[client_id]/affiliateAutoEmail/[affiliate_auto_email_id] is not valid.
147
Remove Affiliate Auto-Emails
API Name: removeAffiliateAutoEmail Description: Deletes an existing affiliate auto email REST URL: https://[client_domain]/apifleet/rest/[client_id]/affiliateAutoEmail/[affiliate_auto_email_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type affiliate_auto_email_id integer Limit/Size Values valid affiliate auto email ID, passed viat the URL
Responses Success
Affiliate auto email deleted - [affiliate_auto_email_id].
Failure
The affiliate auto email address https://[client_domain]/apifleet/rest/[client_id]/affiliateAutoEmail/[affiliate_auto_email_id] is not valid.
148
List Affiliate Auto-Emails
API Name: listAffiliateAutoEmail Description: Returns a list of REST resource URLs pointing to affiliate auto emails. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateAutoEmail/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Subject
149
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/af filiateAutoEmail/"> <resourceURL location="../../affiliateAutoEmail/1" metaData1="End-ofMonth Wrap-up" metaData2="" metaData3=""/> <resourceURL location="../../affiliateAutoEmail/2" metaData1="Six Month Check-up" metaData2="" metaData3=""/> </resourceList>
Failure
The affiliate auto email list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateAutoEmail/ does not exist.
150
View Affiliate Auto-Emails
API Name: getAffiliateAutoEmailDetail Description: Retrieves detailed information about a given affiliate auto emailer. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateAutoEmail/[affiliate_auto_email_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type affiliate_auto_email_id integer Limit/Size Values valid affiliate auto email ID, passed via the URL
151
<affiliateAutoEmail xmlns="http://www.digitalriver.com/directtrack/api/thirdPartyPixel/[versio n_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/thirdParty Pixel/[version_id]thirdPartyPixel.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/thirdPartyPixe l/[third_party_pixel_id]"> <sendCondition> <reoccurDay>28</reoccurDay> </sendCondition> <subject><![CDATA[Some great subject!]]></subject> <plainTextMessage><![CDATA[New affiliate email!]]></plainTextMessage> <htmlMessage><![CDATA[New affiliate e-mail!]]></htmlMessage> </affiliateAutoEmail>
Failure
The affiliate auto email address https://[client_domain]/apifleet/rest/[client_id]/[access_id]/affiliateAutoEmail/[affiliate_auto_emai l_id] is not valid.
152
Affiliate Emails Email History Reports
List Email Reports
API Name: listEmailReport Description: Returns a list of REST resource URLs pointing to email reports. The list returned can include all email reports for a given day, or be filtered by emailer type (automated) by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Email Report List Resources List Name All Email Reports by Day Automated Email Reports by Day REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/emailReport/[YYYY-MM-DD]/ /rest/[client_id]/[access_id]/emailReport/automated/[YYYY-MMDD]/
153
Metadata: Field metaData1 metaData2 metaData3 Responses XML Example Values Type Subject Send Date
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/em ailReport/2010-01-21/"> <resourceURL location="../../emailReport/15" metaData1="MANUAL" metaData2="Check out these new campaigns!" metaData3="2010-01-01"/> <resourceURL location="../../emailReport/27" metaData1="AUTOMATIC" metaData2="Happy New Year" metaData3="2010-01-01"/> <resourceURL location="../../emailReport/44" metaData1="AUTOMATIC" metaData2="Welcome to the network" metaData3="2010-01-08"/> </resourceList>
Failure
The email report list at https://[client_domain]/apifleet/rest/[client_id]/emailReport/[YYYY-MM-DD] does not exist.
154
View Email Reports
API Name: getEmailReportDetail Description: Retrieves detailed information about a given email report. REST URL: https://[client_domain]/apifleet/rest/[client_id]/emailReport/[email_report_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type email_report_id integer Limit/Size Values valid email report ID, passed via the URL
155
<?xml version="1.0" encoding="utf-8"?> <emailReport xmlns="http://www.digitalriver.com/directtrack/api/emailReport/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/emailRepor t/[version_id] emailReport.xsd" location="https://[client_domain/apifleet/rest/[client_id]/[access_id]/ema ilReport/[yyyy]-[mm]-[dd]/"> <date>2009-02-10 11:03:14</date> <sentTo> <affiliateResourceURL location=../affiliate/[affiliate_id] /> </sentTo> <fromAddress>admin@directtrack.com</fromAddress> <subject>Information you need to know</subject> <status>SENT</status> <errors></errors> <smtpServer></smtpServer> <smtpUsername></smtpUsername> <smtpPassword></smtpPassword> <emailType>AUTOMATIC</emailType> </emailReport>
Failure
The email report address https://[client_domain]/apifleet/rest/[client_id]/emailReport/[email_report_id] is not valid.
156
API Reference Campaign Management

Campaigns
Add Campaign
API Name: createCampaign Description: Adds a new campaign. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaign/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field campaignType Data Type string Limit/Size Values CPC (Cost Per Click) CPM (Cost Per Impression) CPA (Cost Per Action) CPS (Cost Per Sale) alphanumeric value pixel hosted import
campaignName trackMethod
string string
100
Optional Parameters: Field status Data Type string Limit/Size Accepted Values active inactive pending deleted 1 0 Default inactive
exludeEPC
booleanInt
157
Field trackConversionType
Data Type string
recurringPayout sharePerformance campaignURL discontinueURL longDescription shortDescription subjectLines primaryAdvertiserEmail advertiserURL startDate endDate cookieExpireDays clicksOffered leadsOffered grossSalesOffered impressionsOffered target
string string anyURI string string string string string anyURI string string integer integer integer integer integer string
turnOffBlanket notificationDate notifyLevelClicks notifyLevelLeads notifyLevelSales notifyLevelImpressions thresholdEmail internalNotes
booleanInt string integer integer integer integer string string
Limit/Size Accepted Values none leads sales booleanIn 1 t 0 booleanIn 1 t 0 255 alphanumeric value (relative URL) 255 alphanumeric value 2000 alphanumeric value 2000 alphanumeric value 2000 alphanumeric value 100 email formatted alphanumeric value alphanumeric value (relative URL) 10 date value formatted as YYYY-MM-DD 10 date value formatted as YYYY-MM-DD numeric value numeric value numeric value numeric value numeric value category public select private 1 0 10 date value formatted as YYYY-MM-DD numeric value numeric value numeric value numeric value 100 email formatted alphanumeric value 2000 alphanumeric value
Default
0 0
public
158
Field updateSchedule
Data Type string
thirdPartyPlaced allowAffiliateUpload hidden campaignImage removeExisting newImageFileLocation fileMethod
booleanInt booleanInt booleanInt anyURI booleanInt anyURI string
ftpUsername ftpPassword unsubType
string string string
requireDownload dneMerchantCode dneList alternateLinkURL unsubLinkURL suppressionFileLinkURL apiURL hashValue extraTerms extraTermsRequired category1 category2 category3 country
booleanInt string string anyURI anyURI anyURI anyURI string string booleanInt string string string string
Limit/Size Accepted Values none realtime sporadically daily weekly monthly 1 0 1 0 1 0 alphanumeric value (relative URL) 1 0 100 alphanumeric value (relative URL) http ftp globalftp 100 alphanumeric value 100 alphanumeric value Custom DNEList UnsubCentral 1 0 5 Your DNE Merchant ID 100 list name or list ID alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value (relative URL) 255 alphanumeric value alphanumeric value 1 0 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value 2-4 alphanumeric value
Default none
0 0 0
yes
all
159
Field trafficLimitRedirectURL
Data Type Attributes: Field type
Limit/Size Accepted Values Data Type string
Default Values discontinue georedirect custom inactivate campaign - If using type campaign, both of these attributes MUST be specified. - Relative URLs pointing to the campaign/creative that will accept the traffic overage required if using type custom Values email-formatted string value for limit notifications
campaignResourceURL
resourceURI
creativeResourceURL
resourceURI
url trafficLimitNotification Field notifyEmail
string Data Type string
Responses Success Example
Campaign created. https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]
Failure Example
A campaign type is required when adding a campaign.
160
Edit Campaign
API Name: editCampaign Description: Updates campaigns and stores that the campaign was modified by an API Call on the given date within the campaign information screen. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field campaignID Data Type integer Limit/Size Values valid campaign ID
Optional Parameters: Field campaignType Data Type string Limit/Size Accepted Values CPC (Cost Per Click) CPM (Cost Per Impression) CPA (Cost Per Action) CPS (Cost Per Sale) 100 alphanumeric value pixel hosted import active inactive pending deleted 1 0 none leads sales booleanIn 1 t 0 booleanIn 1 t 0 Default
campaignName trackMethod
string string
status
string
inactive
exludeEPC trackConversionType
booleanInt string
recurringPayout sharePerformance
string string
0 0
161
Field campaignURL discontinueURL longDescription shortDescription subjectLines primaryAdvertiserEmail advertiserURL startDate endDate cookieExpireDays clicksOffered leadsOffered grossSalesOffered impressionsOffered target
Data Type anyURI string string string string string anyURI string string integer integer integer integer integer string
Limit/Size 255 255 2000 2000 2000 100 10 10
turnOffBlanket notificationDate notifyLevelClicks notifyLevelLeads notifyLevelSales notifyLevelImpressions thresholdEmail internalNotes updateSchedule
booleanInt string integer integer integer integer string string string 10
100 2000
thirdPartyPlaced allowAffiliateUpload hidden campaignImage
booleanInt booleanInt booleanInt anyURI
Accepted Values alphanumeric value (relative URL) alphanumeric value alphanumeric value alphanumeric value alphanumeric value email formatted alphanumeric value alphanumeric value (relative URL) date value formatted as YYYY-MM-DD date value formatted as YYYY-MM-DD numeric value numeric value numeric value numeric value numeric value category public select private 1 0 date value formatted as YYYY-MM-DD numeric value numeric value numeric value numeric value email formatted alphanumeric value alphanumeric value none realtime sporadically daily weekly monthly 1 0 1 0 1 0 alphanumeric value (relative URL)
Default
public
none
0 0 0
162
Field removeExisting newImageFileLocation fileMethod
Data Type booleanInt anyURI string
ftpUsername ftpPassword unsubType
string string string
requireDownload dneMerchantCode dneList alternateLinkURL unsubLinkURL suppressionFileLinkURL apiURL hashValue extraTerms extraTermsRequired category1 category2 category3 country
booleanInt string string anyURI anyURI anyURI anyURI string string booleanInt string string string string
Limit/Size Accepted Values 1 0 100 alphanumeric value (relative URL) http ftp globalftp 100 alphanumeric value 100 alphanumeric value Custom DNEList UnsubCentral 1 0 5 Your DNE Merchant ID 100 list name or list ID alphanumeric value (URL) alphanumeric value (URL) alphanumeric value (URL) alphanumeric value (URL) 255 alphanumeric value alphanumeric value 1 0 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value 2-4 alphanumeric value
Default 0
yes
all
163
Field trafficLimitRedirectURL
Data Type Attributes: Field type
Limit/Size Accepted Values Data Type string
Default Values discontinue georedirect custom inactivate campaign - If using type campaign, both of these attributes MUST be specified. - Relative URLs pointing to the campaign/creative that will accept the traffic overage required if using type custom Values email-formatted string value for limit notifications
campaignResourceURL
resourceURI
creativeResourceURL
resourceURI
url trafficLimitNotification Field notifyEmail
string Data Type string
The campaign has been updated - [campaign_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]
164
List Campaigns
API Name: listCampaign Description: Returns a list of REST resource URLs pointing to campaigns. The list returned can include all campaigns or be filtered by campaign status and type by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Campaign List Resources List Name All Campaigns Active Campaigns Active Cost-Per-Action Campaigns Active Cost-Per-Click Campaigns Active Cost-Per-Impression Campaigns Active Cost-Per-Sale Campaigns Inactive Campaigns Inactive Cost-Per-Action Campaigns Inactive Cost-Per-Click Campaigns Inactive Cost-Per-Impression Campaigns Inactive Cost-Per-Sale Campaigns Pending Campaigns Pending Cost-Per-Action Campaigns Pending Cost-Per-Click Campaigns Pending Cost-Per-Impression Campaigns Pending Cost-Per-Sale Campaigns Campaigns by Campaign Category Campaigns for an Advertiser Approved affiliates for Campaigns of type Private or Select REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/campaign/ /rest/[client_id]/[access_id]/campaign/active/ /rest/[client_id]/[access_id]/campaign/active/cpa/ /rest/[client_id]/[access_id]/campaign/active/cpc/ /rest/[client_id]/[access_id]/campaign/active/cpm/ /rest/[client_id]/[access_id]/campaign/active/cps/ /rest/[client_id]/[access_id]/campaign/inactive/ /rest/[client_id]/[access_id]/campaign/inactive/cpa/ /rest/[client_id]/[access_id]/campaign/inactive/cpc/ /rest/[client_id]/[access_id]/campaign/inactive/cpm/ /rest/[client_id]/[access_id]/campaign/inactive/cps/ /rest/[client_id]/[access_id]/campaign/pending/ /rest/[client_id]/[access_id]/campaign/pending/cpa/ /rest/[client_id]/[access_id]/campaign/pending/cpc/ /rest/[client_id]/[access_id]/campaign/pending/cpm/ /rest/[client_id]/[access_id]/campaign/pending/cps/ /rest/[client_id]/[access_id]/campaign/category/[category_id]/ /rest/[client_id]/[access_id]/campaign/advertiser/[advertiser_id]/ /rest/[client_id]/[access_id] /campaign/[private|select]/affiliate/[affiliate_id]/
HTTP Method: GET Cache Lifetime: 1 Day API Rate: 1 point per row returned
165
Metadata: Field metaData1 metaData2 metaData3 Values Campaign ID Campaign Name Campaign Type
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceList/[versi on_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/campaign/active/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]"/> </resourceList>
Failure Example
The campaign list at https://[client_domain]/apifleet/rest/[client_id]/campaign/active/cpm/ does not exist.
166
View Campaign
API Name: getCampaignDetail Description: Retrieves campaign information for a specified campaign ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id] HTTP Method: GET Cache Lifetime: 1 Day API Rate: 10 points per call Required Parameters: Field campaignID Data Type integer Limit/Size Values valid campaign ID
Optional Parameters: Field Data Type Limit/Size Accepted Values Default
167

<campaign xmlns="http://www.digitalriver.com/directtrack/api/campaign/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/campaign/[version_i d] campaign.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]" > <campaignType>CPA</campaignType> <campaignName><![CDATA[Campaign Name]]></campaignName> <trackMethod>pixel</trackMethod> <status>inactive</status> <excludeEPC>1</excludeEPC> <trackConversionType>lead</trackConversionType> <recurringPayout></recurringPayout> <sharePerformance>1</sharePerformance> <campaignURL><![CDATA[http://www.example.com]]></campaignURL> <discontinueURL><![CDATA[http://www.example.com]]></discontinueURL> <longDescription><![CDATA[long description]]></longDescription> <shortDescription/> <subjectLines><![CDATA[subject lines]]></subjectLines> <primaryAdvertiserEmail>example@example.com</primaryAdvertiserEmail> <advertiserURL location="https://[client_domain]/apifleet/rest/[client]/advertiser/[advertiser_id] "/> <startDate>2001-01-01</startDate> <endDate>2000-01-01</endDate> <cookieExpireDays>1</cookieExpireDays> <clicksOffered>1</clicksOffered> <leadsOffered>1</leadsOffered> <grossSalesOffered>1</grossSalesOffered> <impressionsOffered>0</impressionsOffered> <target>category</target> <turnOffBlanket>1</turnOffBlanket> <notificationDate>1999-02-03</notificationDate> <notifyLevelClicks>1</notifyLevelClicks> <notifyLevelLeads>1</notifyLevelLeads> <notifyLevelSales>1</notifyLevelSales> <notifyLevelImpressions>0</notifyLevelImpressions> <thresholdEmail>example@example.com</thresholdEmail> <internalNotes><![CDATA[internal notes]]> </internalNotes> <updateSchedule>none</updateSchedule> <authenticationDomainURL></authenticationDomainURL> <thirdPartyPlaced>1</thirdPartyPlaced> <allowAffiliateUpload>1</allowAffiliateUpload> <hidden>1</hidden> <campaignImage/> <unsubType>DNEList</unsubType> <requireDownload>1</requireDownload> <dneMerchantCode><![CDATA[sg8h]]> </dneMerchantCode> <dneList><![CDATA[1]]> </dneList> <alternateLinkURL> http://www.example.com </alternateLinkURL> <unsubLinkURL> http://www.example.com </unsubLinkURL> <suppressionFileLinkURL> http://www.example.com</suppressionFileLinkURL> <apiURL>http://www.example.com</apiURL> <hashValue><![CDATA[hash value]]></hashValue>
168
<extraTerms><![CDATA[extra terms]]></extraTerms> <extraTermsRequired>0</extraTermsRequired> <category1ResourceURL location=../campaignCategory/2 /> <category2ResourceURL location=../campaignCategory/5 /> <category3ResourceURL location=../campaignCategory/14 /> <unsubFileResourceURL location="https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]/ unsubfile"/> <campaignGroups> <resourceURL location="https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign _group_id]"/> </campaignGroups> <allowedCountries allCountries="1"/> <usesReservoirTrackingServer /> <requireApprovedSiteID /> <defaultSiteID /> <trafficLimitsRedirectURL type=inactivate /> <trafficLimits> <trafficLimitResourceURL location=../trafficLimit/1 /> <trafficLimitResourceURL location=../trafficLimit/2 /> </trafficLimits> <trafficLimitsNotification> <notifyEmail><![CDATA[example@example.com]]></notifyEmail> <notifyEmail><![CDATA[example2@example.com]]></notifyEmail>
</trafficLimitsNotification>
</campaign>
Failure Example
The campaign address https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id] is not valid.
169
Campaign Groups
Add Campaign Group
API Name: createCampaignGroup Description: Adds a new campaign group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field groupName comments Data Type string string Limit/Size Values alphanumeric string alphanumeric string
Optional Parameters: Field campaigns Data Type anyURI Limit/Size Values alphanumeric string (relative URL) Defaults
Campaign Group created. https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign_group_id]
Failure Example
A group name is required when adding a campaign group.
170
Edit Campaign Group
API Name: editCampaignGroup Description: Updates information for a specified campaign group ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign_group_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field Data Type campaign_group_id string Limit/Size Values numeric string
Optional Parameters: Field groupName comments campaigns Data Type string string anyURI Limit/Size Values alphanumeric string alphanumeric string alphanumeric string (relative URL) Default
The campaign group has been updated - [campaign_group_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/campaign_group_id/
171
Remove Campaign Group
API Name: removeCampaignGroup Description: Deletes a campaign group for a specified campaign group ID REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign_group_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field Data Type campaign_group_id string Limit/Size Values numeric string
The campaign group has been deleted - [campaign_group_id].
Failure Example
The campaign group address https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign_group_id] is not valid.
172
List Campaign Groups
API Name: listCampaignGroup Description: Returns a list of REST resource URLs pointing to campaign groups. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/ HTTP Method: GET Cache Lifetime: 1 Week API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
173
Responses XML Example <resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifle et/rest/[client_id]/[access_id]/campaignGroup/"> <resourceURL location="../../campaignGroup/1" metaData1="Campaign Group 1" metaData2="1" metaData3=""/> <resourceURL location="../../campaignGroup/2" metaData1="Campaign Group 2" metaData2="2" metaData3=""/> <resourceURL location="../../campaignGroup/3" metaData1="Campaign Group 3" metaData2="3" metaData3=""/> <resourceURL location="../../campaignGroup/4" metaData1="Campaign Group 4" metaData2="4" metaData3=""/> <resourceURL location="../../campaignGroup/5" metaData1="Campaign Group 5" metaData2="5" metaData3=""/> </resourceList>
Failure Example
The campaign group list at https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/ does not exist.
174
View Campaign Group

API Name: getCampaignGroupDetail Description: Retrieves campaign group information for a specified campaign group ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign_group_id] HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field Data Type campaign_group_id string Optional Parameters: Field Data Type Limit/Size Values Default Limit/Size Values numeric string

<campaignGroup xmlns="http://www.digitalriver.com/directtrack/api/campaignGroup/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/campaignGroup/[vers ion_id] campaignGroup.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/campaignGroup/[campaign _group_id]"> <groupName><![CDATA[Example Campaign Group]]></groupName> <comments/> <campaigns> <resourceURL location="../campaign/[campaign_id]"/> <resourceURL location="../campaign/[campaign_id]"/> </campaigns> </campaignGroup>
175
Campaign Categories
Add Campaign Categories
API Name: createCampaignCategory Description: Adds a new campaign category. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field categoryName Data Type string Limit/Size Values alphanumeric value
Optional Parameters: Field Data Type Limit/Size Values Defaults
Campaign category created. https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/[campaign_category_id]
Failure Example
A category name is required when adding a campaign category.
176
Edit Campaign Category
API Name: editCampaignCategory Description: Updates information for a specified campaign category ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/[campaign_category_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field categoryName Data Type string Limit/Size Values alphanumeric string
The campaign category has been updated - [campaign_category_id].
Failure Example
The campaign category address https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/[campaign_category_id]/ is not valid.
177
List Campaign Categories
API Name: listCampaignCategory Description: Returns a list of REST resource URLs pointing to campaign categories. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Category Name Category ID
178

<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifleet/res t/[client_id]/[access_id]/campaignCategory/"> <resourceURL location="../../campaignCategory/1" metaData1="Campaign Category 1" metaData2="1" metaData3=""/> <resourceURL location="../../campaignCategory/2" metaData1="Campaign Category 2" metaData2="2" metaData3=""/> <resourceURL location="../../campaignCategory/3" metaData1="Campaign Category 3" metaData2="3" metaData3=""/> <resourceURL location="../../campaignCategory/4" metaData1="Campaign Category 4" metaData2="4" metaData3=""/> <resourceURL location="../../campaignCategory/5" metaData1="Campaign Category 5" metaData2="5" metaData3=""/> </resourceList>
Failure Example
The campaign category list at https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/ does not exist.
179
View Campaign Category

API Name: getCampaignCategoryDetail Description: Retrieves campaign category information for a specified campaign category ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/[campaign_category_id] HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field Data Type campaign_category_id string Limit/Size Values valid campaign category ID passed via the URL
180

<campaignCategory xmlns="http://www.digitalriver.com/directtrack/api/campaignCategory/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/campaignCategory/[v ersion_id] campaignCategory.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/1"> <categoryName><![CDATA[Arts and crafts]]></categoryName> </campaignCategory>
Failure Example
The campaign category address https://[client_domain]/apifleet/rest/[client_id]/campaignCategory/[campaign_category_id] is not valid.
181
Creatives
Add Creative
API Name: createCreative Description: Adds a creative to a campaign. When adding a creative:
For a TEXT creative: o The 'text' node is used to set the contents o The 'html' node is ignored For an HTML creative: o The 'text' node is ignored o The 'html' node is used to set the contents For an EMAIL creative: o The 'text' node is used to set the text version of the email o The 'html' node is used to set the html version of the email contents
REST URL: https://[client_domain]/apifleet/rest/[client_id]/creative/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field creativeType Data Type string Limit/Size Values text image html email contextual zip coupon code mobile opt-in mobile number capture alphanumeric value (relative URL)
campaignResourceURL resourceURI
182
Optional Parameters: Field linkingURL directLink status Data Type string booleanInt string Limit/Size Values 255 alphanumeric value 1 0 active inactive deleted pending alphanumeric value 255 alphanumeric value YYYY-MM-DD integer integer 1 0 1 0 1 0 alphanumeric value (URL) 255 alphanumeric value 1 0 alphanumeric value (relative URL) 100 alphanumeric value http ftp globalftp 255 alphanumeric value 255 alphanumeric value alphanumeric value (relative URL) Defaults
description anchorText expireDate expireClicks expireImpressions adPoolOnly hidden useCustomURL customClickURL imageName hostImage fileLocation
string string datetime unsignedInt unsignedInt booleanInt string booleanInt anyURI string booleanInt anyURI
ftpServer fileMethod
string string
ftpUserName ftpPassword imageURL
string string anyURI
183
Field altTag bannerSize
Data Type string string
customImageURL
anyURI
text html trackImpressions fromAddress subjectLines merchantName couponText couponDescription couponCode estimatedValue keywords startDate
string string booleanInt string string string string string string double string string
revolveExpirationDate terms category1 category2 category3
string string string string string
Limit/Size Values Defaults alphanumeric value numeric value formatted ##x## alphanumeric value (relative URL) alphanumeric value alphanumeric value 1 1 0 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value alphanumeric value numeric value alphanumeric value 10 dateformatted YYYY-MM-DD Yes No alphanumeric value alphanumeric value alphanumeric value alphanumeric value
184
Field smsContactListResourceURL
Data Type Limit/Size Values Defaults resourceURI alphanumeric value (relative URL) smsOwnerResourceURL resourceURI alphanumeric value (relative URL) smsCreditType string onSubmit onOptIn smsShortcodeResourceURL resourceURI alphanumeric value (relative URL) smsKeyword string 50 alphanumeric value smsDoubleByteEncoding booleanInt 1 0 0 smsOptInMessage string 106 alphanumeric value smsOptOutMessage string 106 alphanumeric value smsOptInPostMessage string 106 alphanumeric value smsOptOutPostMessage string 106 alphanumeric value smsMarketingMessage string 106 alphanumeric value smsDeliveryCreativeResourceURL resourceURI alphanumeric value (relative URL)
Creative created. https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]
Failure Example
A creative type is required when adding a creative.
185
Edit Creative
API Name: editCreative Description: Updates creative information for a specified creative ID. When updating a creative: For a TEXT creative: o The 'text' node is used to set the contents o The 'html' node is ignored
For an HTML creative: o The 'text' node is ignored o The 'html' node is used to set the contents For an EMAIL creative: o The 'text' node is used to set the text version of the email o The 'html' node is used to set the html version of the email contents
REST URL: https://[client_domain]/apifleet/rest/[client_id]/creative/[creative_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field creative_id Data Type long Limit/Size Values valid single creative ID
186
Optional Parameters: Field creativeType Data Type string Limit/Size Values text image html email contextual zip coupon code mobile opt-in mobile number capture resourceURI alphanumeric value (relative URL) string 255 alphanumeric value booleanInt 1 0 string active inactive deleted pending string alphanumeric value string 255 alphanumeric value datetime YYYY-MM-DD unsignedInt integer unsignedInt integer booleanInt 1 0 string 1 0 booleanInt 1 0 anyURI alphanumeric value (URL) string 255 alphanumeric value booleanInt 1 0 Defaults
campaignResourceURL
linkingURL directLink status
description anchorText expireDate expireClicks expireImpressions adPoolOnly hidden useCustomURL customClickURL imageName hostImage
187
Field fileLocation
Data Type anyURI
ftpServer fileMethod
string string
ftpUserName ftpPassword imageURL
string string anyURI
altTag bannerSize
string string
customImageURL
anyURI
text html trackImpressions fromAddress subjectLines merchantName couponText couponDescription couponCode estimatedValue
string string booleanInt string string string string string string double
Limit/Size Values Defaults alphanumeric value (relative URL) 100 alphanumeric value http ftp globalftp 255 alphanumeric value 255 alphanumeric value alphanumeric value (relative URL) alphanumeric value numeric value formatted ##x## alphanumeric value (relative URL) alphanumeric value alphanumeric value 1 1 0 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value 255 alphanumeric value alphanumeric value alphanumeric value
188
Field keywords startDate
Data Type string string
revolveExpirationDate terms category1 category2 category3 smsContactListResourceURL
string string string string string resourceURI
smsOwnerResourceURL
resourceURI
smsCreditType smsShortcodeResourceURL
string resourceURI
smsKeyword smsDoubleByteEncoding smsOptInMessage smsOptOutMessage smsOptInPostMessage smsOptOutPostMessage smsMarketingMessage
string booleanInt string string string string string
smsDeliveryCreativeResourceURL resourceURI
Limit/Size Values Defaults alphanumeric value 10 dateformatted YYYY-MM-DD Yes No alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value (relative URL) alphanumeric value (relative URL) onSubmit onOptIn alphanumeric value (relative URL) 50 alphanumeric value 1 0 0 106 alphanumeric value 106 alphanumeric value 106 alphanumeric value 106 alphanumeric value 106 alphanumeric value alphanumeric value (relative URL)
189
The creative has been updated - [creative_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/creative/[creative_id]
190
Remove Creative
API Name: removeCreative Description: Deletes a creative using a creative ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/creative/[creative_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field creativeID Data Type long Limit/Size Values valid creative ID passed via the URL
The creative has been deleted - [creative_id].
Failure Example
The creative address https://[client_domain]/apifleet/rest/[client_id]/creative/[creative_id] is not valid.
191
List Creatives
API Name: listCreative Description: Returns a list of REST resource URLs pointing to creatives. The list returned can include all creatives or be filtered by creative type or creative type AND status by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Creative List Resources List Name REST URL (Preceded by https://[client_domain]/apifleet) Creatives for a Campaign /rest/[client_id]/[access_id]/creative/campaign/[campaign_id]/ Creatives for a Campaign /rest/[client_id]/[access_id]/creative/campaign/[campaign_id]/[creative_type]/ by Creative Type
Values for creative_type: Only ONE of the follow can be passed via the URL: contextual|email|html|image|text|mobileNumberCapture|mobileOptIn|zip|couponCode HTTP Method: GET Cache Lifetime: 1 Hour API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
192
Metadata: Field metaData1 metaData2 metaData3 Values Creative ID Creative Type Creative Size
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/creative/campaign/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/creative/campaign/[campa ign_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/creative/campaign/[campa ign_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/creative/campaign/[campa ign_id]"/> </resourceList>
Failure Example
The creative list at https://[client_domain]/apifleet/rest/[client_id]/creative/contextual/ does not exist.
193
View Creative
API Name: getCreativeDetail Description: Returns creative information for a specified creative ID. When getting a creative:

For an HTML creative the 'text' node will contain the html code of the creative. The 'html' node is actually used for EMAIL creatives and it represents the html version of the creative text.
REST URL: https://[client_domain]/apifleet/rest/[client_id]/creative/[creative_id] HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field creative_id Data Type long Limit/Size Values valid creative ID passed via the URL
194
<creative xmlns="http://www.digitalriver.com/directtrack/api/creative/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/creative/[ version_id] creative.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/creative/[crea tive_id]"> <creativeType>image</creativeType> <campaignResourceURL location="../campaign/[campaign_id]"/> <linkingURL><![CDATA[http://www.google.com]]></linkingURL> <directlink>0</directlink> <status>active</status> <description/> <anchorText/> <expireDate>0000-00-00</expireDate> <expireClicks>0</expireClicks> <expireImpressions>0</expireImpressions> <adPoolOnly>0</adPoolOnly> <hidden>0</hidden> <customURL>none</customURL> <hostImage></hostImage> <fileLocation></fileLocation> <ftpServer></ftpServer> <fileMethod></fileMethod> <ftpUsername></ftpUsername> <ftpPassword></ftpPassword> <imageURL/> <altTag/> <bannerSize>54x435</bannerSize> <customImageURL><![CDATA[all]]></customImageURL> <text></text> <html/> <trackImpressions></trackImpressions> <fromAddress/> <subjectLines/> </creative>
Failure Example
The creative address https://[client_domain]/apifleet/rest/[client_id]/creative/[creative_id] is not valid.
195
Mobile Creative Helpers
List SMS Short Codes
API Name: listSMSShortCode Description: Returns a list of all REST resource URLs pointing to SMS short codes in your DirectTrack account. REST URL: https://[client_domain]/apifleetrest/[client_id]/[access_id]/smsShortCode/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Short Code Number Owner Type (General, Admin, Affiliate or Advertiser) Owner ID (If Affiliate or Advertiser)
196
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/[sms_short_ code_id]" metadata1="12345" metadata2="Admin" metadata3="" /> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/[sms_short_ code_id]" metadata1="98765" metadata2="General" metadata3="" /> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/[sms_short_ code_id]" metadata1="24680" metadata2="Admin" metadata3="" /> </resourceList>
Failure Example
The SMS short code list at https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/ does not exist.
197
View SMS Short Codes
API Name: getSMSShortCode Description: Returns information for a specified SMS Short Code ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/[sms_short_code_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type sms_short_code_id long Limit/Size Values valid SMS Short Code ID passed via the URL
198
<smsShortCode xmlns="http://www.digitalriver.com/directtrack/api/smsShortCode/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/smsShortCo de/[version_id] smsShortCode.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/[ sms_short_code_id]"> <shortCode>12345</shortCode> <smsOwner location="../advertiser/[advertiser_id]" isGeneral="0"/> </smsShortCode>
Failure Example
The SMS short code address https://[client_domain]/apifleet/rest/[client_id]/smsShortCode/[sms_short_code_id] is not valid.
199
Add an SMS Contact List
API Name: createSMSContactList Description: Adds an SMS Contact List. REST URL: https://[client_domain]/apifleet/rest/[client_id]/smsContactList/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field listName Data Type string Limit/Size 100 Values alphanumeric value
Optional Parameters: Field smsListOwner Attributes Field location Data Type resourceURI Values alphanumeric value (relative URL) 0 1
isAdmin
booleanInt
200
SMS Contact List created. https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_contact_list_id]
Failure Example
A list name is required when adding an SMS Contact List.
201
Update an SMS Contact List
API Name: editSMSContactList Description: Updates information for a specified SMS Contact List ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_contact_list_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field Data Type sms_contact_list_id long listName string Limit/Size Values valid SMS Contact List ID, passed via the URL alphanumeric value
100
Optional Parameters: Field smsListOwner Attributes Field location isAdmin Data Type resourceURI booleanInt Values alphanumeric value (relative URL) 0 1
202
The SMS Contact List has been updated - [sms_contact_list_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_contact_list_id]
203
List SMS Contact Lists
API Name: listSMSContactList Description: Returns a list of REST resource URLs pointing to SMS Contact Lists. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/smsContactList/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Short Code Number Owner Type (General, Admin, Affiliate or Advertiser) Owner ID (If Affiliate or Advertiser)
204
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/smsContactList/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_cont act_list_id]" metadata1="12345" metadata2="Admin" metadata3="" /> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_cont act_list_id]" metadata1="98765" metadata2="General" metadata3="" /> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_cont act_list_id]" metadata1="24680" metadata2="Admin" metadata3="" /> </resourceList>
Failure Example
The SMS Contact List list at https://[client_domain]/apifleet/rest/[client_id]/smsContactList/ does not exist.
205
View an SMS Contact List
API Name: getSMSContactList Description: Returns information for an SMS Contact List. REST URL: https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_contact_list_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type sms_contact_list_id long Limit/Size Values valid SMS Contact List ID passed via the URL
206
<smsContactList xmlns="http://www.digitalriver.com/directtrack/api/smsShortCode/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/smsContact List/[version_id] smsContactList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/smsContactList /[sms_contact_list_id]"> <listName>My Contact List</listName> <smsListOwner location="../advertiser/[advertiser_id]" isAdmin="0"/> </smsContactList>
Failure Example
The SMS Contact List address https://[client_domain]/apifleet/rest/[client_id]/smsContactList/[sms_contact_list_id] is not valid.
207
Payouts
Add Payout
API Name: createPayout Description: Adds a payout. REST URL: https://[client_domain]/apifleet/rest/[client_id]/payout/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field payoutType Data Type string Limit/Size Values campaign affiliate product alphanumeric value (URL) Field Values 1 allAffilates booleanInt 0 alphanumeric affiliateCode string value Data Type
campaignResourceURL string affiliate
Optional Parameters: Field impression click lead percentSale flatSale percentSubSale flatSubSale Data Type decimal decimal decimal decimal decimal decimal decimal Limit/Size 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals Values numeric value numeric value numeric value numeric value numeric value numeric value numeric value Default
208
Field effectiveDate
Data Type string
Limit/Size
productResourceURL resourceURI
Values numeric value in the format YYYYMM-DD relativeURL pointing to a product
Default
Payout created. https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id]
Failure Example
A payout type is required when adding a payout.
209
Edit Payout
API Name: editPayout Description: Updates a payout using a specified payout ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field payout_id Data Type string Limit/Size Values alphanumeric value
Optional Parameters: Field payoutType Data Type string Limit/Size Values campaign affiliate product Default
affiliate Field Values 1 allAffilates booleanInt 0 affiliateCode string alphanumeric value impression click lead percentSale flatSale percentSubSale flatSubSale effectiveDate decimal decimal decimal decimal decimal decimal decimal date 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals 10 digits, including decimals numeric value numeric value numeric value numeric value numeric value numeric value numeric value numeric value in the format YYYY-MM-DD relative URL pointing to a product Data Type
productResourceURL resourceURI
210
The payout has been updated [payout_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id]
211
Remove Payout
API Name: removePayout Description: Deletes a payout. REST URL: https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field payout_id Data Type string Limit/Size Values alphanumeric value
The payout has been deleted [payout_id].
Failure Example
The payout address https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id] is not valid.
212
List Payouts
API Name: listPayout Description: Returns a list of REST resource URLs pointing to payouts. The list returned can be filtered by campaign ID by requesting the appropriate REST resource URL as shown below. REST URL: Payout List Resources List Name Payouts for a Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/payout/campaign/[campaign_id]/
HTTP Method: GET Cache Lifetime: 1 Hour API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Payout ID Campaign ID Affiliate ID
213
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/payout/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/creative/payout/[payout_ id]/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/creative/payout/[payout_ id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/creative/payout/[payout_ id]/> </resourceList>
Failure Example
The payout list at https://[client_domain]/apifleet/rest/[client_id]/affiliate_type/ does not exist.
214
View Payout
API Name: getPayout Description: Retrieves detailed payout information for a specified payout ID. REST URL: https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field payout_id Data Type string Limit/Size Values alphanumeric value
215
Responses Example XML Response

<payout xmlns="http://www.digitalriver.com/directtrack/api/payout/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/payout/[ve rsion_id] payout.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id]"> <payoutType>affiliate</payoutType> <campaignResourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]"/ > <affiliate allAffiliates="1"/> <impression>0</impression> <click>0</click> <lead>0</lead> <percentSale>0</percentSale> <flatSale>0.64</flatSale> <percentSubSale>0</percentSubSale> <flatSubSale>0</flatSubSale> <effectiveDate>2007-08-16</effectiveDate> <modifyDate>2007-08-16</modifyDate> <productResourceURL/> </payout>
Failure Example
The payout address https://[client_domain]/apifleet/rest/[client_id]/payout/[payout_id] is not valid.
216
Traffic Limits
Add Traffic Limits
API Name: createTrafficLimit Description: Adds traffic limits for impressions, clicks, leads and sales to a campaign. NOTE: This API call has not been released; the scheduled release date is 5/12/2010. This document is considered a draft, and should be used for reference only. REST URL: https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field limitType Data Type string Limit/Size Values impression click lead sale per day per month total The numerical value at which the threshold should be set A relative URL for the campaign to which the limit should be applied
limitTimeframe
string
limitAmount
integer
campaignResourceURL anyURI
217
Traffic limit created. https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_limit_id]
Failure Example
A campaign resource URL is required when adding a traffic limit.
218
Update Traffic Limits
API Name: editTrafficLimit Description: Updates and existing traffic limit for impressions, clicks, leads and sales. NOTE: This API call has not been released; the scheduled release date is 5/12/2010. This document is considered a draft, and should be used for reference only. REST URL: https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_limit_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field limitAmount Data Type integer Limit/Size Values The numerical value at which the threshold should be set
Traffic limit updated - [traffic_limit_id]
Failure Example
The limitAmount must be greater than zero.
219
Remove Traffic Limits
API Name: removeTrafficLimit Description: Removes an existing traffic limit for impressions, clicks, leads and sales. NOTE: This API call has not been released; the scheduled release date is 5/12/2010. This document is considered a draft, and should be used for reference only. REST URL: https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_limit_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field traffic_limit_id Data Type string Limit/Size Values alphanumeric value
The traffic limit has been deleted [traffic_limit_id].
Failure Example
The traffic limit address https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_limit_id] is not valid.
220
List Traffic Limits
API Name: listTrafficLimit Description: Returns a list of REST resource URLs pointing to traffic limits for a specified campaign ID. NOTE: This API call has not been released; the scheduled release date is 5/12/2010. This document is considered a draft, and should be used for reference only. REST URL: Traffic Limit List Resources List Name Payouts for a Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/trafficLimit/campaign/[campaign_id]/
Metadata: Field metaData1 metaData2 metaData3 Values
221
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/campaign/[c ampaign_id]/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_li mit_id]" metaData1="clicks" metaData2="per day" metaData3="2500"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_li mit_id]" metaData1="leads" metaData2="per month" metaData3="500"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_li mit_id]" metaData1="leads" metaData2="total" metaData3="3000"/> </resourceList>
Failure Example
The traffic limit address https://[client_domain]/apifleet/rest/[client_id]/[access_id]/trafficLimit/campaign/[campiagn_id]/ does not exist.
222
Get Traffic Limit Details
API Name: getTrafficLimitDetail Description: Returns detailed information about a specified traffic limit. NOTE: This API call has not been released; the scheduled release date is 5/12/2010. This document is considered a draft, and should be used for reference only. REST URL: https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_limit_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field traffic_limit_id Data Type string Limit/Size Values alphanumeric value
223
Responses Example XML Response

<trafficLimit xmlns="http://www.digitalriver.com/directtrack/api/trafficLimit/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/trafficLim it/[version_id] trafficLimit.xsd" location="https://[client].directtrack.com/apifleet/rest/[client]/trafficL imit/[traffic_limit_id]"> <limitType>clicks</limitType> <limitTimeframe>per day</limitTimeframe> <limitAmount>2500</limitAmount> <campaignResourceURL location="../../campaign/555" /> </creative>
Failure Example
The traffic limit address https://[client_domain]/apifleet/rest/[client_id]/trafficLimit/[traffic_limit_id] is not valid.
224
API Reference Datafeeds

Products
Add a Product
API Name: createProduct Description: Adds a new product. REST URL: https://[client_domain]/apifleet/rest/[client_id]/product/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field Data Type campaignResourceURL resourceURI Limit/Size Values alphanumeric value (relative URL)
Optional Parameters: Field categories Data Type resourceURI Limit/Size Accepted Values Any number of relative URLs pointing to campaignCategory or productCategory resources 50 alphanumeric value 50 alphanumeric value numeric value in the format XX.XX alphanumeric value (relative URL) pointing to a productBrand resource Default
productName productID price productBrandResourceUR L alternateURLs
string string double resourceURI
0.00
Accepts any number of <alternateURL> nodes with the following attributes: Field Data Type Values id unsignedInt numeric value title string alphanumeric value location string alphanumeric value
225
Field details
Data Type
Limit/Size Accepted Values
Default
Accepts any number of <detail> nodes with the following attributes: Field Data Type Values title string alphanumeric value description string alphanumeric value string string booleanInt 255 255 alphanumeric value (URL) alphanumeric value (URL) 1 0
websiteURL imageURL popularProduct
Product created. https://[client_domain]/apifleet/rest/[client_id]/product/[product_id]
Failure Example
A campaign resource URL is required when adding a product.
226
Edit a Product
API Name: editProduct Description: Updates an existing product. REST URL: https://[client_domain]/apifleet/rest/[client_id]/product/[product_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field Data Type campaignResourceURL resourceURI Limit/Size Values alphanumeric value (relative URL)
Optional Parameters: Field categories Data Type resourceURI Limit/Size Accepted Values Any number of relative URLs pointing to campaignCategory or productCategory resources 50 alphanumeric value 1-50 alphanumeric value of no more than 50 characters numeric value in the format XX.XX alphanumeric value (relative URL) pointing to a productBrand resource Default
productName productID price productBrandResourceUR L alternateURLs
string string double resourceURI
0.00
Accepts any number of <alternateURL> nodes with the following attributes: Field Data Type Values id unsignedInt numeric value title string alphanumeric value location string alphanumeric value Accepts any number of <detail> nodes with the following attributes: Field Data Type Values title string alphanumeric value description string alphanumeric value string string 255 255 alphanumeric value (URL) alphanumeric value (URL)
details
websiteURL imageURL
227
Field popularProduct
Data Type booleanInt
Limit/Size Accepted Values 1 0
Default 0
Product updated - [product_id]
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/product/[product_id]
228
Remove a Product
API Name: removeProduct Description: Deletes a specified product. REST URL: https://[client_domain]/apifleet/rest/[client_id]/product/[product_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field product_id Data Type Limit/Size Values numeric value, passed via the URL
The product has been deleted - [product_id]
Failure Example
The product address https://[client_domain/apifleet/rest/[client_id]/product/[product_id] is not valid.
229
List Products
API Name: listProduct Description: Returns a list of REST resource URLs pointing to either pages of products or specific products by campaign or page number by requesting the appropriate REST resource URL as shown in the chart below. In an effort to provide extreme flexibility and scalability with this resource, pagination has been implemented. Therefore, a list of all products will return a list of resource URLs for pages, each containing up to 5000 products. REST URL: Product List Resources List Name All Products Products by Page Products by Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/product/ /rest/[client_id]/[access_id]/product/[page_number]/ /rest/[client_id]/[access_id]/product/campaign/[campaign_id]/
230
All Products Metadata: Field metaData1 metaData2 metaData3 Values Total number of records in page
Products by Page/Campaign Metadata: Field metaData1 metaData2 metaData3 Values Product Name Price Product ID
Responses XML Example Listing All Products
<?xml version="1.0" encoding="utf-8"?> <resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/v1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/v1_0 resourceList.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/product/"> <resourceURL location="15/" metaData1="12"/> <resourceURL location="11/" metaData1="6"/> <resourceURL location="4/" metaData1="142"/> <resourceURL location="3/" metaData1="495"/> <resourceURL location="2/" metaData1="1515"/> <resourceURL location="1/" metaData1="801"/> </resourceList>
XML Example Listing by Product Page
<?xml version="1.0" encoding="utf-8"?> <resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/v1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/v1_0 resourceList.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/product/15/"> <resourceURL location="../../product/72005" metaData1="My Product" metaData2="666.00" metaData3="MyProduct"/> <resourceURL location="../../product/72006" metaData1="Another Product" metaData2="9.99" metaData3="AnotherProduct"/> <resourceURL location="../../product/72026" metaData1="Best Selling Product" metaData2="29.99" metaData3="BestSeller"/> </resourceList>
231
Failure Example
The product list at https://[client_domain]/apifleet/rest/[client_id]/product/campaign/555 does not exist.
232
Get Product Details
API Name: getProductDetail Description: Retrieves detailed information about a specified product. REST URL: https://[client_domain]/apifleet/rest/[client_id]/product/[product_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field product_id Data Type Limit/Size Values numeric value passed via the URL
233
<?xml version="1.0" encoding="utf-8"?> <product xmlns="http://www.digitalriver.com/directtrack/api/product/v1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/prod uct/v1_0 product.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/product/7 2117"> <campaignResourceURL location="../campaign/6565"/> <categories> <categoryResourceURL location="../campaignCategory/36"/> <categoryResourceURL location="../campaignCategory/39"/> <categoryResourceURL location="../productCategory/44"/> </categories> <productName><![CDATA[My Product]]> </productName> <productID><![CDATA[MyProduct]]></productID> <price>666.00</price> <productBrandResourceURL location="../productBrand/6"/> <alternateURLs> <alternateURL id="12291" title="anotherURL" location="anotherurl.com"/> </alternateURLs> <details> <detail title="123.COM" description="123.com"/> <detail title="ADD" description="HERE I AM"/> </details> <websiteURL><![CDATA[http://www.google.com]]></websiteURL> <imageURL><![CDATA[123.com]]></imageURL> <popularProduct>1</popularProduct> </product>
Failure Example
The product address https://[client_domain]/apifleet/rest/[client_id]/product/[product_id] does not exist.
234
Product Brands
Add a Product Brand
API Name: createProductBrand Description: Adds a new product brand. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productBrand/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field brandName Data Type string Limit/Size 150 Values alphanumeric value
Product brand created. https://[client_domain]/apifleet/rest/[client_id]/productBrand/[product_brand_id]
Failure Example
A brand name is required when adding a product brand.
235
Edit a Product Brand
API Name: editProductBrand Description: Updates an existing product brand. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productBrand/[product_brand_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field brandName Data Type string Limit/Size 150 Values alphanumeric value
Product brand updated - [product_brand_id]
Failure Example
The product brand address https://[client_domain]/apifleet/rest/[client_id]/productBrand/[product_brand_id] is not valid.
236
List Product Brands
API Name: listProductBrand Description: Lists product brands. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productBrand/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Brand Name
237
<?xml version="1.0" encoding="utf-8"?> <resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/v1_0 " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/v1_0 resourceList.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/productBr and/"> <resourceURL location="16" metaData1="Brand A"/> <resourceURL location="17" metaData1="Brand B"/> <resourceURL location="18" metaData1="Brand C"/> </resourceList>
Failure Example
The product brand list at https://[client_domain]/apifleet/rest/[client_id]/productBrand/[product_brand_id] does not exist.
238
Get Product Brand Details
API Name: getProductBrandDetail Description: Retrieves detailed information about a specified product brand. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productBrand/[product_brand_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type product_brand_id Limit/Size Values numeric value, passed via the URL
239
<?xml version="1.0" encoding="utf-8"?> <productBrand xmlns="http://www.digitalriver.com/directtrack/api/productBrand/v1_0 " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/prod uctBrand/v1_0 productBrand.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/productBr and/18"> <brandName><![CDATA[My Brand]]></brandName> </productBrand>
Failure Example
The product brand address https://[client_domain]/apifleet/rest/[client_id]/productBrand/[product_brand_id] is not valid.
240
Product Categories
Add a Product Category
API Name: createProductCategory Description: Adds a new product category. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productCategory/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field categoryName Data Type string Limit/Size 150 Values alphanumeric value
Product category created. https://[client_domain]/apifleet/rest/[client_id]/productCategory/[product_category_id]
Failure Example
A category name is required when adding a product category.
241
Edit a Product Category
API Name: editProductCategory Description: Updates an existing product category. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productCategory/[product_category_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field categoryName Data Type string Limit/Size 150 Values alphanumeric value
Product category updated - [product_category_id]
Failure Example
The product category address https://[client_domain]/apifleet/rest/[client_id]/productCategory/[product_category_id] is not valid.
242
List Product Categories
API Name: listProductCategory Description: Lists product categories. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productCategory/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
Metadata: Field metaData1 metaData2 metaData3 Values Category Name
243
<?xml version="1.0" encoding="utf-8"?> <resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/v1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/v1_0 resourceList.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/productCategory /"> <resourceURL location="35" metaData1="Sports > Apparel > MLB > Blazers"/> <resourceURL location="28" metaData1="Sports > Apparel > MLB > Jackets"/> <resourceURL location="41" metaData1="Sports > Apparel > MLB > Jackets\Coats"/> <resourceURL location="29" metaData1="Sports > Apparel > MLB > Jerseys"/> <resourceURL location="34" metaData1="Sports > Apparel > MLB > Pennants"/> <resourceURL location="36" metaData1="Sports > Apparel > NBA > Jackets"/> <resourceURL location="33" metaData1="Sports > Apparel > NBA > Jerseys"/> <resourceURL location="42" metaData1="Sports > Apparel > NBA > Warmup's"/> <resourceURL location="32" metaData1="Sports > Apparel > NBA > Warmups"/> <resourceURL location="40" metaData1="Sports > Apparel > NFL > Jackets"/> <resourceURL location="30" metaData1="Sports > Apparel > NFL > Jerseys"/> <resourceURL location="37" metaData1="Sports > Apparel > NHL > Jackets"/> <resourceURL location="31" metaData1="Sports > Apparel > NHL > Jerseys"/> </resourceList>
Failure Example
The product category address https://[client_domain]/apifleet/rest/[client_id]/productCategory/ does not exist.
244
Get Product Category Details
API Name: getProductCategoryDetail Description: Retrieves detailed information about a specified product category. REST URL: https://[client_domain]/apifleet/rest/[client_id]/productCategory/[product_category_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type product_category_id Limit/Size Values numeric value passed via the URL
245
<?xml version="1.0" encoding="utf-8"?> <productCategory xmlns="http://www.digitalriver.com/directtrack/api/productCategory/v 1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/prod uctCategory/v1_0 productCategory.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/productCa tegory/53"> <categoryName><![CDATA[My Category]]></categoryName> </productCategory>
Failure Example
The product category address https://[client_domain]/apifleet/rest/[client_id]/productCategory/[product_category_id] does not exist.
246
API Reference Data Management

Program Impressions
Add Program Impressions
API Name: createProgramImpression Description: Adds program impressions to a campaign and affiliate. REST URL: https://[client_domain]/apifleet/rest/[client_id]/programImpression/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field numImpressions affiliateResourceURL Data Type unsignedInt anyURI Limit/Size 0-16777216 Values The number of program impressions to add A relative URL for the affiliate to which the impressions should be credited A relative URL for the campaign to which the impressions should be credited
campaignResourceURL
anyURI
Optional Parameters: Field creativeResourceURL Data Type anyURI Limit/Size Values Default A relative URL for the creative to which the impressions should be credited
247
Field creativeDeploymentResource URL
Data Type anyURI
Limit/Size
date
string
10
Values A relative URL for the creative deployment to which the impressions should be credited date value formatted as YYYYMM-DD Limit/Size 255 255 255 255 255 1 0
valid landing page ID valid ad pool ID
Default
date the call was made
subIDs Field subID1 subID2 subID3 subID4 subID5 isContextual landingPageID poolID booleanInt unsignedInt unsignedInt Data Type string string string string string Values alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value 0
Program impressions created. https://[client_domain]/apifleet/rest/[client_id]/programImpression/[program_impression_id]
Failure Example
A campaign resource URL is required when adding a program impression.
248
List Program Impressions
API Name: listProgramImpression Description: Returns a list of REST resource URLs pointing to program impression instances. The list returned can be filtered by for impression type by campaign and date, affiliate and date, or campaign, affiliate and date by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Program Impression List Resources List Name Program Impressions by Campaign & Date Program Impressions by Affiliate & Date Program Impressions by Campaign, Affiliate & Date Contextual Program Impressions by Campaign & Date Contextual Program Impressions by Affiliate & Date Contextual Program Impressions by Campaign, Affiliate & Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/programImpression/campaign/[campaign_id]/[yyyy ]-[mm]-[dd]/ /rest/[client_id]/[access_id]/programImpression/affiliate/[affiliate_id]/[yyyy][mm]-[dd]/ /rest/[client_id]/[access_id]/programImpression/campaign/[campaign_id]/affilia te/[affiliate_id]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/programImpression/contextual/campaign/[campaig n_id]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/programImpression/contextual/affiliate/[affiliate_id ]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/programImpression/contextual/campaign/[campaig n_id]/affiliate/[affiliate_id]/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call Program Impressions by Date For a Current Day Day in the Current Month Day in the Previous Month Day in a Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Week 1 Month
249
Metadata: Field metaData1 metaData2 metaData3 Values Date Affiliate ID Campaign ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programImpression/"> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programImpression/[program_impression_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programImpression/[program_impression_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programImpression/[program_impression_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> </resourceList>
250
Failure Example
The program impression list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/programImpression/campaign/[campai gn_id]/[yyyy]-[mm]-[dd]/ does not exist.
251
View Program Impressions
API Name: getProgramImpression Description: Gets details for a specific program impression instance. REST URL: https://[client_domain]/apifleet/rest/[client_id]/programImpression/[program_impression_id]/ HTTP Method: GET Cache Lifetime: 5 Minutes API Rate: 10 points per call Required Parameters: Field program_impression_id Data Type integer Limit/Size Values valid program impression ID
252
<?xml version="1.0" encoding="utf-8"?> <programImpression xmlns="http://www.digitalriver.com/directtrack/api/programImpression /[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/prog ramImpression/[version_id] programImpression.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/programIm pression/352914"> <numImpressions>0</numImpressions> <affiliateResourceURL location="../affiliate/4"/> <campaignResourceURL location="../campaign/135"/> <creativeResourceURL location="../creative/17489"/> <creativeDeploymentResourceURL location="../creativeDeployment/262839"/> <date>2009-06-24</date> <landingPageID>0</landingPageID> <poolID>0</poolID> </programImpression>
Failure Example
The program impression address https://[client_domain]/apifleet/rest/[client_id]/programImpression/[program_impression_id] is not valid.
253
Program Clicks
Add Program Clicks
API Name: createProgramClick Description: Creates a new program click instance REST URL: https://[client_domain]/apifleet/rest/[client_id]/programClick/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field
numClicks
Data Type integer anyURI anyURI anyURI
Limit/Size
Values
the number of clicks to credit to the system
affiliateResourceURL campaignResourceURL creativeResourceURL
creativeDeploymentResourceURL anyURI
the relative URL location of the affiliate the relative URL location of the campaign the relative URL location of the creative the relative URL location of the creative deployment
254
Optional Parameters: Field date subIDs Data Type string Field subID1 subID2 subID3 subID4 subID5 Limit/Size Values date value formatted as YYYY-MM-DD Limit/Size 255 255 255 255 255 Default date the call was made
Data Type string string string string string
Values alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value
landingPageID poolID
Program click created https://[client_domain]/apifleet/rest/[client_id]/programClick/[program_click_id]
Failure Example
A campaign resource URL is required when adding a program click.
255
Edit Program Clicks
API Name: editProgramClick Description: Edits an existing program click instance REST URL: https://[client_domain]/apifleet/rest/[client_id]/programClick/[program_click_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field program_click_id Data Type integer Limit/Size Values valid program click ID
Optional Parameters: Field

numClicks
Data Type integer
Limit/Size
Values
the number of clicks to credit to the system
Default
subIDs
Field subID1 subID2 subID3 subID4 subID5
Limit/Size 255 255 255 255 255
256
Program click updated [program_click_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/programClick/[program_click_id]
257
List Program Clicks
API Name: listProgramClick Description: Returns a list of REST resource URLs pointing to program click instances. The list returned can include be filtered by campaign and date, affiliate and date, or campaign, affiliate and date by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Program Click List Resources List Name Program Click by Campaign & Date Program Click by Affiliate & Date Program Click by Campaign, Affiliate & Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/programClick/campaign/[campaign_id]/[yyyy][mm]-[dd]/ /rest/[client_id]/[access_id]/programClick/affiliate/[affiliate_id]/[yyyy]-[mm][dd]/ /rest/[client_id]/[access_id]/programClick/campaign/[campaign_id]/affiliate/ [affiliate_id]/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call Program Clicks by Date For a Current Day Day in the Current Month Day in the Previous Month Day in a Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Week 1 Month
258
Field
Data Type
Limit/Size
Values
Default
Metadata: Field metaData1 metaData2 metaData3 Responses Success Example Values Date Affiliate ID Campaign ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location=" http://[client_domain]/apifleet/rest/[client_id]/programClick/"> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programClick/[click_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programClick/[click_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programClick/[click_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> </resourceList>
Failure Example
The program click list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/programClick/affiliate/[affiliate_id]/[yy yy]-[mm]-[dd]/ does not exist.
259
View Program Clicks
API Name: getProgramClick Description: Gets details for a specific program click instance REST URL: https://[client_domain]/apifleet/rest/[client_id]/programClick/[program_click_id] HTTP Method: GET Cache Lifetime: 5 Minutes API Rate: 10 points per call Required Parameters: Field program_click_id Data Type integer Limit/Size Values valid program click ID
260
<?xml version="1.0" encoding="utf-8"?> <programClick xmlns="http://www.digitalriver.com/directtrack/api/programClick/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" location="http://[client_domain]/apifleet/rest/[client_id]/programCl ick/1471703"> <numClicks>4</numClicks> <affiliateResourceURL location="../affiliate/1"/> <campaignResourceURL location="../campaign/3833"/> <creativeResourceURL location="../creative/16752"/> <creativeDeploymentResourceURL location="../creativeDeployment/0"/> <date>2009-06-04</date> <landingPageID>0</landingPageID> <poolID>0</poolID> <subIDs> <subID1></subID1> <subID2></subID2> <subID3></subID3> <subID4></subID4> <subID5></subID5> </subIDs> </programClick>
Failure Example
The program click address https://[client_domain]/apifleet/rest/[client_id]/programClick/[program_click_id] is not valid.
261
Detailed Clicks
Add Detailed Clicks
API Name: createClickDetail Description: Creates a new detailed click REST URL: https://[client_domain]/apifleet/rest/[client_id]/clickDetail/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field affiliateResourceURL campaignResourceURL creativeResourceURL Data Type anyURI anyURI anyURI Limit/Size Values the relative URL location of the affiliate the relative URL location of the campaign the relative URL location of the creative the relative URL location of the creative deployment
262
Optional Parameters: Field clickDate Data Type string Limit/Size 19 Values date value formatted as YYYY-MM-DD HH:MM:SS Limit/Size 255 255 255 255 255 Default date the API call was made
subIDs
Field subID1 subID2 subID3 subID4 subID5 string string string unsigned int unsigned int string
Data Type string string string string string 20 255 255
ip referrer affOptInfo landingPageID poolID userAgent
255
alphanumeric value (URL) alphanumeric value valid landing page ID valid ad pool ID alphanumeric value
Click detail created. https://[client_domain]/apifleet/rest/[client_id]/clickDetail/[click_detail_id]
Failure Example
A campaign resource URL is required when adding a click detail.
263
List Detailed Clicks
API Name: listClickDetail Description: Returns a list of REST resource URLs pointing to click details. The list returned can be filtered campaign and date, affiliate and date, and campaign, affiliate and date by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Detailed Click List Resources List Name Detailed Click by Campaign & Date Detailed Click by Affiliate & Date Detailed Click by Campaign, Affiliate & Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/clickDetail/campaign/[campaign_id]/[yyyy][mm]-[dd]/ /rest/[client_id]/[access_id]/clickDetail/affiliate/[affiliate_id]/[yyyy]-[mm][dd]/ /rest/[client_id]/[access_id]/clickDetail/campaign/[campaign_id]/affiliate/[af filiate_id]/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call Clicks by Date For a Current Day Day in the Current Month Day in the Previous Month Day in a Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Week 1 Month
264
Field
Data Type
Limit/Size
Values
Default
Metadata: Field metaData1 metaData2 metaData3 Values Campaign ID Affiliate ID Creative ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location=" http://[client_domain]/apifleet/rest/[client_id]/clickDetail/"> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/clickDetail/[click_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/clickDetail/[click_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/clickDetail/[click_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] /> </resourceList>
Failure Example
The list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/clickDetail/campaign/[campaign_id]/[y yyy]-[mm]-[dd]/ does not exist.
265
View Detailed Click
API Name: getClickDetail Description: Gets details for a specific detailed click REST URL: https://[client_domain]/apifleet/rest/[client_id]/clickDetail/[click_detail_id] HTTP Method: GET Cache Lifetime: 1 Year API Rate: 10 points per call Required Parameters: Field click_detail_id Data Type integer Limit/Size Values valid click detail ID
266
<?xml version="1.0" encoding="utf-8"?> <clickDetail xmlns="http://www.digitalriver.com/directtrack/api/clickDetail/[vers ion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" location="http://[client_domain]/apifleet/rest/[client_id]/clickDeta il/3131"> <affiliateResourceURL location="../affiliate/1"/> <campaignResourceURL location="../campaign/33"/> <creativeResourceURL location="../creative/14006"/> <creativeDeploymentResourceURL location="../creativeDeployment/0"/> <clickDate>2008-02-11 16:38:15</clickDate> <ip>192.168.37.126</ip> <referrer></referrer> <landingPageID>0</landingPageID> <poolID>0</poolID> <userAgent>Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.12) Gecko/20080201 Firefox/2.0.0.12</userAgent> <subIDs> <subID1>h5wny9k8a3o5h380mpwn1ysfn5tchxzyn5trr6</subID1> <subID2>zh59thdohgm1tqbpsue3jjiwt</subID2> <subID3>i37rph6ty4elihhtnjx</subID3> <subID4>0</subID4> <subID5>0</subID5> </subIDs> </clickDetail>
Failure Example
The click detail address https://[client_domain]/apifleet/rest/[client_id]/clickDetail/[click_detail_id] is not valid.
267
Program Leads
Add Program Leads
API Name: createProgramLead Description: Creates a new program lead instance REST URL: https://[client_domain]/apifleet/rest/[client_id]/programLead/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field numLeads Data Type integer Limit/Size 1-100 Values the number of leads to credit to the system
Optional Parameters: Field cookieID Data Type string Limit/Size 32 Values the exact cookie value to associate the lead to (overwrites all other parameters below) the relative URL location of the affiliate the relative URL location of the campaign the relative URL location of the creative the relative URL location of the creative deployment Default
affiliateResourceURL campaignResourceURL
anyURI anyURI
creativeResourceURL
anyURI
creativeDeploymentResource URL
anyURI
268
Field date
Data Type string
Limit/Size 19
Values date value formatted as YYYY-MM-DD HH:MM:SS Limit/Size 200 200 200 200 200
Default date the API call was made
subIDs
Field subID1 subID2 subID3 subID4 subID5 unsigned int unsigned int
landingPageID poolID
Program lead created. https://[client_domain]/apifleet/rest/[client_id]/programLead/[program_lead_id]
Failure Example
The attribute numLeads is required when adding a program lead.
269
Edit Program Leads
API Name: editProgramLead Description: Edits an existing program lead instance REST URL: https://[client_domain]/apifleet/rest/[client_id]/programLead/[program_lead_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field program_lead_id Data Type integer Limit/Size Values valid program lead ID
Optional Parameters: Field numLeads Data Type integer Limit/Size 1-100 Values the number of leads to credit to the system Limit/Size 200 200 200 200 200 Default
subIDs
Field subID1 subID2 subID3 subID4 subID5
270
Program lead updated - [program_lead_id]
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/programLead/[program_lead_id]
271
List Program Leads
API Name: listProgramLead Description: Returns a list of REST resource URLs pointing to program lead instances. The list returned can be filtered by campaign and date, affiliate and date, or campaign, affiliate and date by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Program Lead List Resources List Name Program Leads by Campaign & Date Program Leads by Affiliate & Date Program Leads by Campaign, Affiliate & Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/programLead/campaign/[campaign_id]/[ yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/programLead/affiliate/[affiliate_id]/[yyyy] -[mm]-[dd]/ /rest/[client_id]/[access_id]/programLead/campaign/[campaign_id]/a ffiliate/[affiliate_id]/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call Program Leads by Date For a Current Day Day in the Current Month Day in the Previous Month Day in a Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Week 1 Month
272
Metadata: Field metaData1 metaData2 metaData3 Values Date Affiliate ID Campaign ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programleads/"> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programleads/[lead_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programleads/[lead_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/programleads/[lead_id]" metadata1=[date] metadata2=[affiliate_id] metadata3=[campaign_id] /> </resourceList>
Failure Example
The request list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/programLead/affiliate/[affiliate_id]/[yy yy]-[mm]-[dd]/ does not exist.
273
View Program Leads
API Name: getProgramLead Description: Gets details for a specific program lead instance REST URL: https://[client_domain]/apifleet/rest/[client_id]/programLead/[program_lead_id] HTTP Method: GET Cache Lifetime: 5 Minutes API Rate: 10 points per call Required Parameters: Field program_lead_id Data Type integer Limit/Size Values valid program lead ID
274
<?xml version="1.0" encoding="utf-8"?> <programLead xmlns="http://www.digitalriver.com/directtrack/api/programLead/[vers ion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/prog ramLead/[version_id] programLead.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/programLe ad/724"> <numLeads>1</numLeads> <cookieID/> <affiliateResourceURL location="../affiliate/2"/> <campaignResourceURL location="../campaign/3"/> <creativeResourceURL location="../creative/10"/> <creativeDeploymentResourceURL location="../creativeDeployment/63809"/> <date>2009-05-22</date> <landingPageID>0</landingPageID> <poolID>0</poolID> <theyGet>1.00</theyGet> <weGet>1.50</weGet> </programLead>
Failure Example
The program lead address https://[client_domain]/apifleet/rest/[client_id]/programLead/[program_lead_id] is not valid.
275
Detailed Leads
Add Detailed Leads
API Name: createLeadDetail Description: Creates a new detailed lead REST URL: https://[client_domain]/apifleet/rest/[client_id]/leadDetail/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field Data Type Limit/Size Values
Optional Parameters: Field cookieID Data Type string Limit/Size 32 Values the exact cookie value to associate the lead to (overwrites all other parameters below) the relative URL location of the affiliate the relative URL location of the campaign the relative URL location of the creative the relative URL location of the creative deployment Default
affiliateResourceURL
anyURI
campaignResourceURL
anyURI
creativeResourceURL
anyURI
creativeDeploymentResource URL
anyURI
276
Field date
Data Type string
Limit/Size 19
Values date value formatted as YYYY-MM-DD HH:MM:SS Limit/Size 200 200 200 200 200
Default date the API call was made
subIDs
Field subID1 subID2 subID3 subID4 subID5 string anyURI string string unsignedInt unsignedInt 20
ipAddress referrerURL affOptInfo advOptInfo landingPageID poolID
2000 2000
ip address alphanumeric value (URL) alphanumeric value alphanumeric value valid landing page ID valid ad pool ID
Lead detail created. https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id]
Failure Example
A campaign resource URL is required when adding a lead detail.
277
Edit Detailed Leads
API Name: editLeadDetail Description: Edits an existing detailed lead REST URL: https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field lead_detail_id Data Type integer Limit/Size Values valid lead detail ID
Optional Parameters: Field affiliateResourceURL Data Type anyURI Limit/Size Values the relative URL location of the affiliate the relative URL location of the creative the relative URL location of the creative deployment Default
creativeResourceURL
anyURI
278
Lead detail updated - [lead_detail_id]
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id]
279
Remove Detailed Leads
API Name: removeLeadDetail Description: Removes an existing detailed lead REST URL: https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field lead_detail_id Data Type integer Limit/Size Values valid lead detail ID
Lead detail deleted.
Failure Example
The lead detail address https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id] is not valid.
280
List Detailed Leads
API Name: listLeadDetail Description: Returns a list of REST resource URLs pointing to lead details. The list returned can be filtered by campaign and date or campaign, affiliate, and date by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Detailed Lead List Resources List Name Detailed Leads by Campaign & Date Detailed Leads by Campaign, Affiliate & Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/leadDetail/campaign/[campaign_id]/[yyyy][mm]-[dd]/ /rest/[client_id]/[access_id]/leadDetail/campaign/[campaign_id]/affiliate/[ affiliate_id]/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call Detailed Leads by Date For a Current Day Day in the Current Month Day in the Previous Month Day in a Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Week 1 Month
281
Metadata: Field metaData1 metaData2 metaData3 Values Campaign ID Affiliate ID Creative ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location=" http://[client_domain]/apifleet/rest/[client_id]/leadDetail/"> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/leaddetails/[lead_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/leaddetails/[lead_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/leaddetails/[lead_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] /> </resourceList>
Failure Example
The request list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/leadDetail/campaign/[campaign_id]/aff iliate/[affiliate_id]/[yyyy]-[mm]-[dd]/ does not exist.
282
View Detailed Leads
API Name: getLeadDetail Description: Gets details for a specific detailed lead REST URL: https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id] HTTP Method: GET Cache Lifetime: 1 Year API Rate: 10 points per call Required Parameters: Field lead_detail_id Data Type integer Limit/Size Values valid lead detail ID
283
<?xml version="1.0" encoding="utf-8"?> <leadDetail xmlns="http://www.digitalriver.com/directtrack/api/leadDetail/[versi on_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/lead Detail/[version_id] leadDetail.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/leadDetai l/317"> <cookieID>e4397224628f286aa9cb66a760b54bfd</cookieID> <affiliateResourceURL location="../affiliate/1"/> <campaignResourceURL location="../campaign/104"/> <creativeResourceURL location="../creative/13252"/> <creativeDeploymentResourceURL location=""/> <date>2009-06-04 00:00:00</date> <ipAddress>172.16.5.59</ipAddress> <refererURL/> <affOptInfo/> <advOptInfo/> <landingPageID>0</landingPageID> <poolID>0</poolID> </leadDetail>
Failure Example
The lead detail address https://[client_domain]/apifleet/rest/[client_id]/leadDetail/[lead_detail_id] is not valid.
284
Detailed Sales
Add Detailed Sales
API Name: createSaleDetail Description: Creates a new detailed sale. Once the API call is made, the sale will be queued for creation within DirectTrack, a process that could take several minutes. To retrieve information about the created sale, it is best to call listSaleDetail for the date of the newly entered sale. This will return a resource URL for the sale. REST URL: https://[client_domain]/apifleet/rest/[client_id]/saleDetail/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field transactionId lineItems Field quantity productID owned Data Type string Limit/Size 100 Attributes Data Type Limit/Size unsignedInt string booleanInt Values alphanumeric value that is unique to the campaign Values
1 0
Optional Parameters: Field cookieID* Data Type string Limit/Size 32 Values the exact cookie value to associate to which the sale should be associated Default
285
Field affiliateResourceURL*
Data Type anyURI
Limit/Size
campaignResourceURL*
anyURI
creativeResourceURL
anyURI
date
string
19
Values the relative URL location of the affiliate the relative URL location of the campaign the relative URL location of the creative the relative URL location of the creative deployment date value formatted as YYYY-MM-DD HH:MM:SS
Default
date the API call was made
subIDs
Field subID1 subID2 subID3 subID4 subID5 string string string
Data Type string string string string string 255 242 19
Limit/Size 200 200 200 200 200
saleStatus saleRep statusDate
date value formatted as YYYY-MM-DD HH:MM:SS alphanumeric value valid landing page ID valid ad pool ID 1 0 based on platforms setup by the client
ipAddress advOptInfo landingPageID poolID isSubSale currency platform
string string unsignedInt unsignedInt booleanInt string string
20 2000
50 15
286
Field siteID
Data Type string
Limit/Size 50
Values based on the site ID for a given advertiser associated to the campaign date value formatted as YYYY-MM-DD HH:MM:SS 1 0 1 0
Default
locale clickDate
string string
5 19
recordLead deleteSale deleteReason deleteDetails saleType
booleanInt booleanInt string string string 50 255
0 0
category product
If neither category or product is passed, the sale is treated as a normal sale
*These items can be passed in combination, but passing at least one combination is always required when adding sales: Responses Success Example Cookie Affiliate/Campaign Cookie/Affiliate/Campaign
Sale Detail has been queued for processing and will be available shortly.
Failure Example
An affiliate resource URL is required when adding a sale detail.
287
Edit Detailed Sales
API Name: editSaleDetail Description: Edits an existing detailed sale REST URL: https://[client_domain]/apifleet/rest/[client_id]/saleDetail/[sale_detail_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field sale_detail_id Data Type integer Limit/Size Values valid sale detail id
Optional Parameters: Field affiliateResourceURL Data Type anyURI Limit/Size Values the relative URL location of the affiliate the relative URL location of the creative date value formatted as YYYY-MM-DD HH:MM:SS Default
creativeResourceURL
anyURI
date
string
19
date the API call was made
saleRep ipAddress advOptInfo isSubSale deleteSale deleteReason deleteDetails
string string string booleanInt booleanInt string string
242 20 2000
alphanumeric value 1 0 1 0
0 0
50 255
288
Sale detail updated [sale_detail_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/saleDetail/[sale_detail_id]
289
List Detailed Sales
API Name: listSaleDetail Description: Returns a list of REST resource URLs pointing to sale details. The list returned can be filtered by campaign and date, affiliate and date, or campaign, affiliate and date by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Detailed Sale List Resources List Name Detailed Sales by Campaign & Date Detailed Sales by Affiliate & Date Detailed Sales by Campaign, Affiliate & Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/saleDetail/campaign/[campaign_id]/[yyy y]-[mm]-[dd]/ /rest/[client_id]/[access_id]/saleDetail/affiliate/[affiliate_id]/[yyyy][mm]-[dd]/ /rest/[client_id]/[access_id]/saleDetail/campaign/[campaign_id]/affili ate/[affiliate_id]/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call Detailed Sales by Date For a Current Day Day in the Current Month Day in the Previous Month Day in a Month Prior to 60 Days Lifetime 15 Minutes 1 Day 1 Week 1 Month
290
Metadata: Field metaData1 metaData2 metaData3 metaData4 Values Date Affiliate ID Campaign ID Transaction ID
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location=" http://[client_domain]/apifleet/rest/[client_id]/saledetails/"> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/saledetails/[sale_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] metadata4=[transactionID] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/saledetails/[sale_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] metadata4=[transactionID] /> <resourceURL location=" http://[client_id].directtrack. com/apifleet/rest/[client_id]/saledetails/[sale_id]" metadata1=[campaign_id] metadata2=[affiliate_id] metadata3=[creative_id] metadata4=[transactionID] /> </resourceList>
Failure Example
The list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/saleDetail/campaign/[campaign_id]/[yy yy]-[mm]-[dd]/ does not exist.
291
View Detailed Sales
API Name: getSaleDetail Description: Gets details for a specific detailed sale REST URL: https://[client_domain]/apifleet/rest/[client_id]/saleDetail/[sale_detail_id] HTTP Method: GET Cache Lifetime: 5 Minutes API Rate: 10 points per call Required Parameters: Field sale_detail_id Data Type integer Limit/Size Values valid sale detail id
292
<?xml version="1.0" encoding="utf-8"?> <saleDetail xmlns="http://www.digitalriver.com/directtrack/api/saleDetail/[versi on_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/sale Detail/[version_id] saleDetail.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/saleDetai l/4715"> <transactionID><![CDATA[DT_064-01]]></transactionID> <cookieID/> <affiliateResourceURL location="../affiliate/1"/> <campaignResourceURL location="../campaign/3825"/> <creativeResourceURL location=""/> <creativeDeploymentResourceURL location=""/> <date>2009-08-03 12:42:02</date> <saleRep/> <ipAddress></ipAddress> <advOptInfo/> <landingPageID>0</landingPageID> <poolID>0</poolID> <isSubSale>0</isSubSale> <currency/> <platform><![CDATA[0]]></platform> <siteID/> <locale/> <clickDate></clickDate> <saleType>product</saleType> </saleDetail>
Failure Example
The sale detail address https://[client_domain]/apifleet/rest/[client_id]/saleDetail/[sale_detail_id] is not valid.
293
Edit Sale Line Items
API Name: editSaleLineItem Description: Edits a specific line item within a detailed sale. REST URL: https://[client_domain]/apifleet/rest/[client_id]/saleLineItem/[sale_detail_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field sale_detail_id id Data Type integer integer Limit/Size Values valid sale detail id the ID of the line item to be updated
Optional Parameters: Field saleAmount Data Type decimal Limit/Size 10 digits, including decimals 255 Values numeric value Default
saleStatus
string
statusDate
string
19
affiliateResourceURL
anyURI
productID owned
string booleanInt
50
alphanumeric 0, if the Sale Status module value is not activated in the DirectTrack account. date value the date the call was made formatted as YYYY-MM-DD HH:MM:SS alphanumeric value (relative URL) alphanumeric value 1 0 0
294
Sale line item updated [sale_detail_id].
Failure Example
The sale line item address https://[client_domain]/apifleet/rest/[client_id]/saleLineItem/[sale_detail_id] is not valid.
295
View Sale Line Items
API Name: getSaleLineItem Description: Gets details for all line items within a detailed sale. REST URL: https://[client_domain]/apifleet/rest/[client_id]/saleLineItem/[sale_detail_id] HTTP Method: GET Cache Lifetime: 5 Minutes API Rate: 10 points per call Required Parameters: Field sale_detail_id Data Type integer Limit/Size Values valid sale detail id
296
<?xml version="1.0" encoding="utf-8"?> <saleLineItem xmlns="http://www.digitalriver.com/directtrack/api/saleLineItem/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/sale LineItem/[version_id] saleLineItem.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/saleLineI tem/4715"> <lineItem id="2"> <saleAmount>12.34</saleAmount> <saleStatus>Sale Approved</saleStatus> <statusDate>2008-04-04 00:00:00</statusDate> <affiliateResourceURL location="../affiliate/1"/> <productID>Product 1</productID> <owned>0</owned> <theyGet>1.23</theyGet> <weGet>2.47</weGet> </lineItem> <lineItem id="4"> <saleAmount>12.34</saleAmount> <saleStatus>Sale Approved</saleStatus> <statusDate>2008-04-04 00:00:00</statusDate> <affiliateResourceURL location="../affiliate/1"/> <productID>Product 1</productID> <owned>0</owned> <theyGet>1.23</theyGet> <weGet>2.47</weGet> </lineItem> </saleLineItem>
Failure Example
The sale line item address https://[client_domain]/apifleet/rest/[client_id]/saleLineItem/[sale_detail_id] is not valid.
297
Reporting
Campaign Statistics
API Name: getCampaignStatistics Description: Returns statistics for a specified campaign and date in the format you choose. The statistics returned can include a data summed on a daily or monthly basis as well as broken out by affiliate for a specified day by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Campaign Statistics Resources List Name Daily Campaign Statistics by Day Daily Campaign Statistics by Month Cumulative (Monthly) Campaign Statistics Daily Campaign Statistics by Affiliate Monthly Campaign Statistics by Affiliate REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statCampaign/daily/campaign/[campaign_id]/[ yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statCampaign/daily/campaign/[campaign_id]/[ yyyy]-[mm]/ /rest/[client_id]/[access_id]/statCampaign/cumulative/campaign/[campaign _id]/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/statCampaign/affiliate/campaign/[campaign_id ]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statCampaign/affiliate/campaign/[campaign_id ]/[yyyy]-[mm]/
HTTP Method: GET
298
Cache Lifetimes: API Call Cumulative (Monthly) Campaign Statistics Daily Campaign Statistics by Day Daily Campaign Statistics by Affiliate Daily Campaign Statistics by Month Monthly Campaign Statistics by Affiliate For a Date Within the Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Week 1 Year 5 Minutes 1 1 0 1 1 Week Year (Not Cached) Week Year
API Rate: 10 points per call Required Parameters: Field Data Type Limit/Size Values
299
<?xml version="1.0" encoding="utf-8"?> <stats xmlns="http://www.digitalriver.com/directtrack/api/stats/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat s/[version_id] stats.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/[access_i d]/statCampaignCumulative/campaign/[campaign_id]/[yyyy]-[mm]"> <resource location="2008-01-01" resourceType="cumulative"> <impressions>0</impressions> <contextualImpressions>0</contextualImpressions> <clicks>0</clicks> <clickthru>0</clickthru> <leads>0</leads> <signups>0</signups> <numSales>0</numSales> <saleAmount>0</saleAmount> <numSubSales>0</numSubSales> <subSaleAmount>0</subSaleAmount> <weGet>0</weGet> <theyGet>0</theyGet> <revenue>0</revenue> <epc>0</epc> </resource>
Failure Example
The campaign statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statCampaign/daily/campaign/[campai gn_id]/[yyyy]-[mm]-[dd]/ does not exist.
300
Affiliate Statistics
API Name: getAffiliateStatistics Description: Returns statistics for a specified affiliate and date in the format you choose. The statistics returned can include a data summed on a daily or monthly basis as well as broken out by campaign for a specified day by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Affiliate Statistics Resources List Name Daily Affiliate Statistics by Day Daily Affiliate Statistics by Month Cumulative (Monthly) Affiliate Statistics Daily Affiliate Statistics by Campaign Monthly Affiliate Statistics by Campaign REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statAffiliate/daily/affiliate/[affiliate_id]/[yyy y]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statAffiliate/daily/affiliate/[affiliate_id]/[yyy y]-[mm]/ /rest/[client_id]/[access_id]/statAffiliate/cumulative/affiliate/[affiliate_i d]/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/statAffiliate/campaign/affiliate/[affiliate_id] /[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statAffiliate/campaign/affiliate/[affiliate_id] /[yyyy]-[mm]/
HTTP Method: GET Cache Lifetimes: API Call Cumulative (Monthly) Affiliate Statistics Daily Affiliate Statistics by Day Daily Affiliate Statistics by Campaign Daily Affiliate Statistics by Month Monthly Affiliate Statistics by Campaign For a Date Within the Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Week 1 Year 5 Minutes 1 1 0 1 1 Week Year (Not Cached) Week Year
301
302
<?xml version="1.0" encoding="utf-8"?> <stats xmlns="http://www.digitalriver.com/directtrack/api/stats/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat s/[version_id] stats.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_ id]/statAffiliate/daily/affiliate/[affiliate_id]/[yyyy]-[mm]-[dd]/"> <resource location="2008-01-01"> <impressions>0</impressions> <contextualImpressions>0</contextualImpressions> <clicks>0</clicks> <clickthru>0</clickthru> <leads>0</leads> <signups>0</signups> <numSales>0</numSales> <saleAmount>0</saleAmount> <numSubSales>0</numSubSales> <subSaleAmount>0</subSaleAmount> <weGet>0</weGet> <theyGet>0</theyGet> <revenue>0</revenue> <epc>0</epc> </resource>
Failure Example
The affiliate statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statAffiliate/cumulative/affiliate/[affilia te_id]/[yyyy]-[mm]/ does not exist.
303
Super Affiliate Statistics
API Name: getSuperAffiliateStatistics Description: Returns statistics for a specified super affiliate and date in the format you choose. The statistics returned can include a data summed on a daily or monthly basis as well as broken out by subaffiliate for a specified day by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Super Affiliate Statistics Resources List Name Daily Super Affiliate Statistics by Day Daily Super Affiliate Statistics by Month Cumulative (Monthly) Super Affiliate Statistics Daily Sub-Affiliate Statistics Monthly Sub-Affiliate Statistics REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statSuperAffiliate/daily/affiliate/[affiliate_id]/ [yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statSuperAffiliate/daily/affiliate/[affiliate_id]/ [yyyy]-[mm]/ /rest/[client_id]/[access_id]/statSuperAffiliate/cumulative/affiliate/[affilia te_id]/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/statSuperAffiliate/sub/affiliate/[affiliate_id]/[ yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statSuperAffiliate/sub/affiliate/[affiliate_id]/[ yyyy]-[mm]/
HTTP Method: GET Cache Lifetimes: API Call Cumulative (Monthly) Super Affiliate Statistics Daily Super Affiliate Statistics by Day Daily Sub-Affiliate Statistics Daily Super Affiliate Statistics by Month Monthly Sub-Affiliate Statistics For a Date Within the Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Week 1 Year 5 Minutes 1 1 0 1 1 Week Year (Not Cached) Week Year
304
305
Responses XML Example Daily Stats by Month
<?xml version="1.0" encoding="utf-8"?> <statSuperAffiliate xmlns="http://www.digitalriver.com/directtrack/api/statSuperAffiliat e/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat SuperAffiliate/v1_0 statSuperAffiliate.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_ id]/statSuperAffiliate/daily/affiliate/[affiliate_id]/[yyyy]-[mm]"> <company><![CDATA[Sample Company]]></company> <numReferrals>37</numReferrals> <approvedReferrals>37</approvedReferrals> <commissionPaid>0.00</commissionPaid> <commissionPending>180.40</commissionPending> <resource date="2000-11-04"> <commissionPending>15.80</commissionPending> </resource> <resource date="2000-11-30"> <commissionPending>47.00</commissionPending> </resource> <resource date="2000-11-16"> <commissionPending>16.40</commissionPending> </resource> <resource date="2000-11-12"> <commissionPending>69.00</commissionPending> </resource> <resource date="2000-11-15"> <commissionPending>32.20</commissionPending> </resource> </statSuperAffiliate>
306
XML Example Cumulative Stats by Month
<?xml version="1.0" encoding="utf-8"?> <statSuperAffiliate xmlns=http://www.digitalriver.com/directtrack/api/statSuperAffiliate /[version_id] xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat SuperAffiliate/[version_id] statSuperAffiliate.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_ id]/statSuperAffiliate/cumulative/affiliate/[affiliate_id]/[yyyy][mm]/"> <company><![CDATA[Sample Company]]></company> <numReferrals>37</numReferrals> <approvedReferrals>37</approvedReferrals> <commissionPaid>0.00</commissionPaid> <commissionPending>180.40</commissionPending> <currency>USD</currency> </statSuperAffiliate>
307
XML Example Sub Affiliate Stats by Month
<?xml version="1.0" encoding="utf-8"?> <statSuperAffiliate xmlns="http://www.digitalriver.com/directtrack/api/statSuperAffiliat e/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat SuperAffiliate/[version_id] statSuperAffiliate.xsd" location="https://[client_domain/apifleet/rest/[client_id]/[access_i d]/statSuperAffiliate/sub/affiliate/[affiliate_id]/[yyyy]-[mm]/"> <resource date="2000-11"> <company><![CDATA[Sample Sub Affiliate 1]]></company> <subAffiliateResourceURL location="../../../../../affiliate/13" /> <payoutPending>79.00</payoutPending> <commissionPending>15.80</commissionPending> <currency>USD</currency> </resource> <resource date="2000-11"> <company><![CDATA[Sample Sub Affiliate 2]]></company> <subAffiliateResourceURL location="../../../../../affiliate/15" /> <payoutPending>235.00</payoutPending> <commissionPending>47.00</commissionPending> <currency>USD</currency> </resource> <resource date="2000-11"> <company><![CDATA[Sample Sub Affiliate 3]]></company> <subAffiliateResourceURL location="../../../../../affiliate/31" /> <payoutPending>82.00</payoutPending> <commissionPending>16.40</commissionPending> <currency>USD</currency> </resource> </statSuperAffiliate> Failure Example
The super affiliate statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statSuperAffiliate/cumulative/affiliate/[ affiliate_id]/[yyyy]-[mm]/ does not exist.
308
Creative Statistics
API Name: getCreativeStatistics Description: Returns statistics for a specified creative and date in the format you choose. The statistics returned can include a data summed on a daily or monthly basis as well as broken out by affiliate for a specified day by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Creative Statistics Resources List Name Daily Creative Statistics by Day Daily Creative Statistics by Month Cumulative (Monthly) Creative Statistics Daily Creative Statistics by Affiliate Monthly Creative Statistics by Affiliate REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statCreative/daily/creative/[creative_id]/[yy yy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statCreative/daily/creative/[creative_id]/[yy yy]-[mm]/ /rest/[client_id]/[access_id]/statCreative/cumulative/creative/[creative_i d]/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/statCreative/affiliate/creative/[creative_id]/ [yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statCreative/affiliate/creative/[creative_id]/ [yyyy]-[mm]/
HTTP Method: GET Cache Lifetimes: API Call Cumulative (Monthly) Creative Statistics Daily Creative Statistics by Day Daily Creative Statistics by Affiliate Daily Creative Statistics by Month Monthly Creative Statistics by Affiliate For a Date Within the Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Week 1 Year 5 Minutes 1 1 0 1 1 Week Year (Not Cached) Week Year
309

<?xml version="1.0" encoding="utf-8"?> <stats xmlns="http://www.digitalriver.com/directtrack/api/stats/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stats/[version_id] stats.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statCreativ e/cumulative/creative/[creative_id]/[yyyy]-[mm]/"> <resource location="2008-01-01"> <impressions>0</impressions> <contextualImpressions>0</contextualImpressions> <clicks>0</clicks> <clickthru>0</clickthru> <leads>0</leads> <signups>0</signups> <numSales>0</numSales> <saleAmount>0</saleAmount> <numSubSales>0</numSubSales> <subSaleAmount>0</subSaleAmount> <weGet>0</weGet> <theyGet>0</theyGet> <revenue>0</revenue> <epc>0</epc> </resource>
Failure Example
The creative statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statCreative/cumulative/creative/[creative_id]/[y yyy]-[mm]/ does not exist.
310
Creative Deployment Statistics
API Name: getCreativeDeploymentStatistics Description: Returns statistics for a specified creative deployment and date in the format you choose. The statistics returned can include a data summed on a daily or monthly basis as well as broken out by affiliate for a specified day by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Creative Deployment Statistics Resources List Name Daily Creative Deployment Statistics by Affiliate Monthly Creative Deployment Statistics by Affiliate REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statCreativeDeployment/affiliate/creativeDeployme nt/[creative_deployment_id]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statCreativeDeployment/affiliate/creativeDeployme nt/[creative_deployment_id]/[yyyy]-[mm]/
HTTP Method: GET Cache Lifetimes: API Call Daily Creative Deployment Statistics Statistics by Affiliate Monthly Creative Deployment Statistics Statistics by Affiliate For a Date Within the Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Week 1 Year 0 (Not Cached) 1 Week 1 Year
311
<?xml version="1.0" encoding="utf-8"?> <stats xmlns="http://www.digitalriver.com/directtrack/api/stats/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stats/[ver sion_id] stats.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/st atCreativeDeployment/affiliate/creativeDeployment/[creative_deployment_id] /[yyyy]-[mm]/"> <resource location="2008-01-01"> <impressions>0</impressions> <contextualImpressions>0</contextualImpressions> <clicks>0</clicks> <clickthru>0</clickthru> <leads>0</leads> <signups>0</signups> <numSales>0</numSales> <saleAmount>0</saleAmount> <numSubSales>0</numSubSales> <subSaleAmount>0</subSaleAmount> <weGet>0</weGet> <theyGet>0</theyGet> <revenue>0</revenue> <epc>0</epc> </resource>
Failure Example
The creative deployment statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statCreativeDeployment/affiliate/creati veDeployment/[creative_deployment_id]/[yyyy]-[mm]/ does not exist.
312
Product Statistics
API Name: getProductStatistics Description: Returns statistics for a specified product and date using a creative ID in the format you choose. The statistics returned can include a data summed on a daily or monthly basis as well as broken out by affiliate for a specified day or month by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Product Statistics Resources List Name Daily Product Statistics by Day Daily Product Statistics by Month Cumulative (Monthly) Product Statistics Daily Product Statistics by Affiliate Monthly Product Statistics by Affiliate REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statProduct/daily/creative/[creative_id]/[yy yy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statProduct/daily/creative/[creative_id]/[yy yy]-[mm]/ /rest/[client_id]/[access_id]/statProduct/cumulative/creative/[creative_i d]/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/statProduct/affiliate/creative/[creative_id]/[ yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statProduct/affiliate/creative/[creative_id]/[ yyyy]-[mm]/
HTTP Method: GET Cache Lifetimes: API Call Cumulative (Monthly) Product Statistics Daily Product Statistics by Day Daily Product Statistics by Affiliate Daily Product Statistics by Month Monthly Product Statistics by Affiliate For a Date Within the Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Week 1 Year 5 Minutes 1 1 0 1 1 Week Year (Not Cached) Week Year
313
<?xml version="1.0" encoding="utf-8"?> <statProduct xmlns="http://www.digitalriver.com/directtrack/api/statProduct/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/statProduc t/[version_id] statProduct.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/[access_id]/st atProduct/cumulative/creative/[creative_id]/2008-05"> <resource date="2008-05"> <productID> <![CDATA[Test_Product]]> </productID> <numSales>3</numSales> <quantity>0</quantity> <price>239.85</price> <payout>86.35</payout> </resource> </statProduct>
Failure Example
The product statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statProduct/cumulative/creative/[creat ive_id]/[yyyy]-[mm]/ does not exist.
314
Optional Info Statistics
API Name: getOptInfoStatistics Description: Returns statistics for specified optional information (info_id) pertaining to Imported Leads, Leads or Sales by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Optional Info Statistics Resources List Name Optional Info Statistics for Imported Leads Optional Info Statistics for Leads Optional Info Statistics for Sales REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/optInfo/imported/[info_id]/ /rest/[client_id]/[access_id]/optInfo/leads/[info_id]/ /rest/[client_id]/[access_id]/optInfo/sales/[info_id]/
HTTP Method: GET Cache Lifetime: 1 Day Cache Lifetimes: API Call All Optional Info Statistics Calls Lifetime 1 Day
315
<?xml version="1.0" encoding="utf-8"?> <optInfo xmlns="http://www.digitalriver.com/directtrack/api/optInfo/[version_ id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/optI nfo/v1_0 optInfo.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/optInfo/ leads/[info_id]"> <date>2009-07-28</date> <campaignResourceURL location="../../campaign/25"/> <info> <![CDATA[opt_info]]> </info> <commission>4.00</commission> </optInfo>
Failure Example
The optional info statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/optInfo/sales/[info_id]/ does not exist.
316
Click Referral Statistics
API Name: getClickReferralStatistics Description: Returns click referral statistics for a specified date and combination of campaign, domain, and affiliate by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Click Referral Statistics Resources List Name
By Campaign and Day By Campaign, Affiliate and Day By Domain and Day By Domain, Affiliate and Day
REST URL (Preceded by https://[client_domain]/apifleet)

/rest/[client_id]/statClickReferral/campaign/[campaign_id]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/statClickReferral/campaign/[campaign_id]/affiliate/[affiliate_id]/ [yyyy]-[mm]-[dd]/ /rest/[client_id]/statClickReferral/domain/[domain]/[yyyy]-[mm]-[dd]/ /rest/[client_id]/statClickReferral/domain/[domain]/affiliate/[affiliate_id]/[yyyy][mm]-[dd]/
HTTP Method: GET Cache Lifetimes: API Call All Click Referral Stats calls For a Date Within the Current Day Current Month Previous Month Month Prior to 60 Days Lifetime 0 (Never Cached) 1 Day 1 Month 1 Year
API Rate: 10 points per call
317
<statClickReferral xmlns="http://www.digitalriver.com/directtrack/api/statClickReferral /[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" location="https://[client_domain]/apifleet/rest/client]/statClickRef erral/daily/campaign/[campaign_id]/[yyyy]-[mm]-[dd]/"> <numClicks>2</numClicks> <numDomains>1</numDomains> <numIPs>1</numIPs> <numCampaigns>1</numCampaigns> <numAffiliates>1</numAffiliates> <numLeads>1</numLeads> <numSales>1</numSales> <revenue>0</revenue> </statClickReferral>
Failure Example
The click referral statistics list at https://[client_domain]/apifleet/rest/[client_id]/statClickReferral/domain/[domain]/[yyyy]-[mm][dd]/ does not exist.
318
View Click Referral Details
API Name: getClickReferralDetail Description: Returns details click referral information for a specified click referral ID. REST URL: http://[client_domain]/apifleet/rest/[client_id]/clickReferral/[click_referral_id] HTTP Method: GET Cache Lifetime: 1 year API Rate: 10 points per call Required Parameters: Field click_referral_id Data Type Limit/Size Values
319
<?xml version="1.0" encoding="utf-8"?> <clickReferral xmlns="http://www.digitalriver.com/directtrack/api/clickReferral/[ve rsion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat s/[version_id] stats.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/clickRef erral/[click_referral_id]"> <campaignResourceURL location="../campaign/6549"/> <affiliateResourceURL location="../affiliate/67"/> <referringURL> </referringURL> <IP>0.0.0.0</IP> <clickDate>2009-01-01 00:00:00</clickDate> <leads> <lead dateStamp="2009-06-25 18:33:14" revenue="0.00"/> </leads> <sales> <sale dateStamp="2009-06-25 18:33:14" revenue="0.00"/> </sales> </clickReferral>
Failure Example
The click referral resource at https://[client_domain]/apifleet/rest/[client_id]/clickReferral/[click_referral_id] does not exist.
320
Sub ID Statistics
API Name: getSubIDStatistics Description: When a call to getSubIDStatistics is made, the report is queued, and the XML response will confirm this as well as provide the history ID for the request. The API then returns a .csv file containing statistics for a specified affiliate in the format you choose. The statistics returned can include data summed on a daily or monthly basis as well as broken out by keyword or campaign or a combination of both by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Sub ID Statistics Resources List Name
Daily by Day Daily by Month By Keyword and Day By Keyword and Month All Campaigns by Day All Campaigns by Month All Campaigns by Keyword and Day All Campaigns by Keyword and Month By Campaign and Day By Campaign and Month By Campaign, Keyword and Day By Campaign, Keyword and Month
REST URL (Preceded by https://[client_domain]/apifleet)

/rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/subid/[sub_ids]/[yyyy]-[mm]-[dd] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/subid/[sub_ids]/[yyyy]-[mm] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/subid/[sub_ids]/keyword/[keywo rd]/[yyyy]-[mm]-[dd] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/subid/[sub_ids]/keyword/[keywo rd]/[yyyy]-[mm] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/by_campaign/subid/[sub_ids]/[yy yy]-[mm] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/by_campaign/subid/[sub_ids]/[yy yy]-[mm] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/by_campaign/subid/[sub_ids]/ke yword/[keyword]/[yyyy]-[mm]-[dd] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/by_campaign/subid/[sub_ids]/ke yword/[keyword]/[yyyy]-[mm]-[dd] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/campaign/[campaign_id]/subid/[ sub_ids]/[yyyy]-[mm] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/campaign/[campaign_id]/subid/[ sub_ids]/[yyyy]-[mm] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/campaign/[campaign_id]/subid/[ sub_ids]/keyword/[keyword]/[yyyy]-[mm]-[dd] /rest/[client_id]/[access_id]/statSubID/affiliate/[affiliate_id]/campaign/[campaign_id]/subid/[ sub_ids]/keyword/[keyword]/[yyyy]-[mm]
HTTP Method: GET API Rate: 10 points per call
321
<?xml version="1.0" encoding="utf-8"?> <success xmlns="http://www.digitalriver.com/directtrack/api/success/[version_ id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/succ ess/[version_id] success.xsd"> <historyID>61b1112e7a2473a5afb63fbba129dabe</historyID> <message>Queued</message> </success>
Failure Example
The sub ID statistics list at https://[client_domain]/apifleet/rest/[client_id]/statSubID/affiliate/[affiliate_id]/subid/[sub_ids]/[y yyy]-[mm]/ does not exist.
322
List Statistics
API Name: listStatistics Description: Lists dates for which statistics are available for a given report. REST URL: Statistics List Resources List Name Campaign by Month Campaign by Year Affiliate by Month Affiliate by Year Creative by Month Creative by Year Creative Deployments by Month Creative Deployment Statistics by Year Product Statistics by Month Product Statistics by Year Imported Leads Optional Info Leads Optional Info Sales Optional Info Click Referrals by Campaign and Date Click Referrals by Domain and Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statCampaign/campaign/[campaign_id]/[yyyy] -[mm]/ /rest/[client_id]/[access_id]/statCampaign/campaign/[campaign_id]/[yyyy] / /rest/[client_id]/[access_id]/statAffiliate/affiliate/[affiliate_id]/[yyyy][mm]/ /rest/[client_id]/[access_id]/statAffiliate/affiliate/[affiliate_id]/[yyyy]/ /rest/[client_id]/[access_id]/statCreative/creative/[creative_id]/[yyyy][mm]/ /rest/[client_id]/[access_id]/statCreative/creative/[creative_id]/[yyyy]/ /rest/[client_id]/[access_id]/statCreativeDeployment/creativeDeployment/ [creative_deployment_id]/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/statCreativeDeployment/creativeDeployment/ [creative_deployment_id]/[yyyy]/ /rest/[client_id]/[access_id]/statProduct/creative/[creative_id]/[yyyy][mm]/ /rest/[client_id]/[access_id]/statProduct/creative/[creative_id]/[yyyy]/ /rest/[client_id]/[access_id]/optInfo/affiliate/[affiliate_id]/imported/[yyyy] -[mm]-dd]/ /rest/[client_id]/[access_id]/optInfo/affiliate/[affiliate_id]/leads/[yyyy][mm]-dd]/ /rest/[client_id]/[access_id]/optInfo/affiliate/[affiliate_id]/sales/[yyyy][mm]-dd]/ /rest/[client_id]/clickReferral/campaign/[campaign_id]/[yyyy]-[mm]-dd]/ /rest/[client_id]/clickReferral/domain/[domain]/[yyyy]-[mm]-dd]/
HTTP Method: GET
323
Cache Lifetimes: API Call Imported Leads Optional Info Leads Optional Info Sales Optional Info Click Referrals by Campaign and Date Click Referrals by Domain and Date Product Statistics by Month Product Statistics by Year All Others For a Date Within the Current Day Current Month Previous Month Month Prior to 60 Days Current Month Previous Month Month Prior to 60 Days Any Year Any Date Lifetime 15 Minutes 1 1 1 0 1 1 0 15 Day Week Month (Not Cached) Day Month (Not Cached) Minutes
324
Responses XML Example Product Statistics List (All statistics lists will follow this format)
<statistics xmlns="http://www.digitalriver.com/directtrack/api/stats/[version_id ]" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat s/[version_id] statProduct.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/statProdu ct/creative/[creative_id]/[yyyy]/"> <resourceURL>//2009-02</resourceURL> <resourceURL>//2009-03</resourceURL> </statistics>
Failure Example
The statistics list at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statCampaign/campaign/[campaign_id] /[yyyy]-[mm]/ does not exist.
325
Quick Reports
API Name: getQuickReport Description: Gets cumulative statistics for all campaigns, affiliates, creatives or products for a specified time period by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Quick Report Resources List Name Campaign Quick Report Affiliate Quick Report Creative Quick Report Product Quick Report REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/statCampaign/quick/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statAffiliate/quick/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statCreative/quick/[yyyy]-[mm]-[dd]/ /rest/[client_id]/[access_id]/statProduct/quick/[yyyy]-[mm]-[dd]/
HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type Limit/Size Values
326
<stats xmlns="http://www.digitalriver.com/directtrack/api/stats/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/stat s/[version_id] stats.xsd" location="http://[client_domain]/apifleet/rest/[client_id]/[access_i d]/statCampaign/quick/[yyyy]-[mm]-[dd]/"> <resource> <impressions>0</impressions> <contextualImpressions>0</contextualImpressions> <clicks>0</clicks> <clickthru>0</clickthru> <leads>0</leads> <signups>0</signups> <numSales>0</numSales> <saleAmount>0</saleAmount> <numSubSales>0</numSubSales> <subSaleAmount>0</subSaleAmount> <weGet>0</weGet> <theyGet>0</theyGet> <revenue>0</revenue> <epc>0</epc> </resource>
Failure Example
The quick report at https://[client_domain]/apifleet/rest/[client_id]/[access_id]/statCampaign/quick/[yyyy]-[mm]-[dd]/ does not exist.
327
API Reference - CrossPublication

CrossPublished Offers
Add CrossPublished Offer
API Name: createXpubOffer Description: Adds a CrossPublication offer to the CrossPublication Portal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field Data Type parentCompanyResourceURL anyURI campaignResourceURL anyURI Limit/Size Values alphanumeric value (relative URL) alphanumeric value (relative URL)
Optional Parameters: Field publicDisplay shareContact allowChildEditCreatives terms description childCompanyReference impressionPayout clickPayout leadPayout flatSalePayout Data Type booleanInt booleanInt booleanInt string string string double double double double 255 255 255 Limit/Size Values 1 0 1 0 1 0 alphanumeric value alphanumeric value alphanumeric value numeric value numeric value numeric value numeric value Default
328
Field flatSubSalePayout percentSalePayout percentSubSalePayout
Data Type double double double
Limit/Size
Values numeric value numeric value numeric value
Default
CrossPublication offer created. https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]
Failure Example
A parent company resource URL is required when adding a CrossPublication offer.
329
Edit CrossPublished Offer
API Name: editXpubOffer Description: Updates an existing CrossPublication. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field offer_id Data Type string Limit/Size Values alphanumeric value
Optional Parameters: Field publicDisplay shareContact allowChildEditCreatives terms description childCompanyReference impressionPayout clickPayout leadPayout flatSalePayout flatSubSalePayout percentSalePayout percentSubSalePayout Data Type booleanInt booleanInt booleanInt string string string double double double double double double double 255 255 255 Limit/Size Values 1 0 1 0 1 0 alphanumeric value alphanumeric value alphanumeric value numeric value numeric value numeric value numeric value numeric value numeric value numeric value Default
330
The xpub offer has been updated 1.
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]
331
Remove CrossPublished Offer
API Name: removeXpubOffer Description: Removes a CrossPublication from the CrossPublication Portal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field offer_id Data Type string Limit/Size Values alphanumeric value
The xpub offer has been deleted - [offer_id].
Failure Example
The xpub offer address https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id] is not valid.
332
List CrossPublished Offers
API Name: listXpubOffer Description: Returns a list of REST resource URLs pointing to CrossPublished offers. The list returned can include all CrossPublished offers or be filtered by incoming/outgoing offers and country/category by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Other CrossPublication Offer List Resources List Name All CrossPub Offers Incoming CrossPub Offers Outgoing CrossPub Offers CrossPub Offers by Country CrossPub Offers by Campaign Category REST URL (Preceded by https://[client_domain]/apifleet) rest/[client_id]/[access_id]/xpubOffer/ rest/[client_id]/[access_id]/xpubOffer/incoming/ rest/[client_id]/[access_id]/xpubOffer/outgoing/ rest/[client_id]/[access_id]/xpubOffer/country/[country_abbreviation]/ rest/[client_id]/[access_id]/xpubOffer/campaignCategory/[category_id]/
333
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]"/> </resourceList>
Failure Example
The CrossPublished offer list at https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/incoming/ does not exist.
334
View CrossPublished Offer
API Name: getXpubOffer Description: Displays a specified CrossPublication. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field offer_id Data Type string Limit/Size Values alphanumeric value
335
<xpubOffer xmlns="http://www.digitalriver.com/directtrack/api/xpubOffer/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/xpubOffer/ [version_id] xpubOffer.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[off er_id]"> <parentCompanyResourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[xpub_compan y_id]"/> <campaignResourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/campaign/[campaign_id]"/ > <publicDisplay>1</publicDisplay> <shareContact>1</shareContact> <allowChildEditCreatives>0</allowChildEditCreatives> <terms>these are the terms</terms> <description>this is the description</description> <childCompany>child company reference</childCompany> <impressionPayout>0.00</impressionPayout> <clickPayout>0.00</clickPayout> <leadPayout>0.00</leadPayout> <flatSalePayout>0.00</flatSalePayout> <flatSubSalePayout>0.00</flatSubSalePayout> <percentSalePayout>0.00</percentSalePayout> <percentSubSalePayout>0.00</percentSubSalePayout> <requestList>pa</requestList> <location>https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[off er_id]</location> </xpubOffer>
Failure Example
The CrossPublished offer address https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id] is not valid.
336
CrossPublished Companies
List CrossPublished Companies

API Name: listXpubCompany Description: Displays a list of all companies (networks) that have CrossPublished offers via the CrossPublication Portal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/ HTTP Method: GET Cache Lifetime: 1 Day API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
337

<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[x pub_company_id]"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[xpub_compan y_id]"/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[xpub_compan y_id]"/> </resourceList>
Failure Example
The CrossPublication company list at https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/ does not exist.
338
View CrossPublished Company
API Name: getXpubCompany Description: Gets information on a company (network) that has CrossPublished offers via the CrossPublication Portal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[xpub_company_id] HTTP Method: GET Cache Lifetime: 1 Week API Rate: 10 points per call Required Parameters: Field Data Type xpub_company_id string Limit/Size Values alphanumeric value
339
<xpubOffer xmlns="http://www.digitalriver.com/directtrack/api/xpubOffer/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/xpubOffer/ [version_id] xpubOffer.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[x pub_company_id]"> <clientDomain>directleads.com</clientDomain> <companyName>company name</companyName> <primaryContact>primary contact</primaryContact> <location>https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[x pub_company_id]</location> </xpubOffer>
Failure Example
The CrossPublished company address https://[client_domain]/apifleet/rest/[client_id]/xpubCompany/[xpub_company_id] is not valid.
340
CrossPublication Requests
Request Offer Approval
API Name: createXpubRequest Description: Creates a request to a parent network for a child to run a CrossPublished campaign. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]/xpubRequest/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field offer_id childCompanyResourceURL offerResourceURL Data Type string anyURI anyURI Limit/Size Values alphanumeric value alphanumeric value (relative URL) alphanumeric value (relative URL)
Request created. https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]/request/[request_id]
Failure Example
An approval status is required when creating a CrossPublication request.
341
Approve/Deny Offer Request
API Name: editXpubRequest Description: Updates a pending CrossPublication request to approved or denied. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]/request/[request_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field request_id Data Type string Limit/Size Values alphanumeric value
Optional Parameters: Field approvalStatus Data Type booleanInt Limit/Size Values 1 0 Default
The offer request has been updated - [request_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]/request/[request_id]
342
List Offer Requests
API Name: listXpubRequest Description: Returns a list of REST resource URLs pointing to CrossPublication requests. The list returned can include all CrossPublication requests or be filtered by incoming/outgoing requests and request status by requesting the appropriate REST resource URL as shown in the chart below. REST URL: CrossPublication Request List Resources List Name All CrossPublication Requests All Incoming Requests Pending Incoming Requests Approved Incoming Requests Denied Incoming Requests All Outgoing Requests Pending Outgoing Requests Approved Outgoing Requests Denied Outgoing Requests REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/xpubRequest/ /rest/[client_id]/[access_id]/xpubRequest/incoming/ /rest/[client_id]/[access_id]/xpubRequest/incoming/pending/ /rest/[client_id]/[access_id]/xpubRequest/incoming/approved/ /rest/[client_id]/[access_id]/xpubRequest/incoming/denied/ /rest/[client_id]/[access_id]/xpubRequest/outgoing/ /rest/[client_id]/[access_id]/xpubRequest/outgoing/pending/ /rest/[client_id]/[access_id]/xpubRequest/outgoing/approved/ /rest/[client_id]/[access_id]/xpubRequest/outgoing/denied/
343
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/xpubRequest/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubRequest/[request_id] "/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubRequest/[request_id] "/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubRequest/[request_id] "/> </resourceList>
Failure Example
The request list at https://[client_domain]/apifleet/rest/[client_id]/outgoing/approved/ does not exist.
344
View Approval Request
API Name: getXpubRequest Description: Displays a specified CrossPublication child network approval request. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]/request/[request_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field offer_id request_id Data Type string string Limit/Size Values alphanumeric value alphanumeric value
345
<xpubRequest xmlns="http://www.digitalriver.com/directtrack/api/xpubRequest/[version_id ]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/xpubReques t/[version_id] xpubRequest.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[off er_id]/request/[request_id]"> <childCompanyResourceURL>https://[client_domain]/apifleet/rest/[client_id] /xpubCompany/[xpub_company_id]</childCompanyResourceURL> <offerResourceURL>https://[client_domain]/apifleet/rest/[client_id]/xpubOf fer/[offer_id]</offerResourceURL> <approvalStatus>pending</approvalStatus> <location>https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[off er_id]/request/[request_id]</location> </xpubRequest>
Failure Example
The CrossPublication request address https://[client_domain]/apifleet/rest/[client_id]/xpubOffer/[offer_id]/request/[request_id] is not valid.
346
Classifieds Listings
Create a CrossPub Classified Listing
API Name: createXpubClassified Description: Creates a CrossPub Classified bid or proposal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field campaignResourceURL Data Type anyURI Limit/Size *only if the listingType is proposal 50 Values alphanumeric value (relative URL)
listingName listingType listingTitle startDate endDate
string string string string string
50 10 10
alphanumeric value bid proposal alphanumeric value date value formatted as YYYY-MMDD date value formatted as YYYY-MMDD
Optional Parameters: Field listingStatus Data Type string Limit/Size Values Active Inactive Closed Expired Deleted alphanumeric value (relative URL) 50 alphanumeric value 255 alphanumeric value Default
xpubCompanyResourceURL anyURI shortDescription longDescription string string
347
Field impressionPayout clickPayout leadPayout flatSalePayout flatSubSalePayout percentSalePayout percentSubSalePayout allowChildEditCreatives
Data Type double double double double double double double booleanInt
Limit/Size Values
Default
The bidded/proposed payouts
1 0
Classified created. https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classified_id]
Failure Example
A listing title is required when creating a CrossPub Classified.
348
Edit a CrossPub Classified Listing
API Name: editXpubClassified Description: Updates an existing CrossPub Classified bid or proposal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classified_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field classified_id Data Type string Limit/Size Values alphanumeric value passed via the URL
Optional Parameters: Field campaignResourceURL Data Type anyURI Limit/Size *only if the listingType is proposal 50 Values alphanumeric value (relative URL) Default
listingName listingType listingTitle listingStatus
string string string string
50
xpubCompanyResourceURL anyURI startDate string 10
endDate
string
10
alphanumeric value bid proposal alphanumeric value Active Inactive Closed Expired Deleted alphanumeric value (relative URL) date value formatted as YYYYMM-DD date value formatted as YYYYMM-DD
349
Field shortDescription longDescription impressionPayout clickPayout leadPayout flatSalePayout flatSubSalePayout percentSalePayout percentSubSalePayout allowChildEditCreatives
Data Type string string double double double double double double double booleanInt
Limit/Size 50 255
Values alphanumeric value alphanumeric value
Default
The bidded/proposed payouts
1 0
The classified has been updated - [classified_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classified_id]
350
List CrossPub Classifieds
API Name: listXpubClassified Description: Returns a list of REST resource URLs pointing to CrossPub Classified bids and proposals. The list returned can include all CrossPub Classified listings or be filtered by incoming/outgoing listings and listing type (bid/proposal) by requesting the appropriate REST resource URL as shown in the chart below. REST URL: CrossPub Classified List Resources List Name All CrossPub Classifieds All Incoming CrossPub Classifieds All Outgoing CrossPub Classifieds All CrossPub Classifieds Bids All CrossPub Classifieds Proposals REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/xpubClassified/ /rest/[client_id]/xpubClassified/incoming/ /rest/[client_id]/xpubClassified/outgoing/ /rest/[client_id]/xpubClassified/bid/ /rest/[client_id]/xpubClassified/proposal/
351
Metadata: Field metaData1 metaData2 metaData3 Values Title Campaign Name Campaign URL
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classifi ed_id]" metadata1=My CPA Proposal metadata2=CPA Campaign metadata3=www.cpacampaign.com/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classifi ed_id]" metadata1=My Bid Weight Loss metadata2=Lose Weight Now! metadata3=www.loselbsfast.com/> </resourceList>
Failure Example
The classifieds list at https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/outgoing/ does not exist.
352
View a CrossPub Classified
API Name: getXpubClassifiedDetail Description: Displays a specified CrossPub Classified bid or proposal. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classified_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field classified_id Data Type string Limit/Size Values alphanumeric value, passed via the URL
353
<?xml version="1.0" encoding="utf-8"?> <xpubClassified xmlns="http://www.digitalriver.com/directtrack/api/xpubClassified/v1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/xpubClassi fied/v1_0 xpubClassified.xsd"> <campaignResourceURL location="../campaign/1"/> <listingName><![CDATA[TEST API listingName]]></listingName> <listingType>bid</listingType> <listingTitle><![CDATA[TEST API listingTitle]]></listingTitle> <listingStatus>Active</listingStatus> <startDate>2009-09-09</startDate> <endDate>2009-09-25</endDate> <shortDescription><![CDATA[TEST API short]]></shortDescription> <longDescription><![CDATA[TEST API long]]></longDescription> <impressionPayout>1.00000</impressionPayout> <clickPayout>2.000</clickPayout> <leadPayout>3.00</leadPayout> <flatSalePayout>4.00</flatSalePayout> <flatSubSalePayout>5.00</flatSubSalePayout> <percentSalePayout>6.00</percentSalePayout> <percentSubSalePayout>7.00</percentSubSalePayout> <allowChildEditCreatives>1</allowChildEditCreatives> </xpubClassified>
Failure Example
The CrossPublication Classified address https://[client_domain]/apifleet/rest/[client_id]/xpubClassified/[classified_id] is not valid.
354
CrossPub Classifieds Communications
Create a CrossPub Communication
API Name: createXpubCommunication Description: Creates a CrossPub Classified communication. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field xpubClassifiedResourceURL respondingCompanyResourceURL responseComment Data Type anyURI anyURI string Limit/Size Values alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value
255
Optional Parameters: Field campaignResourceURL impressionPayout clickPayout leadPayout flatSalePayout flatSubSalePayout percentSalePayout percentSubSalePayout digitalSignature Data Type anyURI double double double double double double double string Limit/Size Values *required if responding to a proposal Default
Defaults to the The payouts bidded/proposed/countercurrently offered payouts to two attached to the decimal places CLASSIFIED *required if the response is a bid Example: /Mark Smith/
355
Communication created. https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/[xpub_communication_id]
Failure Example
A response comment is required when creating a CrossPub Communication.
356
Edit a CrossPub Communication
API Name: editXpubCommunication Description: Edits a CrossPub Classified communication. Changing the approval field is used to trigger an action on the CrossPub Communication. The changes and corresponding actions are: accepted rejected counter will accept the bid/proposal and CrossPublish the offer will reject the bid/proposal and close the communication will send the counter-offer to the other party for approval
REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/[xpub_communication_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field xpubClassifiedResourceURL respondingCompanyResourceURL responseComment Data Type anyURI anyURI string Limit/Size Values alphanumeric value (relative URL) alphanumeric value (relative URL) alphanumeric value
255
Optional Parameters: Field campaignResourceURL impressionPayout clickPayout leadPayout flatSalePayout flatSubSalePayout percentSalePayout percentSubSalePayout digitalSignature Data Type anyURI double double double double double double double string Limit/Size Values *required if responding to a proposal Default
Defaults to the The payouts bidded/proposed/countercurrently offered payouts to two attached to the decimal places CLASSIFIED *required if the response is a bid Example: /Mark Smith/
357
Field approval
Data Type string
Limit/Size Values accepted rejected counter
Default
Communication updated - [xpub_communication_id]
Failure Example
A response comment is required when updating a CrossPub Communication.
358
List CrossPub Communications
API Name: listXpubCommunication Description: Returns a list of REST resource URLs pointing to CrossPub Communications. The list returned can include all CrossPub Communications or be filtered by status and classified listing by requesting the appropriate REST resource URL as shown in the chart below. REST URL: CrossPub Communication List Resources List Name All CrossPub Communications All CrossPub Communications by Status All CrossPub Communications by Classified ID REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/xpubCommunication/ /rest/[client_id]/xpubCommunication/[pending|accepted|rejected|counter]/ /rest/[client_id]/xpubCommunication/xpubClassified/[xpub_classified_id]/
359
Metadata: Field metaData1 metaData2 metaData3 Values Company ID Responding Company ID Response Date
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/resourceLi st/[version_id] resourceList.xsd" location=" https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/"> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/[xpub_ communication_id]" metadata1=123 metadata2=456 metadata3=2009-1115/> <resourceURL location=" https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/[xpub_ communication_id]" metadata1=456 metadata2=123 metadata3=2009-1126/> </resourceList>
Failure Example
The communications list at https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/rejected/ does not exist.
360
View a CrossPub Communication
API Name: getXpubCommunicationDetail Description: Displays a specified CrossPub Communication. REST URL: https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/[xpub_communication_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field Data Type xpub_communication_id string Limit/Size Values alphanumeric value, passed via the URL
361
<?xml version="1.0" encoding="utf-8"?> <xpubCommunication xmlns="http://www.digitalriver.com/directtrack/api/xpubCommunication/v1_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/xpubCommun ication/v1_0 xpubCommunication.xsd"> <xpubClassifiedResourceURL location="../xpubClassified/1"/> <respondingCompanyResourceURL location="../xpubCompany/23"/> <campaignResourceURL location="../campaign/555"/> <responseComment><![CDATA[TEST API I would like to run this campaign]]></responseComment> <impressionPayout>1.00000</impressionPayout> <clickPayout>2.000</clickPayout> <leadPayout>3.00</leadPayout> <flatSalePayout>4.00</flatSalePayout> <flatSubSalePayout>5.00</flatSubSalePayout> <percentSalePayout>6.00</percentSalePayout> <percentSubSalePayout>7.00</percentSubSalePayout> <digitalSignature></digitalSignature> <approval>pending</approval> <allowChildEditCreatives>1</allowChildEditCreatives> <commentHistory></commentHistory> </xpubCommunication>
Failure Example
The CrossPublication Communication address https://[client_domain]/apifleet/rest/[client_id]/xpubCommunication/[xpub_communication_id] is not valid.
362
API Reference Advertiser Management

Advertisers
Add Advertisers
API Name: createAdvertiser Description: Adds an advertiser record. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiser/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field company Data Type string Limit/Size 100 Values alphanumeric value
Optional Parameters: Field advertiserGroup Data Type Field location Limit/Size Values Limit/Size Default Values alphanumeric value (relative URL) alphanumeric value
Data Type anyURI
name email status approval password salutation string string string string string 50 10 255
string email formatted alphanumeric value active inactive approved denied alphanumeric value alphanumeric value
363
Field firstName middleName lastName website address address2 city state zip country phone fax createdDate
Data Type string string string string string string string string string string string string string
Limit/Size 50 50 50 512 200 200 100 50 10 100 50 50 19
agreedTerms notes currency called
booleanInt string string booleanInt
0-3
Values alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value date value formatted as YYYY-MM- DD HH:MM:SS 1 0 alphanumeric value alphanumeric value 1 0
Default
Advertiser created. https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id]
Failure Example
A company is required when adding an advertiser.
364
Edit Advertisers
API Name: editAdvertiser Description: Updates an existing advertiser record. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field company Data Type string Limit/Size 100 Values alphanumeric value
Optional Parameters: Field advertiserGroup Data Type Field location Limit/Size Values Limit/Size Default Values alphanumeric value (relative URL) alphanumeric value
Data Type anyURI
name email status approval password salutation firstName middleName lastName website address address2 city string string string string string string string string string string string string 50 10 50 50 50 512 200 200 100 255
string email formatted alphanumeric value active inactive approved denied alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value
365
Field state zip country phone fax createdDate
Data Type string string string string string string
Limit/Size 50 10 100 50 50 19
agreedTerms notes currency called
booleanInt string string booleanInt
0-3
Values alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value date value formatted as YYYY-MM- DD HH:MM:SS 1 0 alphanumeric value alphanumeric value 1 0
Default
Advertiser updated [advertiser_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id]
366
List Advertisers
API Name: listAdvertiser Description: Returns a list of REST resource URLs pointing to advertisers. The list returned can include all advertisers or be filtered by status, PPC status or by campaign by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Advertiser List Resources List Name All Advertisers Advertisers by Date Active Advertisers Inactive Advertisers Advertisers by Status and Date Advertisers Enrolled in PPC Management PPC Advertisers advertiser paid PPC Advertisers DirectTrack Paid Advertisers by PPC Type and Date REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/advertiser/ /rest/[client_id]/[access_id]/advertiser/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/advertiser/active/ /rest/[client_id]/[access_id]/advertiser/inactive/ /rest/[client_id]/[access_id]/advertiser/active|inactive/[yyyy]-[mm]/ /rest/[client_id]/[access_id]/advertiser/ppc/ /rest/[client_id]/[access_id]/advertiser/advertiserPaid/ /rest/[client_id]/[access_id]/advertiser/DTPaid/ /rest/[client_id]/[access_id]/advertiser/ppc| advertiserPaid|DTPaid/[yyyy]-[mm]/
HTTP Method: GET Cache Lifetimes: API Call Advertisers by Date For a Date Within the Current Month Previous Month Month Prior to 60 Days Lifetime 5 Minutes 1 Day 1 Month
367
Metadata: Field metaData1 metaData2 metaData3 Values Name (First Last) Company Email
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifle et/rest/[client_id]/[access_id]/advertiser/"> <resourceURL location="../../advertiser/1" metaData1="John Smith" metaData2="My Company" metaData3="advertiserEmail1@domain.com"/> <resourceURL location="../../advertiser/2" metaData1="Jane Doe" metaData2="Another Company" metaData3="advertiserEmail2@domain.com"/> <resourceURL location="../../advertiser/3" metaData1="Jim Advertiser" metaData2="Advertiser Company" metaData3="advertiserEmail3@domain.com"/> </resourceList>
Failure Example
The list at https://[client_domain]/apifleet/rest/[client_id]/advertiser/ppc/ does not exist.
368
View Advertisers
API Name: getAdvertiserDetail Description: Retrieves detailed information about an existing advertiser. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id] HTTP Method: GET Cache Lifetime: 1 Day API Rate: 10 points per call Required Parameters: Field advertiser_id Data Type integer Limit/Size Values valid advertiser ID, passed via the URL
369
<?xml version="1.0" encoding="utf-8"?> <advertiser xmlns="http://www.digitalriver.com/directtrack/api/advertiser/[versi on_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/adve rtiser/[version_id] advertiser.xsd" location="https:// [client_domain]/apifleet/rest/[client_id]/advertiser/776"> <company><![CDATA[Company Name]]></company> <advertiserGroup location="../advertiserGroup/2" name="Full_rights"/> <email><![CDATA[email@company.com]</email> <status>active</status> <approval>approved</approval> <salutation>Mr</salutation> <firstName><![CDATA[First Name]]></firstName> <middleName><![CDATA[Middle Name]]></middleName> <lastName><![CDATA[Last Name]]></lastName> <website><![CDATA[http://www.directtrack.com]]></website> <address><![CDATA[Foster Plaza Building 8]]></address> <address2><![CDATA[730 Holiday Drive]]></address2> <city><![CDATA[Pittsburgh]]></city> <state><![CDATA[PA]]></state> <zip>15220</zip> <country><![CDATA[USA]]></country> <phone>4129216881</phone> <fax>4129211844</fax> <createdDate>2009-09-01 10:53:25</createdDate> <agreedTerms>0</agreedTerms> <notes><![CDATA[This is a reliable advertiser.]]></notes> <currency>USD</currency> <called>0</called> <accessID>7</accessID> </advertiser>
Failure Example
The advertiser detail address https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id] is not valid.
370
Advertiser Contacts
Add Advertiser Contacts
API Name: createAdvertiserContact Description: Adds a new contact to an existing advertiser record. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field email Data Type string Limit/Size 255 Values email formatted alphanumeric value
Optional Parameters: Field advertiserURL password status approval salutation firstName middleName lastName website address address2 city state zip country Data Type anyURI string string string string string string string string string string string string string string 10 50 50 50 512 200 200 100 50 10 100 Limit/Size Values alphanumeric value (relative URL) alphanumeric value active inactive approved denied alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value Default
50
371
Field phone fax notes createdDate
Data Type string string string string
Limit/Size 50 50 19
primary canView
booleanInt string
canAdd canEdit
booleanInt string
Values alphanumeric value alphanumeric value alphanumeric value date value formatted as YYYY-MM- DD HH:MM:SS 1 0 none own all 1 0 none own all
Default
Advertiser contact created. https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/[advertiser_contact_id]
Failure Example
An email is required when adding an advertiser contact.
372
Edit Advertiser Contacts
API Name: editAdvertiserContact Description: Updates an existing advertiser contact record. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/[advertiser_contact_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field email Data Type string Limit/Size 255 Values email formatted alphanumeric value
Optional Parameters: Field advertiserURL password status approval salutation firstName middleName lastName website address address2 city state zip country phone fax notes Data Type anyURI string string string string string string string string string string string string string string string string string 10 50 50 50 512 200 200 100 50 10 100 50 50 Limit/Size Values alphanumeric value (relative URL) alphanumeric value active inactive approved denied alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value alphanumeric value Default
50
373
Field createdDate
Data Type string
Limit/Size 19
primary canView
booleanInt string
canAdd canEdit
booleanInt string
Values date value formatted as YYYY-MM- DD HH:MM:SS 1 0 none own all 1 0 none own all
Default
Advertiser contact updated [advertiser_contact_id].
Failure Example
The advertiser contact address https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/[advertiser_contact_id] is not valid.
374
Remove Advertiser Contacts
API Name: removeAdvertiserContact Description: Deletes an existing advertiser contact from an advertiser record. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/[advertiser_contact_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field advertiser_contact_id Data Type integer Limit/Size Values valid advertiser contact ID, passed via the URL
Advertiser contact deleted [advertiser_contact_id].
Failure Example
375
List Advertiser Contacts
API Name: listAdvertiserContact Description: Returns a list of REST resource URLs pointing to advertisers contacts for a specified advertiser. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/advertiserContact/[advertiser_id]/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field advertiser_id Data Type integer Limit/Size Values valid advertiser ID, passed via the URL
Metadata: Field metaData1 metaData2 metaData3 Values Name (First Last) Email Created Date
376
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location="http://[client_domain].directtrack.digitalriver.com/apifle et/rest/[client_id]/[access_id]/advertiserContact/[advertiser_id]/"> <resourceURL location="../../advertiserContact/1" metaData1="John Smith" metaData2="advertiserEmail1@domain.com" metadata3="2009-02-13 14:02:54"/> <resourceURL location="../../advertiserContact/2" metaData1="Jane Doe" metaData2="advertiserEmail2@domain.com" metadata3="2009-02-23 14:54:25"/> <resourceURL location="../../advertiserContact/3" metaData1="Jim Advertiser" metaData2="advertiserEmail3@domain.com" metadata3="200903-13 12:43:01"/> </resourceList>
Failure Example
The list at https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/[advertiser_id]/ does not exist.
377
View Advertisers
API Name: getAdvertiserContactDetail Description: Retrieves detailed information about an existing advertiser contact. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserContact/[advertiser_contact_id] HTTP Method: GET Cache Lifetime: 8 Hours API Rate: 10 points per call Required Parameters: Field advertiser_contact_id Data Type integer Limit/Size Values valid advertiser contact ID, passed via the URL
378
<?xml version="1.0" encoding="utf-8"?> <advertiserContact xmlns="http://www.digitalriver.com/directtrack/api/advertiserContact /[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/adve rtiserContact/[version_id] advertiserContact.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/advertis erContact/1269"> <email><![CDATA[alias@domain.com]]></email> <advertiserURL location="https://[client_domain]/apifleet/rest/[client]/advertiser/ [advertiser_id]"/> <status>active</status> <approval>approved</approval> <salutation>Mr</salutation> <firstName><![CDATA[First Name]]></firstName> <middleName><![CDATA[Middle Name]]></middleName> <lastName><![CDATA[Last Name]]></lastName> <address><![CDATA[Foster Plaza Building 8]]></address> <address2><![CDATA[730 Holiday Drive]]></address2> <city><![CDATA[Pittsburgh]]></city> <state><![CDATA[PA]]></state> <zip>15220</zip> <country><![CDATA[USA]]></country> <phone>4129216881</phone> <fax>4129211844</fax> <notes/> <createdDate>2009-02-13 14:02:54</createdDate> <primary>1</primary> <canView>all</canView> <canAdd>1</canAdd> <canEdit>all</canEdit> </advertiserContact>
Failure Example
379
Advertiser Groups
Add Advertiser Groups
API Name: createAdvertiserGroup Description: Adds an advertiser group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field groupName Data Type string Limit/Size 100 Values alphanumeric value
Optional Parameters: Field isDefault autoCreateInvoices canAddAffiliates canAddCampaigns requiresAddCampaignApproval canAddCreative requiresAddCreativeApproval canAddTerms canApproveAffiliates Data Type booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt Limit/Size Values 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 Default
380
Field canEditAcctInfo canEditAffSignupPage canEditCampaigns canEditCreative canEditCreativeCategories requiresEditCreativeApproval canEditNotifications canEditPayouts canEmailAffiliates canGroupAffiliates canViewInactiveCampaigns canViewAffiliateDetail usesBrandedNotifications usesBrandedSignups numCampaignsAllowed campaignTypesAllowed
Data Type booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt integer string
Limit/Size
ppcMgmtInvPaymentResponsibility string characterEncoding advertisers string anyURI
Values 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 numeric value CPC CPM CPA CPS ALL Advertiser DirectTrackAccount alphanumeric value alphanumeric value (relative URL)
Default
10000 ALL
Advertiser
381
Advertiser group created. https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/[advertiser_group_id]
Failure Example
A name is required when adding an advertiser group.
382
Edit Advertiser Groups
API Name: editAdvertiserGroup Description: Updates an existing advertiser group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field groupName Data Type string Limit/Size 100 Values alphanumeric value
Optional Parameters: Field isDefault autoCreateInvoices canAddAffiliates canAddCampaigns requiresAddCampaignApproval canAddCreative requiresAddCreativeApproval canAddTerms canApproveAffiliates canEditAcctInfo canEditAffSignupPage Data Type booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt Limit/Size Values 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 Default
383
Field canEditCampaigns canEditCreative canEditCreativeCategories requiresEditCreativeApproval canEditNotifications canEditPayouts canEmailAffiliates canGroupAffiliates canViewInactiveCampaigns canViewAffiliateDetail usesBrandedNotifications usesBrandedSignups numCampaignsAllowed campaignTypesAllowed
Data Type booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt booleanInt integer string
Limit/Size
ppcMgmtInvPaymentResponsibility string characterEncoding advertisers string anyURI
Values 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 numeric value CPC CPM CPA CPS ALL Advertiser DirectTrackAccount alphanumeric value alphanumeric value (relative URL)
Default
10000 ALL
Advertiser
384
Advertiser group updated [advertiser_group_id].
Failure Example
The advertiser group address https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/[advertiser_group_id] is not valid.
385
Remove Advertiser Groups
API Name: removeAdvertiserGroup Description: Deletes an existing advertiser group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/[advertiser_group_id] HTTP Method: DELETE API Rate: 10 points per call Required Parameters: Field advertiser_group_id Data Type integer Limit/Size Values valid advertiser group ID, passed via the URL
Advertiser group deleted [advertiser_group_id].
Failure Example
The required location attribute for the resource does not match the resource you are attempting to modify. Expected: https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/[advertiser_group_id]
386
List Advertiser Groups
API Name: listAdvertiserGroup Description: Returns a list of REST resource URLs pointing to advertiser groups, or advertisers in an advertiser group by campaign by requesting the appropriate REST resource URL as shown in the chart below. REST URL: Advertiser List Resources List Name All Advertiser Groups All Advertisers in an Advertiser Group REST URL (Preceded by https://[client_domain]/apifleet) /rest/[client_id]/[access_id]/advertiserGroup/ /rest/[client_id]/[access_id]/advertiserGroup/[advertiser_group_id]/advertiser/
387
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location="https://[client_domain].directtrack.digitalriver.com/apifl eet/rest/[client_id]/[access_id]/advertiserGroup/"> <resourceURL location="../../advertiserGroup/1" metaData1="Advertiser Group 1" metaData2="1" metaData3=""/> <resourceURL location="../../advertiserGroup/2" metaData1="Advertiser Group 2" metaData2="2" metaData3=""/> <resourceURL location="../../advertiserGroup/3" metaData1="Advertiser Group 3" metaData2="3" metaData3=""/> <resourceURL location="../../advertiserGroup/4" metaData1="Advertiser Group 4" metaData2="4" metaData3=""/> <resourceURL location="../../advertiserGroup/5" metaData1="Advertiser Group 5" metaData2="5" metaData3=""/> </resourceList>
Failure Example
The list at https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/[advertiser_group_id]/advertiser/ does not exist.
388
View Advertiser Groups
API Name: getAdvertiserGroupDetail Description: Retrieves detailed information about an existing advertiser group. REST URL: https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/[advertiser_group_id] HTTP Method: GET Cache Lifetime: 1 Day API Rate: 10 points per call Required Parameters: Field advertiser_group_id Data Type integer Limit/Size Values valid advertiser group ID, passed via the URL
389
<advertiserGroup xmlns="http://www.digitalriver.com/directtrack/api/advertiserGroup/[version_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/advertiserGroup/[ve rsion_id] advertiserGroup.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/advertiserGroup/48"> <groupName><![CDATA[ADV GROUP - Green]]></groupName> <isDefault>0</isDefault> <autoCreateInvoices>1</autoCreateInvoices> <canAddCampaigns>1</canAddCampaigns> <requiresAddCampaignApproval>1</requiresAddCampaignApproval> <canAddCreative>1</canAddCreative> <requiresAddCreativeApproval>1</requiresAddCreativeApproval> <canAddTerms>1</canAddTerms> <canApproveAffiliates>1</canApproveAffiliates> <canEditAcctInfo>1</canEditAcctInfo> <canEditCampaigns>1</canEditCampaigns> <canEditCreative>1</canEditCreative> <requiresEditCreativeApproval>1</requiresEditCreativeApproval> <canEditNotifications>1</canEditNotifications> <canEditPayouts>1</canEditPayouts> <canEmailAffiliates>1</canEmailAffiliates> <canGroupAffiliates>1</canGroupAffiliates> <canViewInactiveCampaigns>1</canViewInactiveCampaigns> <usesBrandedNotifications>1</usesBrandedNotifications> <usesBrandedSignups>1</usesBrandedSignups> <numCampaignsAllowed>5000</numCampaignsAllowed> <campaignTypesAllowed><![CDATA[CPS CPA CPM CPC]]></campaignTypesAllowed> <ppcMgmtInvPaymentResponsibility><![CDATA[Advertiser]]></ppcMgmtInvPaymentResponsib ility> <characterEncoding><![CDATA[UTF-8]]></characterEncoding> <advertisers> <resourceURL location="../advertiser/1"/> <resourceURL location="../advertiser/2"/> <resourceURL location="../advertiser/4"/> </advertisers> </advertiserGroup>
Failure Example
The advertiser detail address https://[client_domain]/apifleet/rest/[client_id]/advertiser/[advertiser_id] is not valid.
390
API Reference Lead Management

Consumer Leads
Add Consumer Leads
API Name: createConsumerLead Description: Adds a consumer lead. REST URL: https://[client_domain]/apifleet/rest/[client_id]/consumerLead/ HTTP Method: POST API Rate: 10 points per call Required Parameters: Field campaignResourceURL Data Type anyURI Limit/Size Values
Optional Parameters: Field firstName lastName gender address1 address2 city state postalCode country terrestrialPhone mobilePhone email Data Type string string string string string string string string string string string string Limit/Size 255 255 1 255 255 255 20 6 100 10 10 150 Values Default
391
Consumer lead created. https://[client_domain]/apifleet/rest/[client_id]/consumerLead/[consumer_lead_id]
Failure Example
A campaignResourceURL is required when adding a consumer lead.
392
Edit Consumer Lead
API Name: editConsumerLead Description: Updates an existing consumer lead. REST URL: https://[client_domain]/apifleet/rest/[client_id]/consumerLead/[consumer_lead_id] HTTP Method: PUT API Rate: 10 points per call Required Parameters: Field consumer_lead_id Data Type integer Limit/Size Values unique consumer lead ID, passed via the URL
Optional Parameters: Field firstName lastName gender address1 address2 city state postalCode country terrestrialPhone mobilePhone email Data Type string string string string string string string string string string string string Limit/Size 255 255 1 255 255 255 20 6 100 10 10 150 Values Default
393
Consumer lead updated [consumer_lead_id].
Failure Example
The consumer lead address https://[client_domain]/apifleet/rest/[client_id]/consumerLead/[consumer_lead_id] is not valid.
394
List Consumer Leads
API Name: listConsumerLead Description: Returns a list of REST resource URLs pointing to consumer leads for a specified campaign and date. REST URL: https://[client_domain]/apifleet/rest/[client_id]/[access_id]/consumerLead/campaign/[campaign_id]/[y yyy]-[mm]-[dd]/ HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 1 point per row returned Required Parameters: Field Data Type Limit/Size Values
395
<resourceList xmlns="http://www.digitalriver.com/directtrack/api/resourceList/[ver sion_id]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/reso urceList/[version_id] resourceList.xsd" location="https://[client_domain].directtrack.digitalriver.com/apifl eet/rest/[client_id]/[access_id]/consumerLead/campaign/[campaign_id] /[yyyy]-[mm]-[dd]/"> <resourceURL location="../../consumerLead/1/> <resourceURL location="../../consumerLead/2"/> <resourceURL location="../../consumerLead/3"/> <resourceURL location="../../consumerLead/4"/> <resourceURL location="../../consumerLead/5"/> </resourceList>
Failure Example
The list at https://[client_domain].directtrack.digitalriver.com/apifleet/rest/[client_id]/[access_id]/consumerL ead/campaign/[campaign_id]/[yyyy]-[mm]-[dd]/ does not exist.
396
View Consumer Leads
API Name: getConsumerLeadDetail Description: Retrieves detailed information about a specified consumer lead. REST URL: https://[client_domain]/apifleet/rest/[client_id]/consumerLead/[consumer_lead_id] HTTP Method: GET Cache Lifetime: 15 Minutes API Rate: 10 points per call Required Parameters: Field consumer_lead_id Data Type integer Limit/Size Values valid consumer lead ID, passed via the URL
397
<consumerLead xmlns="http://www.digitalriver.com/directtrack/api/consumerLead/[version_i d]" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.digitalriver.com/directtrack/api/consumerLe ad/[version_id] consumerLead.xsd" location="https://[client_domain]/apifleet/rest/[client_id]/consumerLead/4 8"> <campaignResourceURL location="../campaign/{program_id}" /> <firstName>{firstname}</firstName> <lastName>{lastname}</lastName> <gender>M</gender> <address1>{address}</address1> <address2>{address2}</address2> <city>{city}</city> <state>{state}</state> <postalCode>{zip}</postalCode> <country>{country}</country> <terrestrialPhone>{phone}</terrestrialPhone> <mobilePhone>{cellphone}</mobilePhone> <email>{email}</email> </consumerLead>
Failure Example
The consumer lead detail address https://[client_domain]/apifleet/rest/[client_id]/consumerLead/[consumer_lead_id] is not valid.
398

APIUser Guide

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

APIUser Guide

Uploaded by

Copyright:

Available Formats

DirectTrack API Fleet User Guide

Getting and Using XSDs

Accessing the API Fleet

For Advertisers and Affiliates

Mobile Creative Helper SMS Contact List

Points 10 10 10 1 10 Points 10 10 1 10 Points 10 10 1 10

Affiliate Group ADD EDIT

Affiliate Blacklist ADD

Crosspublication Offer ADD

Program Click ADD

Detailed Click ADD

Program Lead ADD

Detailed Lead ADD

Detailed Sale ADD

[campaign_access_request_id] [campaign_category_id] [campaign_group_id] [campaign_id]

Placeholder [traffic_limit_id] [version] [version_id] [xpub_communication_id] [xpub_company_id] [yyyy]

Affiliate Groups API Name createAffiliateGroup editAffiliateGroup removeAffiliateGroup listAffiliateGroup getAffiliateGroupDetail

Affiliate Blacklist API Name createAffiliateOnBlacklist removeAffiliateOnBlacklist listAffiliateBlacklist

Affiliate Edit Requests API Name editAffiliateEditRequest listAffiliateEditRequest getAffiliateEditRequestDetail

Campaign Access Requests API Name createCampaignAccessRequest editCampaignAccessRequest listCampaignAccessRequest getCampaignAccessRequestDetail

Creative Deployment API Name createCreativeDeployment editCreativeDeployment listCreativeDeployment getCreativeDeploymentDetail

Third Party Pixels API Name createThirdPartyPixel removeThirdPartyPixel listThirdPartyPixel getThirdPartyPixelDetail

Tracking URLs API Name getTrackingURLDetail

Description Gets details for a specific Tracking URL

Affiliate Histories API Name getAffiliateHistory

Description Gets a list of past changes to an affiliates record

Campaign Groups API Name createCampaignGroup editCampaignGroup removeCampaignGroup listCampaignGroup getCampaignGroupDetail

Creatives API Name createCreative editCreative removeCreative listCreative getCreativeDetail

Payouts API Name createPayout editPayout removePayout listPayout getPayout

Traffic Limits API Name createTrafficLimit editTrafficLimit removeTrafficLimit listTrafficLimit getTrafficLimitDetail

Products API Name createProduct editProduct removeProduct listProduct getProduct

Product Brands API Name createProductBrand editProductBrand listProductBrand getProductBrand

Product Categories API Name createProductCategory editProductCategory listProductCategory getProductCategoryDetail

Program Impressions API Name createProgramImpression listProgramImpression getProgramImpression

Program Clicks API Name createProgramClick editProgramClick listProgramClick getProgramClick

Detailed Clicks API Name createClickDetail listClickDetail getClickDetail

Program Leads API Name createProgramLead editProgramLead listProgramLead getProgramLead

Detailed Leads API Name createLeadDetail editLeadDetail removeLeadDetail listLeadDetail getLeadDetail

Detailed Sales API Name createSaleDetail editSaleDetail listSaleDetail getSaleDetail

Advertisers API Name createAdvertiser editAdvertiser listAdvertiser getAdvertiserDetail

Advertiser Contacts API Name createAdvertiserContact editAdvertiserContact removeAdvertiserContact listAdvertiserContact getAdvertiserContactDetail

Advertiser Groups API Name createAdvertiserGroup editAdvertiserGroup removeAdvertiserGroup listAdvertiserGroup getAdvertiserGroupDetail

Consumer Leads API Name createConsumerLead editConsumerLead listConsumerLead getConsumerLeadDetail

APIs by HTTP Operation

createXpubCommunication createAdvertiser createAdvertiserContact createAdvertiserGroup createConsumerLead

API Fleet Tips and Tricks

API Reference User Management

Add API User

API user created. https://[client_domain]/apifleet/rest/[client_id]/apiUser/[api_user_id]

A userType is required when adding an API user.

List API Users

Optional Parameters: Field Data Type Limit/Size Values Default

Responses XML Example

The API user at https://[client_domain]/apifleet/rest/[client_id]/apiUser/[username]/[password]/ does not exist.

View API Users

Optional Parameters: Field Data Type Limit/Size Values Default

Responses XML Example

The API User address https://[client_domain]/apifleet/rest/[client_id]/apiUser/[access_id] is not valid.

Client User Accounts

Add Client User

API Name: createClientUser Description: Adds a new DirectTrack client user.

Client user created. https://[client_domain]/apifleet/rest/[client_id]/client/[client_user_id]