Get Advertisers API

Given a publisher ID and an optional date, this API retrieves all the advertisers added to the system for the publisher since the specified date. If no date is specified, this request returns all the advertisers for the publisher ID. Data returned is in XML and includes the following information:

Advertiser ID
Advertiser Name
Advertiser Email Address
Company Name
Publisher ID
Publisher Name
Group ID
Group Name
Site ID
Site Name
Creation Date

This API includes information for all advertisers. To return only active advertisers, refer to Get Active Advertisers API.

Request URL

To retrieve advertisers, make a request to the following URL:

http:///jivox/serverAPIs/externalReporting/getAdvertisers.php

Parameters

The request URL supports the following parameters:


apiId	(Required) ID of the API.
apiKey	(Required) Authentication key.
apiVersion	(Required) Version number of the API for which authentication key is generated.
publisherId	(Required) ID of the publisher or agency for which authentication key is generated.
sinceDate	(Optional) Return advertisers added to the system since this date.
groupId	(Optional) Filter by group ID.
siteId	(Optional) Filter by site ID.

Example

Using cURL (this command includes hard returns for readability):

Javascript
    
curl -d 'apiId=jivox.externalReporting&apiKey=MyAPIKey&apiVersion=2.0& publisherId=939&sinceDate=2012-01-01' http:__testserver.jivox.com_jivox_serverAPIs_externalReporting_getAdvertisers.php
Copy

Server Success Response

In case of success, the server returns a response with the structure shown below:

Javascript
    
<jivoxServerResponse><result>SUCCESS<_result><advertisers><advertiser><advertiserId>17740<_advertiserId><emailAddress>thebookery@gg.com<_emailAddress><advertiserName>thebookery@gg.com<_ advertiserName ><creationDate>2012-02-28<_creationDate><publisherId>lee<_publisherId><publisherName>Lee Enterprises<_publisherName><groupId>lee<_groupId><groupName>All Lee Enterprises<_groupName><siteId>84bfababe5ccb2<_siteId><siteName>Mason City<_siteName><_advertiser><advertiser>...<_advertiser><_advertisers><_jivoxServerResponse>
Copy

Last updated on

Was this page helpful?