Jivox Reporting APIs

User events that are tracked using Jivox ad widgets return metrics such as click-through to the Jivox platform. The Jivox Reporting API provides a systematic interface for integrating these Jivox metrics with a publisher's dashboard of metrics. The Reporting API allows an application to query the Jivox platform using an HTTP Post request. The response includes advertiser and ad data formatted in XML. For details on each API, see:

• Campaign Overview API
• Get Advertisers API
• Get Active Advertisers API
• Get Templates API
• Campaign Template Report API

API Access

Note that for all APIs:

1- All parameters are passed as HTTP POST

2- For authentication the following parameters are passed with each call:

• apiId — ID of the API
• apiKey — Authentication key.
• apiVersion — Version number of the API for which Authentication key is generated.
• publisherId — ID of the affiliate for which Authentication key is generated.

3- The requests are made to the Jivox reports server referred to as in the rest of this document.

When a Jivox client first requests access to Reporting APIs, Jivox Support provides:

• API authentication parameters
• Jivox reports server

Server Failure Response

In case of failure for any API lookup, the following response is returned:

xxxxxxxxxx

<jivoxServerResponse><result>FAILED<_result><errorCode>Error Code <_erorCode><shortDesc>Short Description of error<_shortDesc><longDesc>Long description of error<_longDesc><jivoxServerResponse>

The error codes in the failure response are outlined below: