AFS Main Keyword Data

Request URL

POST https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v2/ssp/search/afs/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
domain	[]string	no	siteId, for example: siteId1, siteId2
country	[]string	no	Country code, such as CN, US
keyword	[]string	no	Keywords, such as car
dimensions	[]string	yes	Dimension, enumeration value Date, Domain, Keyword, Country
page_index	Number	yes	Page number, 1
page_size	Number	yes	Page size, 100

Request example

{
    "keyword": [
        "kw1",
        "kw2",
        "kw3"
    ],
    "country": [
        "US"
    ],
    "domain": [
        "site1",
        "site2"
    ],
    "begin_date": "2024-07-23",
    "end_date": "2024-07-30",
    "dimensions": [
        "Date",
        "Domain",
        "Keyword",
        "Country"
    ],
    "page_index": 1,
    "page_size": 20
}

response parameter

Parameter name	Calculation method	describe
Date		date
Domain		Site
Country		Country Code
Impressions		Number of impressions
NetRevenue		income
Clicks		Number of hits
Lp_pv		Keyword landing page (delivery page) PV
Search_pv		Keyword result page (advertising page) PV
Keyword		Keywords

Response example

  {
    "data": {
        "rows": [
            {
                "Clicks": "89",
                "Country": "US",
                "Date": "2024-07-30",
                "Domain": "test.demo.com",
                "Impressions": "116",
                "Keyword": "cancer",
                "Lp_pv": "90",
                "Net_revenue": "50.63",
                "Search_pv": "23"
            },
            {
                "Clicks": "174",
                "Country": "US",
                "Date": "2024-07-29",
                "Domain": "test.demo.com",
                "Impressions": "246",
                "Keyword": "cancer",
                "Lp_pv": "668",
                "Net_revenue": "104.85",
                "Search_pv": "218"
            },
            {
                "Clicks": "177",
                "Country": "US",
                "Date": "2024-07-28",
                "Domain": "test.demo.com",
                "Impressions": "224",
                "Keyword": "cancer",
                "Lp_pv": "650",
                "Net_revenue": "111.60",
                "Search_pv": "219"
            },
            {
                "Clicks": "118",
                "Country": "US",
                "Date": "2024-07-27",
                "Domain": "test.demo.com",
                "Impressions": "176",
                "Keyword": "cancer",
                "Lp_pv": "664",
                "Net_revenue": "84.08",
                "Search_pv": "210"
            },
            {
                "Clicks": "131",
                "Country": "US",
                "Date": "2024-07-26",
                "Domain": "test.demo.com",
                "Impressions": "172",
                "Keyword": "cancer",
                "Lp_pv": "499",
                "Net_revenue": "130.71",
                "Search_pv": "172"
            },
            {
                "Clicks": "53",
                "Country": "US",
                "Date": "2024-07-25",
                "Domain": "test.demo.com",
                "Impressions": "70",
                "Keyword": "cancer",
                "Lp_pv": "384",
                "Net_revenue": "56.46",
                "Search_pv": "137"
            }
        ],
        "total": 6,
        "total_rows": [
            {
                "Clicks": "742",
                "Impressions": "1004",
                "Lp_pv": "2955",
                "Net_revenue": "538.31",
                "Search_pv": "979"
            }
        ]
    },
    "success": true
}

JAVA call example

OkHttpClient client = new OkHttpClient().newBuilder()
        .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n" +
        "    \"keyword\": [\n" +
        "        \"cancer\"\n" +
        "    ],\n" +
        "    \"country\": [\n" +
        "        \"US\"\n" +
        "    ],\n" +
        "    \"domain\": [\n" +
        "        \"site1\"\n" +
        "    ],\n" +
        "    \"begin_date\": \"2024-07-23\",\n" +
        "    \"end_date\": \"2024-07-30\",\n" +
        "    \"dimensions\": [\n" +
        "        \"Date\",\n" +
        "        \"Domain\",\n" +
        "        \"Keyword\",\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/v2/ssp/search/afs/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());