Search Ads Revenue

Request URL

POST https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v1/ssp/search/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
domains	[]string	no	siteId, for example: siteId1, siteId2
dimensions	[]string	yes	Dimension, enumeration value Date, Domain
page_index	Number	yes	Page number, 1
page_size	Number	yes	Page size, 100

Request example

{
  "begin_date": "2023-09-10",
  "end_date": "2023-09-12",
  "domains": [
    "siteId1",
    "siteId2"
  ],
  "dimensions": [
    "Date",
    "Domain"
  ],
  "page_index": 1,
  "page_size": 20
}

response parameter

Parameter name	Calculation method	describe
Date		Ad response count
Domain		Number of hits
Country		Country Code
Ecpm		EC PM
Impressions		Number of impressions
NetRevenue		income
GrossRevenue		Total revenue
Clicks		Number of hits
AdRequest		Ad requests
FillRate	Impressions/AdRequest	Fill rate

Response example

  {
    "data": {
        "rows": [
            {
                "AdRequest": "23822",
                "Clicks": "2064",
                "Date": "2023-05-22",
                "ECpm": "10.10",
                "FillRate": "0.4727",
                "GrossRevenue": "113.76",
                "Impressions": "11260",
                "NetRevenue": "91.01"
            },
            {
                "AdRequest": "448708",
                "Clicks": "41250",
                "Date": "2023-05-21",
                "ECpm": "10.86",
                "FillRate": "0.4715",
                "GrossRevenue": "2297.22",
                "Impressions": "211557",
                "NetRevenue": "1837.78"
            },
            {
                "AdRequest": "457311",
                "Clicks": "43331",
                "Date": "2023-05-20",
                "ECpm": "11.48",
                "FillRate": "0.4731",
                "GrossRevenue": "2484.76",
                "Impressions": "216350",
                "NetRevenue": "1987.81"
            },
            {
                "AdRequest": "437869",
                "Clicks": "40271",
                "Date": "2023-05-19",
                "ECpm": "10.84",
                "FillRate": "0.4607",
                "GrossRevenue": "2186.98",
                "Impressions": "201708",
                "NetRevenue": "1749.58"
            },
            {
                "AdRequest": "471414",
                "Clicks": "45605",
                "Date": "2023-05-18",
                "ECpm": "11.34",
                "FillRate": "0.4822",
                "GrossRevenue": "2577.48",
                "Impressions": "227332",
                "NetRevenue": "2061.99"
            },
            {
                "AdRequest": "412707",
                "Clicks": "41892",
                "Date": "2023-05-17",
                "ECpm": "12.00",
                "FillRate": "0.4773",
                "GrossRevenue": "2363.45",
                "Impressions": "196982",
                "NetRevenue": "1890.76"
            },
            {
                "AdRequest": "386814",
                "Clicks": "39040",
                "Date": "2023-05-16",
                "ECpm": "11.82",
                "FillRate": "0.4874",
                "GrossRevenue": "2228.55",
                "Impressions": "188550",
                "NetRevenue": "1782.84"
            },
            {
                "AdRequest": "395767",
                "Clicks": "39708",
                "Date": "2023-05-15",
                "ECpm": "11.98",
                "FillRate": "0.4844",
                "GrossRevenue": "2295.65",
                "Impressions": "191698",
                "NetRevenue": "1836.52"
            }
        ],
        "total": 8,
        "total_rows": [
            {
                "AdRequest": "3034412",
                "Clicks": "293161",
                "ECpm": "11.45",
                "FillRate": "0.4763",
                "GrossRevenue": "16547.84",
                "Impressions": "1445437",
                "NetRevenue": "13238.28"
            }
        ]
    },
    "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-09-10\",\n" +
                "  \"end_date\": \"2023-09-12\",\n" +
                "  \"domains\": [\n" +
                "    \"siteId1\",\n" +
                "    \"siteId2\"\n" +
                "  ],\n" +
                "  \"country_code\": [],\n" +
                "  \"dimensions\": [\n" +
                "    \"Date\",\n" +
                "    \"Domain\",\n" +
                "    \"Country\"\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/v1/ssp/search/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());