Reporting API 1.0

Version

Time

Modification

1.1

2018-08-01

1.2

2019-01-21

Add three fields: media_name, site_name , code_name

1.3

2019-03-12

Add two metrics: JP region, usd currency

1.4

2019-12-05

Change domain

1.5

2021-07-12

• Modified the caliber of fill_rate .New metrics release : ad_request 、 response、ad_fill_rate and ad_impression_rate . But these added metrics do not have data before March 15 2021.•And it is recommended to switch to reporting api 2.0, which will provide a better user experience and better performance

1.6

2021-08-31

Update the domain name"partner.oceanengine.com" to "open-api.pangleglobal.com"

Name

Value

Required

Description

user_id

long

Y

User ID, provided by BD

timestamp

long

Y

Timestamp

nonce

long

Y

Random string

start_date

string

Y

Start date, format ‘YYYY-MM-DD’, time span needs less than 30 days

end_date

string

Y

End date, format ‘YYYY-MM-DD’, time span needs less than 30 days

sign

string

Y

The rule is as below

time_granularity

string

N

Only support by day, default value is STAT_TIME_GRANULARITY_DAILY

region

string

N

Follow ISO 3166-1 Standard, support China(CN) and Japan(JP).

Name

Value

Required

Description

code

long

Y

Return code, details please see the Code List below.

message

string

Y

Return message, details please see the Code List below.

data

json

Y

Data json includes stat_datetime、user_id、show、click、click_rate、ecpm、cost

stat_datetime

string

Y

time

region

string

Y

Follow ISO 3166-1 Standard, support China(CN) and Japan(JP).

media_name

unicode

Y

Account name

show

long

Y

Impression

click

long

Y

Click

click_rate

float

Y

Click rate

ecpm

float

Y

eCPM

cost

float

Y

Estimated revenue

currency

long

Y

Currency

Name

Value

Required

Description

code

long

Y

Return code, details please see the Code List below.

message

string

Y

Return message, details please see the Code List below.

data

json

Y

Data json includes stat_datetime、user_id、show、click、click_rate、ecpm、cost

stat_datetime

string

Y

time

region

string

Y

Follow ISO 3166-1 Standard, support China(CN) and Japan(JP).

appid

long

Y

Appid from TikTok Audience Network

media_name

unicode

Y

Account name

site_name

unicode

Y

App name

show

long

Y

Impression

click

long

Y

Click

click_rate

float

Y

Click rate

ecpm

float

Y

eCPM

cost

float

Y

Estimated revenue

currency

long

Y

Currency

Name

Value

Required

Description

code

long

Y

Return code, details please see the Code List below.

message

string

Y

Return message, details please see the Code List below.

data

json

Y

Data json includes stat_datetime、user_id、show、click、click_rate、ecpm、cost

stat_datetime

string

Y

time

region

string

Y

Follow ISO 3166-1 Standard, support China(CN) and Japan(JP).

appid

long

Y

Appid from TikTok Audience Network

ad_slot_id

long

Y

Ad Slot ID from TikTok Audience Network

media_name

unicode

Y

Account name

site_name

unicode

Y

App name

code_name

unicode

Y

Slot name

show

long

Y

Impression

click

long

Y

Click

click_rate

float

Y

Click rate

ecpm

float

Y

eCPM

cost

float

Y

Estimated revenue

currency

long

Y

Currency