admonitor_reports

Miaozhen AdMonitor/Reports API v1

- Miaozhen AdMonitor/Reports API v1

Basic Reports

Endpoint
```
GET /admonitor/v1/reports/basic/show
```

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

campaign_id required ID 2

by_position optional PDIM publisher Set report position dimension. PDIM could be campaign(default), publisher or spot.

by_audience optional ADIM stable Set report audience dimension. ADIM could be overall(default), stable or target.

by_region optional RDIM level1 Set report region dimension. RDIM could be level0(default), level1, level2 or level3.

platform optional PTDIM pc Set report platform type dimension. PTDIM could be pc(default), pm, mb(mobile).

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Valid only if by_position=publisher or by_position=spot.

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Valid only if by_position=spot.

target_id optional ID1,ID2,… 22,23 Returned target_id must be within the ID list (comma separated). Valid only if by_audience=target.

region_id optional ID1,ID2,… 22,23 Returned region_id must be within the ID list (comma separated).

metrics optional MSCO all Set the scope of returned metrics. MSCO could be acc(default),day, avg_day,acc_hrs or all.

sdk optional sdk all Set the type of sdk. SDK could be all(default),mm or mz.Valid only if platform=mb,metrics=all or metrics=acc and by_position=campaign or by_position=publisher.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.The parameter “limit”just be used for "by spot", "by campaign" is not accepted by server as now.

order_asc optional NAME spot_id Could be any attribute name or metric name.

order_desc optional NAME imp_day Could be any attribute name or metric name.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
campaign_id	required	ID	2
by_position	optional	PDIM	publisher	Set report position dimension. PDIM could be `campaign`(default), `publisher` or `spot`.
by_audience	optional	ADIM	stable	Set report audience dimension. ADIM could be `overall`(default), `stable` or `target`.
by_region	optional	RDIM	level1	Set report region dimension. RDIM could be `level0`(default), `level1`, `level2` or `level3`.
platform	optional	PTDIM	pc	Set report platform type dimension. PTDIM could be `pc`(default), `pm`, `mb`(mobile).
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Valid only if `by_position=publisher` or `by_position=spot`.
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Valid only if `by_position=spot`.
target_id	optional	ID1,ID2,…	22,23	Returned target_id must be within the ID list (comma separated). Valid only if `by_audience=target`.
region_id	optional	ID1,ID2,…	22,23	Returned region_id must be within the ID list (comma separated).
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `acc`(default),`day`, `avg_day`,`acc_hrs` or `all`.
sdk	optional	sdk	all	Set the type of sdk. SDK could be `all`(default),`mm` or `mz`.Valid only if platform=mb,metrics=all or metrics=acc and by_position=campaign or by_position=publisher.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.The parameter “limit”just be used for "by spot", "by campaign" is not accepted by server as now.
order_asc	optional	NAME	spot_id	Could be any attribute name or metric name.
order_desc	optional	NAME	imp_day	Could be any attribute name or metric name.

Example Response

{
    "campaign_id": "1",
    "date": "2012-10-20",
    "version": "V1.0",
    "platform": "pc",
    "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
                ...
           }
       },
       ...
   ]
}
Name Type Description

audience string overall or stable or target.

target_id string Available when by_audience=target.

publisher_id string Available when by_position=publisher or by_position=spot.

spot_id string Available when by_position=spot.

region_id string

imp_acc int Impressions of the day. Available when metrics=acc or metrics=all.

clk_acc int Clicks of the day. Available when metrics=acc or metrics=all.

uim_acc int Accumulated unique impressions (UV). Available when metrics=acc or metrics=all.

ucl_acc int Accumulated unique clicks (clicker). Available when metrics=acc or metrics=all.

imp_day int Impressions of the day. Available when metrics=day or metrics=all.

clk_day int Clicks of the day. Available when metrics=day or metrics=all.

uim_day int Unique impressions (UV) of the day. Available when metrics=day or metrics=all.

ucl_day int Unique clicks (clicker) of the day. Available when metrics=day or metrics=all.

imp_avg_day int Average daily impressions. Available when metrics=avg_day or metrics=all.

clk_avg_day int Average daily clicks. Available when metrics=avg_day or metrics=all.

uim_avg_day int Average daily unique impressions (UV). Available when metrics=avg_day or metrics=all.

ucl_avg_day int Average daily unique clicks (clicker). Available when metrics=avg_day or metrics=all.

imp_acc_h00 int Accumulated impressions from 00:00 - 00:59. Available when metrics=acc_hrs or metrics=all.

imp_acc_h23 int Accumulated impressions from 23:00 - 23:59. Available when metrics=acc_hrs or metrics=all.

clk_acc_h00 int Accumulated clicks from 00:00 - 00:59. Available when metrics=acc_hrs or metrics=all.

clk_acc_h23 int Accumulated clicks from 23:00 - 23:59. Available when metrics=acc_hrs or metrics=all.

Name	Type	Description
audience	string	`overall` or `stable` or `target`.
target_id	string	Available when `by_audience=target`.
publisher_id	string	Available when `by_position=publisher` or `by_position=spot`.
spot_id	string	Available when `by_position=spot`.
region_id	string
imp_acc	int	Impressions of the day. Available when `metrics=acc` or `metrics=all`.
clk_acc	int	Clicks of the day. Available when `metrics=acc` or `metrics=all`.
uim_acc	int	Accumulated unique impressions (UV). Available when `metrics=acc` or `metrics=all`.
ucl_acc	int	Accumulated unique clicks (clicker). Available when `metrics=acc` or `metrics=all`.
imp_day	int	Impressions of the day. Available when `metrics=day` or `metrics=all`.
clk_day	int	Clicks of the day. Available when `metrics=day` or `metrics=all`.
uim_day	int	Unique impressions (UV) of the day. Available when `metrics=day` or `metrics=all`.
ucl_day	int	Unique clicks (clicker) of the day. Available when `metrics=day` or `metrics=all`.
imp_avg_day	int	Average daily impressions. Available when `metrics=avg_day` or `metrics=all`.
clk_avg_day	int	Average daily clicks. Available when `metrics=avg_day` or `metrics=all`.
uim_avg_day	int	Average daily unique impressions (UV). Available when `metrics=avg_day` or `metrics=all`.
ucl_avg_day	int	Average daily unique clicks (clicker). Available when `metrics=avg_day` or `metrics=all`.
imp_acc_h00	int	Accumulated impressions from 00:00 - 00:59. Available when `metrics=acc_hrs` or `metrics=all`.
imp_acc_h23	int	Accumulated impressions from 23:00 - 23:59. Available when `metrics=acc_hrs` or `metrics=all`.
clk_acc_h00	int	Accumulated clicks from 00:00 - 00:59. Available when `metrics=acc_hrs` or `metrics=all`.
clk_acc_h23	int	Accumulated clicks from 23:00 - 23:59. Available when `metrics=acc_hrs` or `metrics=all`.

Basic Minisite Reports

Endpoint

GET /admonitor/v1/reports/basic/show_minisite

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

minisite_id required ID 23

by_position optional PDIM publisher Set report position dimension. PDIM could be total(default), campaign, publisher or spot

by_audience optional ADIM stable Set report audience dimension. ADIM could be overall(default), stable or target.

by_region optional RDIM level1 Set report region dimension. RDIM could be level0(default), level1, level2 or level3.

campaign_id optional ID1,ID2,… 1,2,3 Returned campaign_id must be within the ID list (comma separated). Valid only if by_position=campaign, by_position=publisher or by_position=spot.

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Valid only if by_position=publisher or by_position=spot.

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Valid only if by_position=spot.

event_id optional ID1,ID2,… 1,2,3 Returned event_id must be within the ID list (comma separated).

region_id optional ID1,ID2,… 22,23 Returned region_id must be within the ID list (comma separated).

metrics optional MSCO all Set the scope of returned metrics. MSCO could be acc(default), day, or all

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME event_id

order_desc optional NAME evt_day

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
minisite_id	required	ID	23
by_position	optional	PDIM	publisher	Set report position dimension. PDIM could be `total`(default), `campaign`, `publisher` or `spot`
by_audience	optional	ADIM	stable	Set report audience dimension. ADIM could be `overall`(default), `stable` or `target`.
by_region	optional	RDIM	level1	Set report region dimension. RDIM could be `level0`(default), `level1`, `level2` or `level3`.
campaign_id	optional	ID1,ID2,…	1,2,3	Returned campaign_id must be within the ID list (comma separated). Valid only if `by_position=campaign`, `by_position=publisher` or `by_position=spot`.
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Valid only if `by_position=publisher` or `by_position=spot`.
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Valid only if `by_position=spot`.
event_id	optional	ID1,ID2,…	1,2,3	Returned event_id must be within the ID list (comma separated).
region_id	optional	ID1,ID2,…	22,23	Returned region_id must be within the ID list (comma separated).
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `acc`(default), `day`, or `all`

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	event_id
order_desc	optional	NAME	evt_day

Example Response

{
    "minisite_id": "1",
    "minisite_name": "an official site",
    "date": "2012-10-20",
    "version": "V1.0",
    "items":
    [
        {
            "attributes":
            {
                "audience": "target",
                "target_id": "1",
                "campaign_id": "2",
                "publisher_id": "1",
                "spot_id": "61",
                "spot_id_str": "z",
                "event_id": "45",
                "region_id": "00001234",
                "universe": 12345
            },
            metrics:
            {
                "evt_acc": 200,
                "uev_acc": 180,
                "evt_day": 20,
                "uev_day": 18
            }
        },
        ...
    ]
}
Name Type Description

audience string overall or stable or target.

target_id string Available when by_audience=target.

campaign_id string Available when by_position=campaign or by_position=publisher or by_position=spot.

publisher_id string Available when by_position=publisher or by_position=spot.

spot_id string Available when by_position=spot.

spot_id_str string A string representation of spot_id.

event_id string Minisite tracking event id.

region_id string

evt_acc int Accumulated event PV (page views). Available when metrics=acc or metrics=all.

uev_acc int Accumulated event UV (unique visitors). Available when metrics=acc or metrics=all.

evt_day int Daily event PV (page views). Available when metrics=day or metrics=all.

uev_day int Daily event UV (unique visitors). Available when metrics=day or metrics=all.

Name	Type	Description
audience	string	`overall` or `stable` or `target`.
target_id	string	Available when `by_audience=target`.
campaign_id	string	Available when `by_position=campaign` or `by_position=publisher` or `by_position=spot`.
publisher_id	string	Available when `by_position=publisher` or `by_position=spot`.
spot_id	string	Available when `by_position=spot`.
spot_id_str	string	A string representation of spot_id.
event_id	string	Minisite tracking event id.
region_id	string
evt_acc	int	Accumulated event PV (page views). Available when `metrics=acc` or `metrics=all`.
uev_acc	int	Accumulated event UV (unique visitors). Available when `metrics=acc` or `metrics=all`.
evt_day	int	Daily event PV (page views). Available when `metrics=day` or `metrics=all`.
uev_day	int	Daily event UV (unique visitors). Available when `metrics=day` or `metrics=all`.

Realtime Reports

Endpoint

GET /admonitor/v1/reports/realtime/show

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

campaign_id required ID 2

by_position optional PDIM publisher Set report position dimension. PDIM could be campaign(default), publisher or spot

platform optional PTDIM pc Set report platform dimension. PTDIM could be pc(default) or pm, mb(mobile).

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Viable only by_position=publisher or by_position=spot.

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Viable only by_position=spot.

metrics optional MSCO all Set the scope of returned metrics. MSCO could be day(default),hrs or all.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME spot_id Could be any attribute name or metric name.

order_desc optional NAME imp_day Could be any attribute name or metric name.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Currently realtime reports provide global-region overall-audience numbers only.

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
campaign_id	required	ID	2
by_position	optional	PDIM	publisher	Set report position dimension. PDIM could be `campaign`(default), `publisher` or `spot`
platform	optional	PTDIM	pc	Set report platform dimension. PTDIM could be `pc`(default) or `pm`, `mb`(mobile).
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Viable only `by_position=publisher` or `by_position=spot`.
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Viable only `by_position=spot`.
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `day`(default),`hrs` or `all`.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	spot_id	Could be any attribute name or metric name.
order_desc	optional	NAME	imp_day	Could be any attribute name or metric name.

Example Response

{
    "campaign_id": "1",
    "date": "2012-10-20",
    "platform": "pc",
    "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
            }
        },
        ...
    ]
}
Name Type Description

audience string overall only.

region_id string global region id only.

publisher_id string Available when by_position=publisher or by_position=spot.

spot_id string Available when by_position=spot.

spot_id_str string A string representation of spot_id.

imp_day int Impressions of the day. Available when metrics=day or metrics=all.

clk_day int Clicks of the day. Available when metrics=day or metrics=all.

imp_h00 int Impressions from 00:00 - 00:59. Available when metrics=hrs or metrics=all.

imp_h23 int Impressions from 23:00 - 23:59. Available when metrics=hrs or metrics=all.

clk_h00 int Clicks from 00:00 - 00:59. Available when metrics=hrs or metrics=all.

clk_h23 int Clicks from 23:00 - 23:59. Available when metrics=hrs or metrics=all.

Name	Type	Description
audience	string	`overall` only.
region_id	string	global region id only.
publisher_id	string	Available when `by_position=publisher` or `by_position=spot`.
spot_id	string	Available when `by_position=spot`.
spot_id_str	string	A string representation of spot_id.
imp_day	int	Impressions of the day. Available when `metrics=day` or `metrics=all`.
clk_day	int	Clicks of the day. Available when `metrics=day` or `metrics=all`.
imp_h00	int	Impressions from 00:00 - 00:59. Available when `metrics=hrs` or `metrics=all`.
imp_h23	int	Impressions from 23:00 - 23:59. Available when `metrics=hrs` or `metrics=all`.
clk_h00	int	Clicks from 00:00 - 00:59. Available when `metrics=hrs` or `metrics=all`.
clk_h23	int	Clicks from 23:00 - 23:59. Available when `metrics=hrs` or `metrics=all`.

Realtime Minisite Reports

Endpoint

GET /admonitor/v1/reports/realtime/show_minisite

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

minisite_id required ID 23

by_position optional PDIM publisher Set report source dimension. PDIM could be total(default), campaign, publisher or spot

campaign_id optional ID1,ID2,… 1,2,3 Returned campaign_id must be within the ID list (comma separated). Viable only if by_position=campaign, by_position=publisher or by_position=spot.

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Viable only if by_position=publisher or by_position=spot.

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Viable only if by_position=spot.

event_id optional ID1,ID2,… 1,2,3 Returned event_id must be within the ID list (comma separated).

metrics optional MSCO all Set the scope of returned metrics. MSCO could be day(default),hrs or all.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME event_id Could be any attribute name or metric name.

order_desc optional NAME evt_day Could be any attribute name or metric name.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Currently realtime reports provide global-region overall-audience numbers only.

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
minisite_id	required	ID	23
by_position	optional	PDIM	publisher	Set report source dimension. PDIM could be `total`(default), `campaign`, `publisher` or `spot`
campaign_id	optional	ID1,ID2,…	1,2,3	Returned campaign_id must be within the ID list (comma separated). Viable only if `by_position=campaign`, `by_position=publisher` or `by_position=spot`.
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Viable only if `by_position=publisher` or `by_position=spot`.
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Viable only if `by_position=spot`.
event_id	optional	ID1,ID2,…	1,2,3	Returned event_id must be within the ID list (comma separated).
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `day`(default),`hrs` or `all`.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	event_id	Could be any attribute name or metric name.
order_desc	optional	NAME	evt_day	Could be any attribute name or metric name.

Example Response

{
    "minisite_id": "1",
    "minisite_name": "an official site",
    "date": "2012-10-20",
    "items":
    [
        {
            "attributes":
            {
                "audience": "overall",
                "region_id": "000000000000",
                "campaign_id": "2",
                "publisher_id": "1",
                "spot_id": "40",
                "spot_id_str": "e",
                "event_id": "45"
            },
            "metrics":
            {
                "evt_day": 200,
                "evt_h00": 12,
                ...
                "evt_h23": 17
            }
        },
        ...
    ]
}
Name Type Description

audience string overall only.

region_id string global region id only.

campaign_id string Available when by_position=campaign or by_position=publisher or by_position=spot.

publisher_id string Available when by_position=publisher or by_position=spot.

spot_id string Available when by_position=spot.

spot_id_str string A string representation of spot_id.

event_id string Minisite tracking event id.

evt_day int Event PV (page views) of the day. Available when metrics=day or metrics=all.

evt_h00 int Event PV from 00:00 - 00:59. Available when metrics=hrs or metrics=all.

evt_h23 int Event PV from 23:00 - 23:59. Available when metrics=hrs or metrics=all.

Name	Type	Description
audience	string	`overall` only.
region_id	string	global region id only.
campaign_id	string	Available when `by_position=campaign` or `by_position=publisher` or `by_position=spot`.
publisher_id	string	Available when `by_position=publisher` or `by_position=spot`.
spot_id	string	Available when `by_position=spot`.
spot_id_str	string	A string representation of spot_id.
event_id	string	Minisite tracking event id.
evt_day	int	Event PV (page views) of the day. Available when `metrics=day` or `metrics=all`.
evt_h00	int	Event PV from 00:00 - 00:59. Available when `metrics=hrs` or `metrics=all`.
evt_h23	int	Event PV from 23:00 - 23:59. Available when `metrics=hrs` or `metrics=all`.

Reach Reports

Endpoint
```
GET /admonitor/v1/reports/reach/show
```

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

campaign_id required ID 2

by_position optional PDIM publisher Set report position dimension. PDIM could be campaign(default), publisher or spot

by_audience optional ADIM stable Set report audience dimension. ADIM could be overall(default), stable or target

by_region optional RDIM level1 Set report region dimension. RDIM could be level0(default), level1, level2 or level3

platform optional PTDIM pc Set report platform type dimension. PTDIM could be pc(default) or pm, mb(mobile).

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Valid only if by_position=publisher or by_position=spot

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Valid only if by_position=spot

target_id optional ID1,ID2,… 22,23 Returned target_id must be within the ID list (comma separated). Valid only if by_audience=target.

region_id optional ID1,ID2,… 22,23 Returned region_id must be within the ID list (comma separated).

metrics optional MSCO all Set the scope of returned metrics. MSCO could be all(default), acc, or spl.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.The parameter “limit”just be used for "by spot", "by campaign" is not accepted by server as now.

order_asc optional NAME spot_id Could be any attribute name or metric name.

order_desc optional NAME imp_acc Could be any attribute name or metric name.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
campaign_id	required	ID	2
by_position	optional	PDIM	publisher	Set report position dimension. PDIM could be `campaign`(default), `publisher` or `spot`
by_audience	optional	ADIM	stable	Set report audience dimension. ADIM could be `overall`(default), `stable` or `target`
by_region	optional	RDIM	level1	Set report region dimension. RDIM could be `level0`(default), `level1`, `level2` or `level3`
platform	optional	PTDIM	pc	Set report platform type dimension. PTDIM could be `pc`(default) or `pm`, `mb`(mobile).
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Valid only if `by_position=publisher` or `by_position=spot`
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Valid only if `by_position=spot`
target_id	optional	ID1,ID2,…	22,23	Returned target_id must be within the ID list (comma separated). Valid only if `by_audience=target`.
region_id	optional	ID1,ID2,…	22,23	Returned region_id must be within the ID list (comma separated).
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `all`(default), `acc`, or `spl`.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.The parameter “limit”just be used for "by spot", "by campaign" is not accepted by server as now.
order_asc	optional	NAME	spot_id	Could be any attribute name or metric name.
order_desc	optional	NAME	imp_acc	Could be any attribute name or metric name.

Example Response

{
    "campaign_id": "1",
    "date": "2012-10-20",
    "version": "V1.0",
    "platform": "pc",
    "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
           }
      },
      ...
    ]
}
Name Type Description

imp_acc int Accumulated impressions. Available when metrics=acc or metrics=all.

grp_acc int Accumulated GRP. Available when metrics=acc or metrics=all.

rch_acc_p01 int Accumulated 1+ reach. Available when metrics=acc or metrics=all.

rch_acc_p10 int Accumulated 10+ reach. Available when metrics=acc or metrics=all.

rch_spl_p01 int 1+ reach sample size. Available when metrics=spl or metrics=all.

rch_spl_p10 int 10+ reach sample size. Available when metrics=spl or metrics=all.

Name	Type	Description
imp_acc	int	Accumulated impressions. Available when `metrics=acc` or `metrics=all`.
grp_acc	int	Accumulated GRP. Available when `metrics=acc` or `metrics=all`.
rch_acc_p01	int	Accumulated 1+ reach. Available when `metrics=acc` or `metrics=all`.
rch_acc_p10	int	Accumulated 10+ reach. Available when `metrics=acc` or `metrics=all`.
rch_spl_p01	int	1+ reach sample size. Available when `metrics=spl` or `metrics=all`.
rch_spl_p10	int	10+ reach sample size. Available when `metrics=spl` or `metrics=all`.

Audience Reports

Audience Overview

Endpoint

GET /admonitor/v1/reports/audience/show_overview

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

campaign_id required ID 2

panel_id optional ID1,ID2,… china-123,test Returned panel_id must be within the ID list (comma separated).

by_position optional PDIM publisher Set report position dimension. PDIM could be campaign(default), publisher or spot

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Valid only if by_position=publisher or by_position=spot

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Valid only if by_position=spot

metrics optional MSCO all Set the scope of returned metrics. MSCO could be all(default), acc, or spl.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME spot_id Could be any attribute name or metric name.

order_desc optional NAME imp_acc Could be any attribute name or metric name.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
campaign_id	required	ID	2
panel_id	optional	ID1,ID2,…	china-123,test	Returned panel_id must be within the ID list (comma separated).
by_position	optional	PDIM	publisher	Set report position dimension. PDIM could be `campaign`(default), `publisher` or `spot`
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Valid only if `by_position=publisher` or `by_position=spot`
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Valid only if `by_position=spot`
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `all`(default), `acc`, or `spl`.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	spot_id	Could be any attribute name or metric name.
order_desc	optional	NAME	imp_acc	Could be any attribute name or metric name.

Example Response

{
    "campaign_id": "1",
    "date": "2012-10-20",
    "version": "V1.0",
    "items":
    [
        {
            "attributes":
            {
                "panel_id": "china-123",
                "spot_id": "1"
           },
           "metrics":
           {
                "uim_acc": 0,
                "ucl_acc": 0,

                "uim_spl": 0,
                "ucl_spl": 0
           }
        }
    ]
}

Audience Details

Endpoint

GET /admonitor/v1/reports/audience/show

Parameters

Name Format Example Description

date required YYYY-MM-DD 2012-12-25

campaign_id required ID 2

panel_id optional ID1,ID2,… china-123,test Returned panel_id must be within the ID list (comma separated).

type_id optional ID1,ID2,… age,gender Returned tag type_id must be within the ID list (comma separated).

by_position optional PDIM publisher Set report position dimension. PDIM could be campaign(default), publisher or spot

publisher_id optional ID1,ID2,… 1,2,3 Returned publisher_id must be within the ID list (comma separated). Valid only if by_position=publisher or by_position=spot

spot_id optional ID1,ID2,… 22,23 Returned spot_id must be within the ID list (comma separated). Valid only if by_position=spot

metrics optional MSCO all Set the scope of returned metrics. MSCO could be all(default),pct or idx.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME spot_id Could be any attribute name or metric name.

order_desc optional NAME imp_day Could be any attribute name or metric name.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
date	required	YYYY-MM-DD	2012-12-25
campaign_id	required	ID	2
panel_id	optional	ID1,ID2,…	china-123,test	Returned panel_id must be within the ID list (comma separated).
type_id	optional	ID1,ID2,…	age,gender	Returned tag type_id must be within the ID list (comma separated).
by_position	optional	PDIM	publisher	Set report position dimension. PDIM could be `campaign`(default), `publisher` or `spot`
publisher_id	optional	ID1,ID2,…	1,2,3	Returned publisher_id must be within the ID list (comma separated). Valid only if `by_position=publisher` or `by_position=spot`
spot_id	optional	ID1,ID2,…	22,23	Returned spot_id must be within the ID list (comma separated). Valid only if `by_position=spot`
metrics	optional	MSCO	all	Set the scope of returned metrics. MSCO could be `all`(default),`pct` or `idx`.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	spot_id	Could be any attribute name or metric name.
order_desc	optional	NAME	imp_day	Could be any attribute name or metric name.

Example Response

{
    "campaign_id": "1",
    "date": "2012-10-20",
    "version": "V1.0",
    "items":
    [
        {
            "attributes":
            {
                "panel_id": "china-123",
                "tag_id": "1",
                "spot_id": "12"
            },
            "metrics":
            {
                "uim_pct": 0,
                "ucl_pct": 0,
                "uim_idx": 100,
                "ucl_idx": 100
            }
        },
        ...
    ]
}