Reports API v1

Miaozhen AdMonitor / Reports API v1

基础数据报告

请求地址

GET /admonitor/v1/reports/basic/show

参数

名称必选格式示例描述
date true YYYY-MM-DD 2012-12-25 截止日期
campaign_id true ID 2 广告活动ID
by_position false PDIM publisher 设定报告活动维度。PDIM可以是campaign（默认，分活动）,publisher（分媒体）或spot（分广告位）或keyword（分关键词）。
by_audience false ADIM stable 设定报告受众人群维度。ADIM可以是overall（默认，所有网民）,stable（稳定人群）或target（目标人群）。
by_region false RDIM level 1 设定报告地域维度。RDIM可以是level0（默认，全球和中国大陆），level1（省级）或level2（地级市级）。
platform false PTDIM pc 设定报告平台维度。PTDIM可以是pc（默认），pm，mb（移动）。
publisher_id false ID1，ID2，... 1,2,3 媒体ID，支持批量输入（英文半角逗号分隔）。仅当by_position=publisher或by_position=spot或by_position=keyword时，才有效。
spot_id false ID1，ID2，... 22,23 点位ID，支持批量输入（英文半角逗号分隔）。仅当by_position=spot或by_position=keyword时，才有效。
keyword_id false ID1，ID2，... 4018469, 4018470,… 关键词ID，支持批量输入（英文半角逗号分隔）。仅当by_position=keyword时，才有效。
target_id false ID1，ID2，... 22,23 目标人群ID，支持批量输入（英文半角逗号分隔）。仅当by_audience=target时，才有效。
region_id false ID1，ID2，... 22,23 地域ID，支持批量输入（英文半角逗号分隔）。
metrics false MSCO all 设定返回指标的范围。MSCO可能是acc（默认，累计维度），day（单天维度），avg_day（平均单天维度），acc_hrs（分小时累计维度）或者 all。
sdk false sdk all 设定sdk的类型。只有在platform = mb，metrics = all或metrics = acc和by_position = campaign或by_position = publisher时，才有效。SDK可以是all（默认）mm（MMA SDK）或mz（秒针SDK）。
filtration_type false net 设定过滤类型。枚举值：net或totalnet；默认为net
access_token true 1.2YotnFZFEjr1zCsi 用于验证登录的访问令牌串
limit false M，N 0,2 用于限制返回结果条数，仅当by_position=publisher或by_position=spot或by_position=keyword时有效。格式：M,N，默认为0,500，M为起始序号（默认序号第一位为0），N为结果中的spot个数。
order_asc false NAME spot_id 可以是任何属性名称或指标名称。
order_desc false NAME imp_day 可以是任何属性名称或指标名称。
with_null false INT 0 输入1时会返回查询结果为null的指标维度，默认不输出结果为null的item。

名称	必选	格式	示例	描述
date	true	YYYY-MM-DD	2012-12-25	截止日期
campaign_id	true	ID	2	广告活动ID
by_position	false	PDIM	publisher	设定报告活动维度。PDIM可以是campaign（默认，分活动）,publisher（分媒体）或spot（分广告位）或keyword（分关键词）。
by_audience	false	ADIM	stable	设定报告受众人群维度。ADIM可以是overall（默认，所有网民）,stable（稳定人群）或target（目标人群）。
by_region	false	RDIM	level 1	设定报告地域维度。RDIM可以是level0（默认，全球和中国大陆），level1（省级）或level2（地级市级）。
platform	false	PTDIM	pc	设定报告平台维度。PTDIM可以是pc（默认），pm，mb（移动）。
publisher_id	false	ID1，ID2，...	1,2,3	媒体ID，支持批量输入（英文半角逗号分隔）。仅当by_position=publisher或by_position=spot或by_position=keyword时，才有效。
spot_id	false	ID1，ID2，...	22,23	点位ID，支持批量输入（英文半角逗号分隔）。仅当by_position=spot或by_position=keyword时，才有效。
keyword_id	false	ID1，ID2，...	4018469, 4018470,…	关键词ID，支持批量输入（英文半角逗号分隔）。仅当by_position=keyword时，才有效。
target_id	false	ID1，ID2，...	22,23	目标人群ID，支持批量输入（英文半角逗号分隔）。仅当by_audience=target时，才有效。
region_id	false	ID1，ID2，...	22,23	地域ID，支持批量输入（英文半角逗号分隔）。
metrics	false	MSCO	all	设定返回指标的范围。MSCO可能是acc（默认，累计维度），day（单天维度），avg_day（平均单天维度），acc_hrs（分小时累计维度）或者 all。
sdk	false	sdk	all	设定sdk的类型。只有在platform = mb，metrics = all或metrics = acc和by_position = campaign或by_position = publisher时，才有效。SDK可以是all（默认）mm（MMA SDK）或mz（秒针SDK）。
filtration_type	false		net	设定过滤类型。枚举值：net或totalnet；默认为net
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数，仅当by_position=publisher或by_position=spot或by_position=keyword时有效。格式：M,N，默认为0,500，M为起始序号（默认序号第一位为0），N为结果中的spot个数。
order_asc	false	NAME	spot_id	可以是任何属性名称或指标名称。
order_desc	false	NAME	imp_day	可以是任何属性名称或指标名称。
with_null	false	INT	0	输入1时会返回查询结果为null的指标维度，默认不输出结果为null的item。

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）。

当by_audience=overall时才可查询关键词数据，如输入条件不满足则keyword数据为空。

响应示例


{
"campaign_id": 1,
"date": "2012-10-20",
"version": "V1.0",
"platform": "pc",
"total_spot_num": 123
"items":
[
{
 "attributes":
 {
     "audience": "target",
     "target_id": "1",
     "publisher_id": "1",
     "spot_id": "40",
     "spot_id_str": "e",
     "region_id": "00001234",
     "universe": 12345
},
"metrics":
{
     "imp_acc": 0,
     "clk_acc": 0,
     "uim_acc": 0,
     "ucl_acc": 0,
     "imp_day": 0,
     "clk_day": 0,
     "uim_day": 0,
     "ucl_day": 0,
    "imp_avg_day": 0,
     "clk_avg_day": 0,
     "uim_avg_day": 0,
     "ucl_avg_day": 0,
     "imp_acc_h00": 0,
     "clk_acc_h00": 0
      ...
}
},
...
]
}

名称类型描述
audience string 报告受众人群维度，overall（所有网民）或stable（稳定人群）或target（目标人群）。
target_id string 目标人群ID，当by_audience=target时，可用。
publisher_id string 媒体ID，当by_position=publisher或by_position=spot或by_position=keyword时，可用
spot_id string 点位ID，当by_position=spot或by_position=keyword时，可用
keyword_id string 关键词ID，当by_position=keyword时，可用
region_id string 地域ID。
imp_acc int 累计的曝光。当metrics=acc或metrics=all时，可用。
clk_acc int 累计的点击。当metrics=acc或metrics=all时，可用。
uim_acc int 累计的独立访问者（UV）。当metrics=acc或metrics=all时，可用。
ucl_acc int 累计的点击人数（clicker）。当metrics=acc或metrics=all时，可用。
imp_day int 当天的曝光。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
clk_day int 当天点击。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
uim_day int 当天的UV。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
ucl_day int 当天的clicker。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
imp_avg_day int 每日平均曝光量。当metrics=avg_day或metrics=all时，可用。
clk_avg_day int 平均每日点击量。当metrics=avg_day或metrics=all时，可用。
uim_avg_day int 平均每日UV。当metrics=avg_day或metrics=all时，可用。
ucl_avg_day int 平均每日clicker。当metrics=avg_day或metrics=all时，可用。
imp_acc_h00 int 00:00 - 00:59累计的曝光。当metrics=acc_hrs或metrics=all时，可用。
imp_acc_h23 int 23:00 - 23:59累计的曝光。当metrics=acc_hrs或metrics=all时，可用。
clk_acc_h00 int 00:00 - 00:59累计的点击。当metrics=acc_hrs或metrics=all时，可用。
clk_acc_h23 int 23:00 - 23:59累计的点击。当metrics=acc_hrs或metrics=all时，可用。
total_spot_num int 本次请求涉及的spot个数总量，使用limit分页时应参考该指标，对于输入的limit值，M小于该指标且M+N不超过该指标即可。

