跳转至

数据报表接口

接口

获取广告主组基本数据,包括花费、点击量、点击单价等

请求地址

https://openapi.aiclk.com/openapi/v1/report/get

所属权限

ads_read

请求方式

GET

频次限制规则

秒级限制(次)
50

请求参数

请求参数字段:

字段名 类型 必须 描述
account_id number 是 查询的广告账户ID(广告投放平台的userID)
query string(json object) 是 查询参数结构体,具体结构如下

query格式:

字段名 类型 必须 描述
start_date string 是 开始日期,格式YYYY-MM-DD
日期不超过当前日期的365天;按天粒度查询时,与结束日期跨度不超过10天;按小时粒度查询时,与结束日期跨度不超过3天
end_date string 是 结束日期,格式YYYY-MM-DD
按天粒度查询时,与开始日期跨度不超过10天;按小时粒度查询时,与开始日期跨度不超过3天
level string 是 按照查询维度填写:(account/campaign/ad_group/creative)
page int 否 页数
page_size int 否 每页的数据个数
group_by []string 否 分组依据(STAT_GROUP_BY_FIELD_STAT_TIME:按时间分组;STAT_GROUP_BY_FIELD_STAT_ID:按ID分组;同时传两个代表按时间和id分组)
time_granularity string 否 时间粒度:"date"表示天,"hour"表示小时
fields []string 否 详细字段见数据报表字段定义
order_field string 否 排序字段,返回的字段均支持排序
order_type string 否 排序类型
filtering object 否 过滤条件,格式为map,
key允许的值包括:campaign_id,adgroup_id,creative_id
value允许的值为int数组:[66666,88888]

留存字段可与其他报表字段一起查询:retention_total_days_7d、lt7、retention_avg_rate_7d、retention_cost_7d。留存总天数为T1至T7留存数之和;lt7为留存总天数与D0浅层转化数的比值;7日平均日留存率按7天计算。分母为0时,相关指标返回0。

query例子

{
    "start_date": "2021-02-01",
    "end_date": "2021-02-01",
    "level": "creative",
    "group_by": [
        "STAT_GROUP_BY_FIELD_STAT_ID",
        "STAT_GROUP_BY_FIELD_STAT_TIME"
    ],
    "time_granularity": "date",
    "fields": [
        "impression",
        "load",
        "stay_10",
        "api_app_active",
        "api_app_register",
        "api_app_register_rate",
        "api_app_register_cost",
        "next_day_open",
        "api_app_staytwo",
        "api_app_staythree",
        "api_app_stayfour",
        "api_app_stayfive",
        "api_app_staysix",
        "api_app_stayseven",
        "retention_total_days_7d",
        "lt7",
        "retention_avg_rate_7d",
        "retention_cost_7d",
        "app_first_pay",
        "api_lp_sform",
        "api_app_other",
        "api_lp_other",
        "js_copywx",
        "js_form_click",
        "api_copy_sign",
        "api_app_lahuo"
    ],
    "order_field": "date",
    "order_type": "asc"
}

请求示例

curl -X GET \
  'https://openapi.aiclk.com/openapi/v1/report/get?account_id=1596469&query={"start_date":"2021-02-01","end_date":"2021-02-01","level":"creative","group_by":["STAT_GROUP_BY_FIELD_STAT_ID","STAT_GROUP_BY_FIELD_STAT_TIME"],"time_granularity":"date","fields":["impression","load","stay_10","api_app_active","api_app_register","api_app_register_rate","api_app_register_cost","next_day_open","app_first_pay","api_lp_sform","api_app_other","api_lp_other","js_copywx","js_form_click","api_copy_sign","api_app_lahuo"],"order_field":"date","order_type":"asc"}' \
  -H 'OGW_ACCESS_TOKEN: your_access_token' \

返回格式:

{
    "code": 200,
    "data": {
        "list": [
            {
                "account_id": "1764081",
                "adgroup_id": "3292000",
                "adgroup_name": "502",
                "api_app_active": 0,
                "api_app_lahuo": 0,
                "api_app_other": 0,
                "api_app_register": 0,
                "api_app_register_rate": 0,
                "api_app_register_cost": 0,
                "api_copy_sign": 0,
                "api_lp_other": 0,
                "api_lp_sform": 0,
                "app_first_pay": 0,
                "campaign_id": "2753897",
                "campaign_name": "剧502-趣头条-列表页-竖版激励-美食-xxx",
                "creative_id": "6800397",
                "creative_name": "502",
                "date": "2021-02-01",
                "impression": 328,
                "js_copywx": 0,
                "js_form_click": 0,
                "load": 22,
                "next_day_open": 0,
                "stay_10": 17
            },
            {
                "account_id": "1764081",
                "adgroup_id": "3484186",
                "adgroup_name": "498_程序化创意",
                "api_app_active": 10,
                "api_app_lahuo": 0,
                "api_app_other": 0,
                "api_app_register": 0,
                "api_app_register_rate": 0,
                "api_app_register_cost": 0,
                "api_copy_sign": 0,
                "api_lp_other": 0,
                "api_lp_sform": 0,
                "app_first_pay": 0,
                "campaign_id": "2923859",
                "campaign_name": "剧498-趣头条-激励视频-xxx程序化创意",
                "creative_id": "7387478",
                "creative_name": "xxxx_2",
                "date": "2021-02-01",
                "impression": 38782,
                "js_copywx": 0,
                "js_form_click": 0,
                "load": 382,
                "next_day_open": 8,
                "stay_10": 347
            }...
        ],
        "page_info": {
            "page": 1,
            "page_size": 100,
            "total_number": 1625
        }
    },
    "message": "success",
    "trace_id": "1322e8c37ddd3db1"
}