DSP Banner AD. Report API (for SSP)

2 minute read

InJun Kim

Basic info

SSP DSP

This is an API guide for providing reports to SSP (Supply Side Platform) partners in integration with TARGETPICK Demand Side Platform (DSP). To receive DSP reports through TARGETPICK, you must obtain Token from the manager. Please contact the manager to issue Token for API use.

Report data request

Basic info Description
API name report for SSP
response format XML or JSON
authentication method Token
call method HTTPS
API description Passes the report as a result of executing the ad to SSP
URL
Division URL Method
test http://211.62.152.212:9000/api/report Get
real https://dsp-report.meba.kr:9000/api/report Get
Parameters
Field Type Required Example Description
sDate String Y 20160101 report query start date
eDate String Y 20160131 report query end date
PartnerID String Y userpartnerid partner unique id issued by MezzoMedia
Token String Y F379C8K9P0 unique token value for API use
ADType Integer Y 1 0 - ALL
1 - standard banner
ReportType Integer Y 1 1 - daily
2 - media (PubID) report
3 - ad type
format String Y json json , xml
Sample
Sample URL
http://211.62.152.212:9000/api/report?PartnerID=abcde12345&token=C150KPTR39F0277A743B6&format=xml&ReportType=1&ADType=0&sDate=20190101&eDate=20190131

Report data response

Basic info - When requested by the report API, the report data is returned in the form below.

Field Type Example Description
ListCount Integer 100 returned row count
ReportType Integer 1 1 - daily report
2 - media (PubID) report
3 - ad type report
ADType Integer banner banner
interstitial
interstitialEnd
square and rectangle
skyScraper
leaderboard
Reports.Report Array    
Date String 20160101 report date
Imp Integer 1000 impression count
Click Integer 100 click count
CTR Double 10.00 click through ratio
PubID String publisher123 AppID or SiteID as an ID to identify the media
(possible encoded ID)
Revenue Double 100000 inventory sales revenues
Sample
Daily Report (ReportType=1)
<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>1</ReportType> 
		<sDate>20190101</sDate> 
		<eDate>20190131</eDate> 
		<ADType>ALL</ADType> 
		<Reports>
			<Report>
				<Date>20190101</Date>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data>
Media report (ReportType=2)
<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>2</ReportType> 
		<sDate>20160101</sDate> 
		<eDate>20160131</eDate> 
		<ADType>banner</ADType> 
		<Reports>
			<Report>
				<Date>20160101</Date>
				<PubID>publisher123</PubID>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				<Date>20160101</Date>
				<PubID>publisher456</PubID>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>3000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data> xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>1</ReportType> 
		<sDate>20160101</sDate> 
		<eDate>20160131</eDate> 
		<ADType>ALL</ADType> 
		<Reports>
			<Report>
				<Date>20160101</Date>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR>10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data>
Ad type report (ReportType=3)
<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</error>
		<message>SUCCESS</message>
	</error>
	<result>
		<ListCount>10</ListCount> 
		<ReportType>3</ReportType> 
		<sDate>20160101</sDate> 
		<eDate>20160131</eDate> 
		<ADType>ALL</ADType> 
		<Reports>
			<Report>
				<Date>20160101</Date>
				<ADType>banner</ADType>
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR> 10.00</CTR>
				<Revenue>5000</Revenue>
			</Report>
			<Report>
				<Date>20160101</Date>
				<ADType>interstitial</ADType> 
				<Imp>1000</Imp>
				<Click>100</Click>
				<CTR> 10.00</CTR>
				<Revenue>3000</Revenue>
			</Report>
			<Report>
				……
			</Report>
		</Reports>
	</result>
</data>

Error Code

Code Descirption
000 success
001 system error
002 unknown error
003 no permissions
004 non-exist API
005 incorrect parameter
006 Date must be entered and cannot exceed 3 months

Error Response Sample

<?xml version="1.0" encoding="utf-8" ?>
<data>
	<error>
		<code>000</code> 
		<message>SUCCESS</message> 
	</error>
</data>

Updated: