DSP Reporting API

DSP Reporting API  is used to retrieve the reports of the client. To retrieve the report, the DSP has to pass the token along with the request.

1. Generate Unique Token:

 To receive an authorization token, the user has to login with their own user name and password. To generate the unique token the user has to call the following API:

POST: https://api.vertoz.com/ip/authforpublisher?userName=(Vertoz_registered_email_id)&password=(password)

Request Method: POST

Request Parameters:

Parameters

Is required

Description

Type
UserName

Yes

 Allows the existing users to log in with their user name.

 String
password  Yes  Allows the existing users to log in with their password.

String

Response Parameters:

Parameters

Type

Description

tokenId

String

Generates the tokenId for a particular session.
fullname String  Returns the full name of the logged user.

emailid

String

Returns the email ID of the logged user.

1. Request API:

Method: POST

URL: https://api.vertoz.com/ip/authforpublisher?userName=vertoz.dsp@vertoz.com&password=abcdXYZ

2. Response in JSON:

{

“message”: “Sucess”,

“tokenId”: “09820911213431880”,

“statusCode”: 200

}

2. Get Report:

Use tokenId  from the above response to generate reports for a specified data range,

GET: https://api.vertoz.com/ip/dspstats?fromDate=2017-03-05&toDate=2017-03-10

Request Method: GET

Request Parameters

Parameters

Is Required

 Description

Type
fromDate

Yes

Represents the start date and includes the records of the from date. The supported format is DD-MM-YYYY.

 String
 toDate

Yes

 Represents the end date and includes the records of the to date. The supported format is DD-MM-YYYY.

String

Response Parameters

Parameter

Type

Description

message

String

Is used to give information about the response.

report

String

Displays the bidder report.

statusCode

int

Displays the status code of the request.

Example:

 1. Request API:

Method: GET

URL: https://api.vertoz.com/ip/dspstats?fromDate=2017-03-05&toDate=2017-03-10

2. Response in CSV:

date,request,response,win,impression,estimated_revenue,ecpm
2017-03-10,34936679,2539281,2328645,1081070,283.87,0.263
2017-03-09,37953568,2400800,1953708,1018617,242.51,0.239
2017-03-08,41213804,2233208,1956709,956867,184.66,0.193
2017-03-07,27377194,1209823,1032370,691831,119.33,0.173
2017-03-06,29124845,781710,618335,458700,72.98,0.160
2017-03-05,24731874,596955,457959,344395,56.10,0.163
Parameter

Type

Description

Date

String

Represents the report date.

bid_response

String

Displays the number of bid response to SSP request.

bid_win

int

Displays the number of bids won.

dsp_revenue

double

Displays the DSP revenue.

impression_count

double

Displays the number of impressions count.