Get Campaign Tags API

The Get Campaign tags API is used to retrieve tags that have been previously generated for a campaign. Please note that this call does not generate the tags but merely returns all the tags that have been generated for the campaign.

Request URL

https://<JIVOX_SERVER>/jivox/serverAPIs/rest/getCampaignTags.php

The request URL supports the following parameters:

Parameter	Description
campaignId	(Required) ID of the campaign for which the request is made.

Example

Javascript
    
 
curl –d 'apiId=aaa&apiKey=bbb&apiVersion=1.0&publisherId=xxx&campaignId=54321' https:__<server>_jivox_serverAPIs_rest_getCampaignTags.php
Copy

Server Success Response

In case of success, the server returns xml structure as shown below:

Javascript
    
 
<jivoxServerResponse><result>SUCCESS<_result><placements><placement><Name>Jivox Placement1<_Name><tag><script type="text_javascript" src="http:__as.jivox.com_unit_unit_renderer.php?creativeUnitType=20&bDim=300x250&bUnitId=2001&siteId=756be6ccc08b20&campaignId=83795&es_pId=5usF19&jvxVer=2&asn=oas&cMacro=%%C%%?&r=%%REALRAND%%"><_script><_tag><_placement><placement><Name>Jivox Placement2<_Name><tag><script type="text_javascript" src="http:__as.jivox.com_unit_unit_renderer.php?creativeUnitType=20&bDim=300x250&bUnitId=2001&siteId=756be6ccc08b20&campaignId=83795&es_pId=5FR4Fa&jvxVer=2&asn=oas&cMacro=%%C%%?&r=%%REALRAND%%"><_script><_tag><_placement><_placements><_jivoxServerResponse>
Copy

Fields in the server response XML are as follows:

Name: Name of the placement.
tag: Generated tag

Last updated on

Was this page helpful?