Data API 2011-05-01


This is the prefix required to access the Data API via REST:

SOAP WSDL / Endpoint

This is the URL to which you need to send your SOAP requests:

Same XSD is used for both REST and SOAP data structures. The XS definition is part of the WSDL.

Key Features

Right now we support:
  • export your clicks (ppc)
  • export your clicksIns (lpt)


zanox Data API follows an asynchronous pattern. First, you have to order your data export job. The zanox Data API will then respond with a jobId.
Use this jobId to check your job's status. Once your job is processed by the zanox backend, you can download the result.
Right now, we support gzip-csv compression.
  1. Initiate Data Export Job
  2. Check job status
  3. Download export (gzip-csv)

CSV Export Data Fields

The types of data that can be exported are: Click, Click In, and Custom.  

More information can be found here.


SOAP Interface

Resource Description
CreateReportJob Creates a reportJob.
GetJob Returns a Job based on id.
GetJobs Returns a set of Jobs.

REST Interface

Resource Description
POST /jobs/reports/type/{type} Creates a reportJob.
GET /jobs/job/id/{id} Returns a Job based on id.
GET /jobs Returns a set of Jobs.

Response Object

Object Description
JobItem Standard Response Object for Data API

General notes

Additional methods

Both REST and SOAP interfaces contain additional undocumented methods. These methods are not intended for public use and are not supported by zanox.

Differences between 2009, 2010 and 2011 versions

There are only small differences between all three versions. Compared to the 2009 version, the 2011 version has following changes:
CreateReportJobRequest: added reviewState filter for lead/sale reports
CreateReportJobRequest: optional notifyUrl is no longer supported
CreateReportJobRequest: groupBy is now a string instead of enumeration
CreateReportJobRequest: added ability to select columns
JobItem: compression is now a string instead of enumeration
Supported report types - added custom and cashback, removed aggregated and view and postview (never supported)
The 2010 version contained a createCustomReport method to order custom reports. This functionality is now available in the createReportJob method in the 2011 version.