请输入
菜单

广告投放报表_进阶版

需要携带 Token,详情看Token

本章节文档将介绍广告投放报表_进阶版接口。

拉取报表数据时机说明

数据更新规则:

  • 小时维度数据:通常在 2-3小时 完成统计。
  • 日维度数据(T+1):通常在 2-4小时 完成统计。

推荐拉取时间:

  • 小时维度数据:建议在目标时间点 2.5小时后 拉取。
  • 日维度数据:建议在 次日03:00后 拉取。

示例:

  • 拉取1月1日10小时(10:00:00-10:59:59)的数据 → 建议 1月1日12:30后 操作。
  • 拉取1月1日全天数据 → 建议 1月2日02:30后 操作。

请求步骤

你可以调整 dimension_option 参数进行查询特定的维度。调用该接口需分成两个步骤:

  1. 首先需要设置参数 type=1 并调用接口,系统会在服务端异步生成好数据。

1.1 请求后需要等待数据生成,可继续用 type = 1 发起相同请求(Token需要更新)获取数据生成信息。

1.2 当接口返回码 code=200,说明数据已经成功生成。

1.3 如果拉取的是当天的数据,数据可能不完整,数据更新为小时维度,可等待n小时直至数据准备,再重新发起 type=1 请求更新以及获取新的数据生成信息,从而判断是否使用 type=2 更新数据。

1.4 数据的生成信息参考下文 type=1 的响应结果。

  1. 数据生成后,设置参数 type=2 再次调用接口即可直接下载数据。

2.1 若数据还没生成完,调用 type=2 接口会返回非 200 的 code。

2.2 若数据已经生成,使用 type=2 接口会直接返回文件字节流(Content-Type: application/octet-stream)。

2.3 数据按"\t"分列,按"\n"分行。

2.4 返回的数据每次返回的是当前请求的所有数据,并不是增量数据。

请求地址

https://ss-api.mintegral.com/api/v2/reports/data

请求方法

GET

请求示例

json 复制代码
GET /api/v2/reports/data?start_time=2024-06-01&end_time=2024-06-01&type=1&dimension_option=Offer
HTTP/1.1 Host: ss-api.mintegral.com

请求参数

字段 类型 说明 默认值 例子
timezone 选填 string 数据对应的时区 "+8" "+8"
start_time string 请求数据的开始时间, 格式为 YYYY-mm-dd。只支持查询最近半年的数据。 "2020-02-01"
end_time string 请求数据的结束时间, 格式为 YYYY-mm-dd。结束时间和开始时间的时间跨度不超过 7 天。 "2020-02-03"
dimension_option string 可选的字段名: "Offer", "Campaign", "CampaignPackage", "Creative", "AdType", "Sub", "Package", "Location", "Endcard", "AdOutputType". 多个字段用,分隔.
dimension_option=>"Offer",按 Offer ID, Offer Name, UUID 细分数据;
dimension_option=>"Campaign", 按 Campaign ID 细分数据;
dimension_option=>"CampaignPackage", 按 Campaign 的 Package Name 细分数据;
dimension_option=>"Creative", 按 Creative ID, Creative Name 细分数据;
dimension_option=>"AdType", 按 Ad Type 细分数据;
dimension_option=>"Sub", 按 Sub ID(mtgid,App ID) 细分数据;
dimension_option=>"Package", 按 Sub 的 Package Name 细分数据;
dimension_option=>"Location",按 国家/地区 细分数据;
dimension_option=>"Endcard",按 Endcard ID, Endcard Name 细分数据;
dimension_option=>"AdOutputType",按 Ad Output Type 细分数据;
不支持请求的组合里同时具有下列枚举值组合:
Creative & Sub
Creative & Package
Creative & time_granularity = hourly
Endcard & Sub
Endcard & Package
Endcard & time_granularity = hourly
- "Offer,Location"
time_granularity 选填 string 按 小时/天 细分数据. 枚举值: "hourly", "daily". "daily" "hourly"
type 选填 int type => 1, 拉取数据请求获取当前请求条件的数据状态。
type => 2, 下载数据。
1 1