名称	类型	描述
audience	string	报告受众人群维度，overall（所有网民）或stable（稳定人群）或target（目标人群）。
target_id	string	目标人群ID，当by_audience=target时，可用。
publisher_id	string	媒体ID，当by_position=publisher或by_position=spot或by_position=keyword时，可用
spot_id	string	点位ID，当by_position=spot或by_position=keyword时，可用
keyword_id	string	关键词ID，当by_position=keyword时，可用
region_id	string	地域ID。
imp_acc	int	累计的曝光。当metrics=acc或metrics=all时，可用。
clk_acc	int	累计的点击。当metrics=acc或metrics=all时，可用。
uim_acc	int	累计的独立访问者（UV）。当metrics=acc或metrics=all时，可用。
ucl_acc	int	累计的点击人数（clicker）。当metrics=acc或metrics=all时，可用。
imp_day	int	当天的曝光。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
clk_day	int	当天点击。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
uim_day	int	当天的UV。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
ucl_day	int	当天的clicker。当metrics=day或metrics=all时，可用。但当by_audience=target时无效。
imp_avg_day	int	每日平均曝光量。当metrics=avg_day或metrics=all时，可用。
clk_avg_day	int	平均每日点击量。当metrics=avg_day或metrics=all时，可用。
uim_avg_day	int	平均每日UV。当metrics=avg_day或metrics=all时，可用。
ucl_avg_day	int	平均每日clicker。当metrics=avg_day或metrics=all时，可用。
imp_acc_h00	int	00:00 - 00:59累计的曝光。当metrics=acc_hrs或metrics=all时，可用。
imp_acc_h23	int	23:00 - 23:59累计的曝光。当metrics=acc_hrs或metrics=all时，可用。
clk_acc_h00	int	00:00 - 00:59累计的点击。当metrics=acc_hrs或metrics=all时，可用。
clk_acc_h23	int	23:00 - 23:59累计的点击。当metrics=acc_hrs或metrics=all时，可用。
total_spot_num	int	本次请求涉及的spot个数总量，使用limit分页时应参考该指标，对于输入的limit值，M小于该指标且M+N不超过该指标即可。

实时数据报告

请求地址

GET /admonitor/v1/reports/realtime/show

参数

名称必选格式示例描述
date true YYYY-MM-DD 2012-12-25 日期
campaign_id true ID 2 广告活动ID
by_position false PDIM publisher 设定报告活动维度。PDIM可以是campaign（默认，分活动）,publisher（分媒体）或spot（分广告位）。
platform false PTDIM pc 设定报告平台维度。PTDIM可为pc（默认）或pm，mb（移动）。
publisher_id false ID1，ID2，... 1,2,3 媒体ID，支持批量输入（英文半角逗号分隔）。仅当by_position=publisher或by_position=spot，才有效。
spot_id false ID1，ID2，... 22,23 点位ID，支持批量输入（英文半角逗号分隔）。仅当by_position=spot，才有效
metrics false MSCO All 设定返回指标的范围。MSCO可以是day（默认，单天维度），hrs（分小时维度）或all（全部）。
access_token true 1.2YotnFZFEjr1zCsi 用于验证登录的访问令牌串
limit false M，N 0,2 用于限制返回结果条数，仅当by_position=publisher或by_position=spot或by_position=keyword时有效。格式：M,N，默认为0,500，M为起始序号（默认序号第一位为0），N为结果中的spot个数。
order_asc false NAME spot_id 可以是任何属性名称或指标名称。
order_desc false NAME imp_day 可以是任何属性名称或指标名称。

名称	必选	格式	示例	描述
date	true	YYYY-MM-DD	2012-12-25	日期
campaign_id	true	ID	2	广告活动ID
by_position	false	PDIM	publisher	设定报告活动维度。PDIM可以是campaign（默认，分活动）,publisher（分媒体）或spot（分广告位）。
platform	false	PTDIM	pc	设定报告平台维度。PTDIM可为pc（默认）或pm，mb（移动）。
publisher_id	false	ID1，ID2，...	1,2,3	媒体ID，支持批量输入（英文半角逗号分隔）。仅当by_position=publisher或by_position=spot，才有效。
spot_id	false	ID1，ID2，...	22,23	点位ID，支持批量输入（英文半角逗号分隔）。仅当by_position=spot，才有效
metrics	false	MSCO	All	设定返回指标的范围。MSCO可以是day（默认，单天维度），hrs（分小时维度）或all（全部）。
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数，仅当by_position=publisher或by_position=spot或by_position=keyword时有效。格式：M,N，默认为0,500，M为起始序号（默认序号第一位为0），N为结果中的spot个数。
order_asc	false	NAME	spot_id	可以是任何属性名称或指标名称。
order_desc	false	NAME	imp_day	可以是任何属性名称或指标名称。

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）；目前的实时报告仅提供全球的所有网民的数据。

响应示例


xxxxxxxxxx
{
"campaign_id": 1,
"date": "2012-10-20",
"platform": "pc",
"total_spot_num": 123,
"items":
[
{
 "attributes":
 {
     "audience": "overall",
     "region_id": "000000000000",
     "publisher_id": "2",
     "spot_id": "40",
     "spot_id_str": "e"
 },
 "metrics":
 {
     "imp_day": 123000,
     "clk_day": 754,
     "imp_h00": 21,
     "clk_h00": 1,
     ...
     "imp_h23": 56,
     "clk_h23": 1
 }
},
...
]
}

名称类型描述
audience string 报告受众人群维度，只有overall（所有网民）。
region_id string 地域ID。
publisher_id string 媒体ID，当是by_position=publisher或by_position=spot，可用。
spot_id string 点位ID，当是by_position=spot，可用。
spot_id_str string spot_id的62进制字符串表示形式。
imp_day int 当天的曝光。当是metrics=day或metrics=all，可用
clk_day int 当天的点击。当是metrics=day或metrics=all，可用。
imp_h00 int 当天00:00 - 00:59的曝光。当是metrics=hrs或metrics=all，可用。
imp_h23 int 当天23:00 - 23:59的曝光。当是metrics=hrs或metrics=all，可用。
clk_h00 int 当天00:00 - 00:59的点击。当是metrics=hrs或metrics=all，可用。
clk_h23 int 当天23:00 - 23:59的点击。当是metrics=hrs或metrics=all，可用。
total_spot_num int 本次请求涉及的spot个数总量，使用limit分页时应参考该指标，对于输入的limit值，M小于该指标且M+N不超过该指标即可。

名称	类型	描述
audience	string	报告受众人群维度，只有overall（所有网民）。
region_id	string	地域ID。
publisher_id	string	媒体ID，当是by_position=publisher或by_position=spot，可用。
spot_id	string	点位ID，当是by_position=spot，可用。
spot_id_str	string	spot_id的62进制字符串表示形式。
imp_day	int	当天的曝光。当是metrics=day或metrics=all，可用
clk_day	int	当天的点击。当是metrics=day或metrics=all，可用。
imp_h00	int	当天00:00 - 00:59的曝光。当是metrics=hrs或metrics=all，可用。
imp_h23	int	当天23:00 - 23:59的曝光。当是metrics=hrs或metrics=all，可用。
clk_h00	int	当天00:00 - 00:59的点击。当是metrics=hrs或metrics=all，可用。
clk_h23	int	当天23:00 - 23:59的点击。当是metrics=hrs或metrics=all，可用。
total_spot_num	int	本次请求涉及的spot个数总量，使用limit分页时应参考该指标，对于输入的limit值，M小于该指标且M+N不超过该指标即可。

到达人群报告

请求地址

GET /admonitor/v1/reports/reach/show

参数

名称必选格式示例描述
date true YYYY-MM-DD 2012-12-25 截止日期
campaign_id true ID 2 广告活动ID
by_position false PDIM publisher 设定报告活动维度。PDIM可以是campaign（默认，分活动）,publisher（分媒体）或spot（分广告位）。
by_audience false ADIM stable 设定报告受众人群维度。ADIM可以是overall（默认，所有网民）,stable（稳定人群）或target（目标人群）。
by_region false RDIM level 1 设定报告地域维度。RDIM可以是level0（默认，全球和中国大陆），level1（省级）或level2（地级市级）。
platform false PTDIM PC 设定报告平台类型维度。PTDIM可能是pc（默认）或pm，mb（移动）。
publisher_id false ID1，ID2，... 1,2,3 媒体ID，支持批量输入（英文半角逗号分隔）。只有在by_position=publisher或by_position=spot
spot_id false ID1，ID2，... 22,23 点位ID，支持批量输入（英文半角逗号分隔）。仅当by_position=spot时，才有效。
target_id false ID1，ID2，... 22,23 目标人群ID，支持批量输入（英文半角逗号分隔）。仅当by_audience=target时，才有效。
region_id false ID1，ID2，... 22,23 地域ID，支持批量输入（英文半角逗号分隔）。
metrics false MSCO all 设定返回指标的范围。MSCO可以是all（默认），acc（累计维度）或spl（相交样本量）。
filtration_type false net 设定过滤类型。枚举值：net或totalnet；默认为net。
access_token true 1.2YotnFZFEjr1zCsi 用于验证登录的访问令牌串
limit false M，N 0,2 用于限制返回结果条数，仅当by_position=publisher或by_position=spot或by_position=keyword时有效。格式：M,N，默认为0,500，M为起始序号（默认序号第一位为0），N为结果中的spot个数。
order_asc false NAME spot_id 可以是任何属性名称或指标名称。
order_desc false NAME imp_acc 可以是任何属性名称或指标名称。
with_null false INT 0 输入1时会返回查询结果为null的指标维度，默认不输出结果为null的item。

