AFS Tracking Report

Request URL

POST https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v2/ssp/search/afs/trace/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, 2024-08-02
end_date	string	yes	End time, 2024-08-09
domain	[]string	no	siteId, for example: siteId1, siteId2
keyword	[]string	no	Keywords, for example: car
country	[]string	no	Country, for example: US
information	[]string	no	News article ID, for example: 63705bebbbebaf
utm_source	string	no	Tracking sources, such as: tikTok, taboola, facebook, outbrain, gateway, others, bigoads
sub1	string	no	Tracking Link 1
sub2	string	no	Tracking Link 2
sub3	string	no	Tracking Link 3
dimensions	[]string	yes	Dimension, enumeration value Date, Domain, Sub1, Sub2, Sub3, Keyword, Country, Information, UtmSource
page_index	Number	yes	Page number, 1
page_size	Number	yes	Page size, 100
sorts	Object	no	Sorting, 1 in ascending order, 2 in descending order, you can sort the fields: Date, Search_PV, Search_Click, Net_Revenue, Lp_PV. For example: {"Date":1}

Request example

{
    "keyword": [
        "cancer"
    ],
    "country": [
        "US"
    ],
    "domain": [
        "siteId1"
    ],
    "information": [
        "63705bebbbebaf"
    ],
    "utm_source": "tikTok",
    "sub1": "as",
    "sub2": "ac",
    "sub3": "ad",
    "begin_date": "2024-08-02",
    "end_date": "2024-08-09",
    "dimensions": [
        "Date",
        "Domain",
        "Keyword",
        "Country",
        "Information",
        "UtmSource",
        "Sub1",
        "Sub2",
        "Sub3"
    ],
    "sorts": {
        "Date": 1
    },
    "page_index": 1,
    "page_size": 10
}

response parameter

Parameter name	describe
Date	date
Domain	domain name
Country	nation
InformationId	Information Id
InformationTitle	Information Name
Keyword	Keywords
Lp_Pv	Landing page visits
Search_Click	Search clicks
Search_Pv	Search traffic
UtmSource	Tracking Source
Sub1	Tracking Link 1
Sub2	Tracking Link 2
Sub3	Tracking Link 3
Net_Revenue	Revenue data

Response example

{
    "data": {
        "rows": [
            {
                "Country": "US",
                "Date": "2024-07-09",
                "Domain": "testdemo.com",
                "InformationId": "63705bebbbeb",
                "InformationTitle": "7 Types of Massage demo title",
                "Keyword": "Cancer",
                "Lp_Pv": "147",
                "Search_Click": "7",
                "Search_Pv": "83",
                "Sub1": "",
                "Sub2": "",
                "Sub3": "",
                "UtmSource": "tikTok",
                "Net_Revenue": "71.82"
            }
        ],
        "total": 1,
        "total_rows": [
            {
                "Lp_Pv": "147",
                "Search_Click": "7",
                "Search_Pv": "83",
                "Net_Revenue": "71.82"
            }
        ]
    },
    "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" +
        "\n" +
        "    ],\n" +
        "    \"country\": [\n" +
        "        \"US\"\n" +
        "    ],\n" +
        "    \"domain\": [\n" +
        "\n" +
        "    ],\n" +
        "    \"information\": [\n" +
        "\n" +
        "    ],\n" +
        "    \"utm_source\": \"tikTok\",\n" +
        "    \"sub1\": \"\",\n" +
        "    \"sub2\": \"\",\n" +
        "    \"sub3\": \"\",\n" +
        "    \"begin_date\": \"2024-08-02\",\n" +
        "    \"end_date\": \"2024-08-09\",\n" +
        "    \"dimensions\": [\n" +
        "        \"Date\",\n" +
        "        \"Domain\",\n" +
        "        \"Keyword\",\n" +
        "        \"Country\",\n" +
        "        \"Information\",\n" +
        "        \"UtmSource\",\n" +
        "        \"Sub1\",\n" +
        "        \"Sub2\",\n" +
        "        \"Sub3\"\n" +
        "    ],\n" +
        "    \"page_index\": 1,\n" +
        "    \"page_size\": 10\n" +
        "}");
Request request = new Request.Builder()
        .url("https://api-us-east.eclicktech.com.cn/wgt/report/gamebridge/v2/ssp/search/afs/trace/report")
        .method("POST", body)
        .addHeader("Content-Type", "application/json")
        .addHeader("x-apihub-env", "prod")
        .addHeader("x-apihub-ak", "Replace your token")
        .build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());