Campaign Template Report API
Given the campaign Id and report template Id, this API retrieves all the campaign metrics as defined in the reporting template.
Request URL
http:///jivox/serverAPIs/externalReporting/getCampaignTemplateReport.php
Parameters
The request URL supports the following parameters:
| Parameter | Description |
|---|---|
| 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. |
| campaignId | (Required) ID of the campaign for which the request is made. |
| templateId | (Required) ID of the template data requested through the API. |
| startDate | (Optional) Start date range for report. |
| endDate | (Optional) End date range for report. |
Example
Using cURL (this command includes hard returns for readability):
xxxxxxxxxxcurl -d 'apiId=jivox.reporting.api&apiKey=MyAPIKey&apiVersion=2.0& publisherId=939&campaignId=67992&templateId=2420&startDate=2011-12-12&endDate=2015-12-12' http:__as64.jivox.com_jivox_serverAPIs_externalReporting_getCampaignTemplateReport.phpServer Success Response
The API output depends on the reporting template that has been created in the Jivox platform, and below is one example:
xxxxxxxxxx<jivoxServerResponse><result>SUCCESS<_result><campaign><id> campaign_id <_id><name> campaign_name <_name><startDate> start_date <_startDate><endDate> end_date <_endDate><records><record><data><header>Date<_header><value>2015-01-01<_value><_data><data><header>Placement<_header><value>MyPlacement_300x250<_value><_data><data><header>Impression<_header><value>32100<_value><_data><data><header>Clicks<_header><value>120<_value><_data>.... __ The data tag depends on the template columns selected..<_record>.... __ The record is total number of rows in the report..<record>....<_record><_records><_campaign><_jivoxServerResponse>Was this page helpful?