名称	必选	格式	示例	描述
date	true	YYYY-MM-DD	2012-12-25	截止日期
campaign_id	true	ID	2	广告活动ID
by_position	false	PDIM	publisher	设定报告活动维度。PDIM可以是campaign（默认，分活动）,publisher（分媒体）或spot（分广告位）。
by_audience	false	ADIM	stable	设定报告受众人群维度。ADIM可以是overall（默认，所有网民）,stable（稳定人群）或target（目标人群）。
by_region	false	RDIM	level 1	设定报告地域维度。RDIM可以是level0（默认，全球和中国大陆），level1（省级）或level2（地级市级）。
platform	false	PTDIM	PC	设定报告平台类型维度。PTDIM可能是pc（默认）或pm，mb（移动）。
publisher_id	false	ID1，ID2，...	1,2,3	媒体ID，支持批量输入（英文半角逗号分隔）。只有在by_position=publisher或by_position=spot
spot_id	false	ID1，ID2，...	22,23	点位ID，支持批量输入（英文半角逗号分隔）。仅当by_position=spot时，才有效。
target_id	false	ID1，ID2，...	22,23	目标人群ID，支持批量输入（英文半角逗号分隔）。仅当by_audience=target时，才有效。
region_id	false	ID1，ID2，...	22,23	地域ID，支持批量输入（英文半角逗号分隔）。
metrics	false	MSCO	all	设定返回指标的范围。MSCO可以是all（默认），acc（累计维度）或spl（相交样本量）。
filtration_type	false		net	设定过滤类型。枚举值：net或totalnet；默认为net。
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数，仅当by_position=publisher或by_position=spot或by_position=keyword时有效。格式：M,N，默认为0,500，M为起始序号（默认序号第一位为0），N为结果中的spot个数。
order_asc	false	NAME	spot_id	可以是任何属性名称或指标名称。
order_desc	false	NAME	imp_acc	可以是任何属性名称或指标名称。
with_null	false	INT	0	输入1时会返回查询结果为null的指标维度，默认不输出结果为null的item。

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）。

响应示例


xxxxxxxxxx
{
"campaign_id": 1,
"date": "2012-10-20",
"version": "V1.0",
"platform": "pc",
"total_spot_num": 123,
"items":
[
{
 "attributes":
 {
     "target_id": "1",
     "publisher_id": "1",
     "region_id": "12345678",
     "universe": 360000
}
"metrics":
{
     "imp_acc": 0,
     "grp_acc": 0,
     "rch_acc_p01": 0,
     ...
     "rch_acc_p10": 0,
     "rch_spl_p01": 0,
     ...
     "rch_spl_p10": 0
}
},
...
]
}

名称类型描述
imp_acc int 累计的曝光。当是metrics=acc或metrics=all时，可用。
grp_acc int 累计的GRP。当是metrics=acc或metrics=all时，可用。
rch_acc_p01 int 累积1+到达。当是metrics=acc或metrics=all时，可用。
rch_acc_p10 int 累积10+到达。当是metrics=acc或metrics=all时，可用。
rch_spl_p01 int 1+到达相交样本量。当是metrics=spl或metrics=all时，可用。
rch_spl_p10 int 10+到达相交样本量。当是metrics=spl或metrics=all时，可用。
total_spot_num int 本次请求涉及的spot个数总量，使用limit分页时应参考该指标，对于输入的limit值，M小于该指标且M+N不超过该指标即可。

名称	类型	描述
imp_acc	int	累计的曝光。当是metrics=acc或metrics=all时，可用。
grp_acc	int	累计的GRP。当是metrics=acc或metrics=all时，可用。
rch_acc_p01	int	累积1+到达。当是metrics=acc或metrics=all时，可用。
rch_acc_p10	int	累积10+到达。当是metrics=acc或metrics=all时，可用。
rch_spl_p01	int	1+到达相交样本量。当是metrics=spl或metrics=all时，可用。
rch_spl_p10	int	10+到达相交样本量。当是metrics=spl或metrics=all时，可用。
total_spot_num	int	本次请求涉及的spot个数总量，使用limit分页时应参考该指标，对于输入的limit值，M小于该指标且M+N不超过该指标即可。

活动计算进度

请求地址

GET /admonitor/v1/reports/basic/progress

参数

名称必选格式示例描述
campaign_id true ID 2 广告活动ID
access_token true 1.2YotnFZFEjr1zCsi 用于验证登录的访问令牌串
filtration_type false net 过滤类型，枚举值：net（默认），totalnet

名称	必选	格式	示例	描述
campaign_id	true	ID	2	广告活动ID
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
filtration_type	false		net	过滤类型，枚举值：net（默认），totalnet

响应示例


xxxxxxxxxx
{
"date": "2023-01-04",
"campaign_id": 2
}

名称类型描述
date string 已完成计算的最新日期