type=2 返回的文件表头(字段)

表头(字段) 类型 说明 例子
Date int 日期 20220418
Timestamp int 时间戳
当 time_granularity = "hourly" 时返回
1650270348
Offer Id int 广告单元 ID
当 dimension_option 包含 "Offer" 时返回
73332
Offer Uuid string 系统自动生成的广告单元名称
当 dimension_option 包含 "Offer" 时返回
ss_xxxx_US_AND_xxx_220112_MTG
Offer Name string 广告单元名称
当 dimension_option 包含 "Offer" 时返回
xxxx_US_AND_xxx_220112_MTG
Campaign Id int 广告 ID
当 dimension_option 包含 "Campaign" 时返回
1111
Campaign Package string 广告包名
当 dimension_option 包含 "CampaignPackage" 时返回
com.xxx.yyy
Creative Id bigint 素材 ID
当 dimension_option 包含 "Creative" 时返回
2222
Creative Name string 素材名称
当 dimension_option 包含 "Creative" 时返回
220301-xxx-US-MTG01.png
Ad Type string 广告类型
当 dimension_option 包含 "AdType" 时返回
banner
Sub Id string 应用 ID (mtgid,App ID)
当 dimension_option 包含 "Sub" 时返回
mtg123456
Package Name string 应用包名
当 dimension_option 包含 "Package" 时返回
com.aaa.bbb
Location string 推广投放的国家/地区
当 dimension_option 包含 "Location" 时返回
US
Endcard ID bigint 结束卡片 ID
当 dimension_option 包含 "Endcard" 时返回
3333
Endcard Name string 结束卡片名称
当 dimension_option 包含 "Endcard" 时返回
EC_PL_XXXX_X
Ad Output Type string 广告呈现类型
当 dimension_option 包含 "AdOutputType" 时返回
"standard":标准创意,"dynamic":应用动态创意,"playable":应用试玩创意
standard
Currency string 货币类型 USD/CNY USD
Impression bigint 展示 7777
Click bigint 点击 88888
Conversion bigint 转化 9999
Ecpm Double eCPM 11.11
Cpc Double CPC 0.03
Ctr Double CTR 0.3
Cvr Double CVR 0.1
Ivr Double IVR 0.05
Spend Double 花费 8888.8

type=1 的响应结果

字段 类型 说明
code int 200 => 生成数据完成,可使用 type=2 获取数据。
201 => 接收请求成功,等待生成数据。
202 => 数据正在生成中。
10000 => 参数错误或权限缺失。
msg string 成功,返回相应的成功信息,失败返回相应的错误信息
data object 成功,返回数据生成信息,失败返回具体的错误信息
hours int 此刻数据包含的小时数,如 2024-06-01 12:00 请求了 start_time = end_time = '2024-06-01', 可能会返回 hours=12, 因为此刻数据包含了0~11点的数据,有12个小时。
is_complete boolean TRUE => 数据完整, FALSE => 数据不完整,如 end_time 大于等于当前日期则数据可能会不完整

type=2 的响应结果(code 不是 200)

字段 类型 说明
code int 203 => 没有接收到相同条件请求,请先使用 type=1 发起请求生成数据。
204 => 数据还没生成,请等待生成数据。
205 => 数据已经过期(生成的数据保留 1 个月),正在重新生成中。
10000 => 参数错误或权限缺失。
msg string 失败返回相应的错误信息
data json 失败返回具体的错误信息

应答示例

json 复制代码
{
  "code": 200,
  "msg": "Generate success, please use type = 2 to get data",
  "data": {
    "hours": 24,
    "is_complete": true
  }
}
上一个
报表
下一个
获取 APP 名称
最近修改: 2025-08-19