Content Ads Report
Request URL
POST https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v1/ssp/report
Interface Authentication
Request header settings
x-apihub-ak={{backend authorization token}}
x-apihub-env=prod
request parameters
Parameter name
Parameter Type
Is this field required?
Description and Examples
date_range.start
string
yes
Start time, 2023-10-25
date_range.end
string
yes
End time, 2023-10-28
filters.Device
[]string
no
Device name, such as Mobile, SmallScreen
filters.AdFormat
[]string
no
Ad formats, such as Reward, WebInterstitial
filters.Country
[]string
no
Country code, for example: DZ,AO
filters.SiteId
[]string
no
SiteId, for example: test001,test002
filters.Zone
[]string
no
ZoneId, for example: 100000,100001
filters.Channel
[]string
no
Channel ID, for example: channel_test001, channel_test002
dimensions
[]string
yes
Statistical dimensions: Date (time), Domain (domain name), Country (country), Device (device), Zone (adunit name), SiteId (site id), AdFormat (ad format), Channel (channel)
sorts
对象
yes
Sorting
page_index
Number
yes
Page number, 1
page_size
Number
yes
Page size, 100
Request example
{
"date_range": {
"start": "2023-07-05",
"end": "2023-07-12"
},
"filters": {
"Device": [
"Mobile",
"SmallScreen"
],
"AdFormat": [
"Reward",
"WebInterstitial"
],
"Country": [
"DZ",
"AO"
],
"SiteId": [
"siteId_test001",
"siteId_test002"
],
"Zone": [
"zone_testId1",
"zone_testId2"
],
"Channel": [
"channel_test001",
"channel_test002",
"channel_test003"
]
},
"dimensions": [
"Date",
"Domain",
"Country",
"Device",
"Zone",
"SiteId",
"AdFormat",
"Channel"
],
"sorts": {
"Date": -1
},
"page_index": 1,
"page_size": 20
}response parameter
Parameter name
Calculation method
describe
GrossRevenue
Total revenue
NetRevenue
income
Impressions
Number of impressions
Clicks
Number of hits
ECpm
EC PM
TotalAdRequests
Number of requests
ResponseRate
TotalAdResponse/TotalAdRequests
Response rate
ImpressionRate
Impressions/TotalAdRequests
Impression rate
Cpc
GrossRevenue/Clicks
Ctr
Clicks/Impressions
Response example
{
"data": {
"page_index": 1,
"page_size": 20,
"rows": [
{
"Clicks": "108659",
"Date": "2023-05-21",
"ECpm": "3.5032",
"GrossRevenue": "4993.61",
"ImpressionRate": "0.7554",
"Impressions": "1425449",
"NetRevenue": "4489.90",
"ResponseRate": "0.9389",
"TotalAdRequests": "1887114"
},
{
"Clicks": "256918",
"Date": "2023-05-20",
"ECpm": "3.0787",
"GrossRevenue": "10333.38",
"ImpressionRate": "0.7293",
"Impressions": "3356397",
"NetRevenue": "9299.60",
"ResponseRate": "0.9193",
"TotalAdRequests": "4602304"
},
{
"Clicks": "258177",
"Date": "2023-05-19",
"ECpm": "3.0077",
"GrossRevenue": "10218.46",
"ImpressionRate": "0.7343",
"Impressions": "3397479",
"NetRevenue": "9196.34",
"ResponseRate": "0.9274",
"TotalAdRequests": "4626907"
},
{
"Clicks": "285590",
"Date": "2023-05-18",
"ECpm": "2.8888",
"GrossRevenue": "10463.76",
"ImpressionRate": "0.7367",
"Impressions": "3622240",
"NetRevenue": "9417.05",
"ResponseRate": "0.9255",
"TotalAdRequests": "4917081"
},
{
"Clicks": "278347",
"Date": "2023-05-17",
"ECpm": "2.9590",
"GrossRevenue": "10629.62",
"ImpressionRate": "0.7399",
"Impressions": "3592269",
"NetRevenue": "9566.30",
"ResponseRate": "0.9309",
"TotalAdRequests": "4855091"
},
{
"Clicks": "270012",
"Date": "2023-05-16",
"ECpm": "3.1277",
"GrossRevenue": "11578.48",
"ImpressionRate": "0.7512",
"Impressions": "3701960",
"NetRevenue": "10420.25",
"ResponseRate": "0.9441",
"TotalAdRequests": "4928169"
},
{
"Clicks": "254855",
"Date": "2023-05-15",
"ECpm": "3.1371",
"GrossRevenue": "11030.40",
"ImpressionRate": "0.7421",
"Impressions": "3516067",
"NetRevenue": "9927.00",
"ResponseRate": "0.9341",
"TotalAdRequests": "4737724"
},
{
"Clicks": "252736",
"Date": "2023-05-14",
"ECpm": "2.9897",
"GrossRevenue": "10431.36",
"ImpressionRate": "0.7390",
"Impressions": "3489137",
"NetRevenue": "9387.79",
"ResponseRate": "0.9361",
"TotalAdRequests": "4721521"
}
],
"total": 8,
"total_rows": {
"Clicks": "1965294",
"ECpm": "3.0527",
"GrossRevenue": "79679.07",
"ImpressionRate": "0.7399",
"Impressions": "26100998",
"NetRevenue": "71704.23",
"ResponseRate": "0.9316",
"TotalAdRequests": "35275911"
}
},
"error": ""
}JAVA call example
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n" +
" \"date_range\":{\n" +
" \"start\":\"2023-11-20\",\n" +
" \"end\":\"2023-11-25\"\n" +
" },\n" +
" \"page_index\":1,\n" +
" \"filters\":{\n" +
"\n" +
" },\n" +
" \"sorts\":{\n" +
" \"Date\":-1\n" +
" },\n" +
" \"dimensions\":[\n" +
" \"Date\",\n" +
" \"Domain\"\n" +
" ],\n" +
" \"page_size\":20\n" +
"}");
Request request = new Request.Builder()
.url("https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v1/ssp/report
")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("x-apihub-env", "prod")
.addHeader("x-apihub-ak", "Replace your own token")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());Last updated