App Ads Report

Request URL

POST https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v2/ssp/app/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
begin_date	string	yes	Start time, 2023-10-25
end_date	string	yes	End time, 2023-10-28
app_os	[]string	no	App system version, IOS and ANDROID
app_name	[]string	no	app name
ad_format	[]string	no	adunit format
ad_name	[]string	no	adunit name
dimensions	[]string	yes	Statistical dimensions: Date (time), Os (app system version), App (app name), AdFormat (adunit format), AdZone (adunit name), Country (country)
page_index	Number	yes	Page number, 1
page_size	Number	yes	Page size, 100

Request example

{
    "begin_date":"2023-10-10",
    "end_date":"2023-10-28",
    "app_os":[
        "ANDROID"
    ],
    "app_name":[
        "app_name1"
    ],
    "ad_format":[
        "native"
    ],
    "ad_name":[
        "ad_name11"
    ],
    "dimensions":[
        "Date"
    ],
    "sorts":{
        "Date":-1
    },
    "page_index":1,
    "page_size":20
}

response parameter

Parameter name	Calculation method	describe
AdRequest		Ad requests
AdResponse		Ad response count
Clicks		Number of hits
Ecpm		ecpm
Impressions		Number of impressions
NetRevenue		income
Ctr	clicks/Impressions
AdFillRate	response/AdRequest
AdImpRate	impressions/AdResponse

Response example

  {
    "data":{
        "rows":[
            {
                "AdFillRate":"0.0103",
                "AdImpRate":"0.5791",
                "AdRequest":"1721904",
                "AdResponse":"17766",
                "Clicks":"803",
                "Ctr":"0.0780",
                "Date":"2023-10-28",
                "Ecpm":"7.32",
                "Impressions":"10290",
                "NetRevenue":"75.36"
            },
            {
                "AdFillRate":"0.0093",
                "AdImpRate":"0.5561",
                "AdRequest":"2088292",
                "AdResponse":"19612",
                "Clicks":"977",
                "Ctr":"0.0895",
                "Date":"2023-10-27",
                "Ecpm":"6.03",
                "Impressions":"10907",
                "NetRevenue":"65.86"
            },
            {
                "AdFillRate":"0.0087",
                "AdImpRate":"0.5820",
                "AdRequest":"1879962",
                "AdResponse":"16481",
                "Clicks":"933",
                "Ctr":"0.0972",
                "Date":"2023-10-26",
                "Ecpm":"7.42",
                "Impressions":"9593",
                "NetRevenue":"71.22"
            },
            {
                "AdFillRate":"0.0100",
                "AdImpRate":"0.5493",
                "AdRequest":"1181514",
                "AdResponse":"11875",
                "Clicks":"551",
                "Ctr":"0.0844",
                "Date":"2023-10-25",
                "Ecpm":"9.80",
                "Impressions":"6524",
                "NetRevenue":"63.97"
            }
        ],
        "total":4,
        "total_rows":[
            {
                "AdFillRate":"0.0095",
                "AdImpRate":"0.5676",
                "AdRequest":"6871672",
                "AdResponse":"65734",
                "Clicks":"3264",
                "Ctr":"0.0874",
                "Ecpm":"7.40",
                "Impressions":"37314",
                "NetRevenue":"276.42"
            }
        ]
    },
    "success":true
}

JAVA call example

OkHttpClient client = new OkHttpClient().newBuilder()
        .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n" +
        "    \"begin_date\": \"2023-10-25\",\n" +
        "    \"end_date\": \"2023-10-28\",\n" +
        "    \"app_os\": [],\n" +
        "    \"app_name\": [],\n" +
        "    \"ad_format\": [],\n" +
        "    \"ad_name\": [],\n" +
        "    \"dimensions\": [\n" +
        "        \"Date\"\n" +
        "    ],\n" +
        "    \"page_index\": 1,\n" +
        "    \"page_size\": 20\n" +
        "}");
Request request = new Request.Builder()
        .url("https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v2/ssp/app/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());