广告主详情接口
接口信息
- 接口名称: 获取广告主详情
- 请求方法: POST
- 接口地址:
/open-api/v1/data
- 接口路径:
/v3/api/open/top-advertiser/detail
- 接口描述: 根据广告主 ID 获取广告广告主详细信息
- 价格说明: 详情接口计费规则: 基础费用:1 credit/次。 免费访问条件(满足其一即可): 该ID在3天内已获取过详情;该ID在3天内出现在您的榜单列表查询结果中。
请求头:
- Content-Type: application/json
- Accept: application/json
请求参数
请求结构
| 参数名 |
类型 |
描述 |
示例 |
必填 |
默认值 |
| key |
string |
用户申请的外部 api 请求 key |
"your_api_key_here" |
是 |
|
| uri |
string |
接口路径 |
"/v3/api/open/top-advertiser/detail" |
是 |
|
| params |
object |
接口入参对象 |
见参数列表 |
是 |
|
参数列表 (params 对象)
| 参数名 |
类型 |
必填 |
描述 |
| id |
String |
是 |
广告主 ID (例如:60bf09612980dde5e9564279),对应广告主榜单列表接口返回结果中的 id 字段 |
请求示例
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"key": "your_api_key_here",
"uri": "/v3/api/open/top-advertiser/detail",
"params": {
"id": "60bf09612980dde5e9564279"
}
}'
响应参数
响应体结构
{
"code": 200,
"message": "success",
"data": {},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 1,
"success": true,
"fail": false
}
响应字段说明
| 字段名 |
类型 |
描述 |
| code |
Integer |
响应状态码,200 表示成功 |
| message |
String |
响应消息 |
| data |
Object |
广告主详情信息 |
| version |
String |
API 版本 |
| timestamp |
Number/null |
响应时间戳(不可用时为 null) |
| sign |
String/null |
响应签名(不可用时为 null) |
| remaining_credits |
Long |
当前请求后的剩余可用积分 |
| consumed_credits |
Long |
本次请求消耗的积分 |
| success |
Boolean |
请求是否成功 |
| fail |
Boolean |
请求是否失败 |
广告主详情字段
基础信息
| 字段名 |
类型 |
描述 |
| id |
String |
广告主id |
| root_path |
String |
广告主域名 |
| app_image |
String |
广告主图标 URL |
| ad_platform_list |
Array |
广告平台列表(tiktok, facebook, facebook-library) |
| shop_type |
Array |
电商系统类型列表(shopify, woocommerce等) |
| data_count |
Number |
广告数据总数 |
| monthly_visits |
Number |
网站月访问量 |
| first_data_time |
Number |
首次数据时间(时间戳,秒) |
| found_time |
Number |
首次发现时间(时间戳,秒) |
| latest_found_time |
Number |
最近发现时间(时间戳,秒) |
| region |
Array |
投放地区列表(国家代码) |
| is_collection |
Boolean |
当前用户是否已收藏该广告主 |
| is_ai |
Boolean |
是否为AI相关广告主 |
| is_drama |
Boolean |
是否为短剧相关广告主 |
| all_shop_type |
Array |
所有关联的电商系统类型 |
全平台汇总数据
| 字段名 |
类型 |
描述 |
| all_data_count |
Long |
所有平台的广告总数 |
| all_play_count |
Long |
所有平台的广告播放总数 |
| all_page_count |
Long |
所有平台的广告主账号总数 |
| all_put_days |
Long |
所有平台的投放天数 |
| all_found_time |
Long |
所有平台中最早的发现时间(时间戳,秒) |
| all_latest_found_time |
Long |
所有平台中最近的发现时间(时间戳,秒) |
| all_min_cpm |
Double |
所有平台的最小CPM(美元) |
| all_max_cpm |
Double |
所有平台的最大CPM(美元) |
| all_min_cpa |
Long |
所有平台的最小预估订单数 |
| all_max_cpa |
Long |
所有平台的最大预估订单数 |
| all_store_ad_state |
Integer |
总广告状态(-1=停止,1=活跃) |
TikTok 平台数据
| 字段名 |
类型 |
描述 |
| tiktok_data_count |
Long |
TikTok平台的广告总数 |
| tiktok_play_count |
Long |
TikTok平台的广告播放总数 |
| tiktok_page_count |
Long |
TikTok平台的广告主账号数 |
| tiktok_popular_person_count |
Long |
TikTok平台的热门创作者数量 |
| tiktok_put_days |
Long |
TikTok平台的投放天数 |
| tiktok_found_time |
Long |
TikTok平台的首次发现时间(时间戳,秒) |
| tiktok_latest_found_time |
Long |
TikTok平台的最近发现时间(时间戳,秒) |
| tiktok_min_cpm |
Double |
TikTok平台的最小CPM(美元) |
| tiktok_max_cpm |
Double |
TikTok平台的最大CPM(美元) |
| tiktok_min_cpa |
Long |
TikTok平台的最小预估订单数 |
| tiktok_max_cpa |
Long |
TikTok平台的最大预估订单数 |
| tiktok_store_ad_state |
Integer |
TikTok广告状态(-1=停止,1=活跃) |
Facebook 平台数据
| 字段名 |
类型 |
描述 |
| facebook_data_count |
Long |
Facebook平台的广告总数 |
| facebook_play_count |
Long |
Facebook平台的广告播放总数 |
| facebook_page_count |
Long |
Facebook平台的广告主账号数 |
| facebook_put_days |
Long |
Facebook平台的投放天数 |
| facebook_found_time |
Long |
Facebook平台的首次发现时间(时间戳,秒) |
| facebook_latest_found_time |
Long |
Facebook平台的最近发现时间(时间戳,秒) |
| facebook_min_cpm |
Double |
Facebook平台的最小CPM(美元) |
| facebook_max_cpm |
Double |
Facebook平台的最大CPM(美元) |
| facebook_min_cpa |
Long |
Facebook平台的最小预估订单数 |
| facebook_max_cpa |
Long |
Facebook平台的最大预估订单数 |
| facebook_store_ad_state |
Integer |
Facebook广告状态(-1=停止,1=活跃) |
| 字段名 |
类型 |
描述 |
| facebook_library_data_count |
Long |
Meta广告资料库中的广告总数 |
| facebook_library_play_count |
Long |
Meta广告资料库的广告播放总数 |
| facebook_library_page_count |
Long |
Meta广告资料库中的广告主账号数 |
| facebook_library_put_days |
Long |
Meta广告资料库的投放天数 |
| facebook_library_found_time |
Long |
Meta广告资料库的首次发现时间(时间戳,秒) |
| facebook_library_latest_found_time |
Long |
Meta广告资料库的最近发现时间(时间戳,秒) |
| facebook_library_min_cpm |
Double |
Meta广告资料库的最小CPM(美元) |
| facebook_library_max_cpm |
Double |
Meta广告资料库的最大CPM(美元) |
| facebook_library_min_cpa |
Long |
Meta广告资料库的最小预估订单数 |
| facebook_library_max_cpa |
Long |
Meta广告资料库的最大预估订单数 |
| facebook_library_reach |
Long |
Meta广告资料库的覆盖人数 |
| facebook_library_adset_count |
Long |
Meta广告资料库中的广告组总数 |
| facebook_library_adset_active_count |
Long |
Meta广告资料库中正在投放的活跃广告组数量 |
| facebook_library_ad_active_count |
Long |
Meta广告资料库中正在投放的活跃广告数量 |
| facebook_library_ad_inactive_count |
Long |
Meta广告资料库中已暂停投放的广告数量 |
| facebook_library_ad_offline_count |
Long |
Meta广告资料库中已下线的广告数量 |
| facebook_library_ad_state |
Integer |
Meta广告资料库广告状态(-1=停止,1=活跃) |
网站信息 (website_info)
| 字段名 |
类型 |
描述 |
| website_id |
String |
网站唯一标识 |
| website_icon |
String |
网站图标URL |
| website_title |
String |
网站标题 |
| website_url |
String |
网站链接 |
| website_languages |
Array |
网站使用的语言列表 |
| website_countries |
Array |
网站所在国家列表 |
| website_currencies |
Array |
网站支持的货币列表 |
| website_monthly_visits |
Long |
网站月访问量 |
| website_bounce_rate |
Double |
网站跳出率(0.0-1.0) |
| website_visit_seconds |
Long |
网站平均访问时长(秒) |
响应示例
{
"code": 200,
"message": "success",
"data": {
"id": "61f57e4d9a301ef93d53b88a",
"root_path": "example-shop.com",
"app_image": "https://fb-cdn.pipispy.com/images/example.png",
"ad_platform_list": ["tiktok", "facebook", "facebook-library"],
"shop_type": ["shopify"],
"data_count": 1250,
"monthly_visits": 5000000,
"first_data_time": 1675830644,
"found_time": 1675830644,
"latest_found_time": 1752202412,
"region": ["US", "CA", "GB", "DE", "FR"],
"is_collection": false,
"is_ai": false,
"is_drama": false,
"all_shop_type": ["shopify"],
"all_data_count": 2500,
"all_play_count": 76792774635,
"all_page_count": 3256,
"all_put_days": 180,
"all_found_time": 1675830644,
"all_latest_found_time": 1752202412,
"all_min_cpm": 15.5,
"all_max_cpm": 45.8,
"all_min_cpa": 50,
"all_max_cpa": 500,
"all_store_ad_state": 1,
"tiktok_data_count": 1000,
"tiktok_play_count": 50000000000,
"tiktok_page_count": 1500,
"tiktok_popular_person_count": 1157348,
"tiktok_put_days": 150,
"tiktok_found_time": 1675830644,
"tiktok_latest_found_time": 1752202412,
"tiktok_min_cpm": 18.0,
"tiktok_max_cpm": 42.5,
"tiktok_min_cpa": 60,
"tiktok_max_cpa": 450,
"tiktok_store_ad_state": 1,
"facebook_data_count": 800,
"facebook_play_count": 20000000000,
"facebook_page_count": 1200,
"facebook_put_days": 120,
"facebook_found_time": 1680000000,
"facebook_latest_found_time": 1752000000,
"facebook_min_cpm": 12.0,
"facebook_max_cpm": 38.0,
"facebook_min_cpa": 45,
"facebook_max_cpa": 400,
"facebook_store_ad_state": 1,
"facebook_library_data_count": 700,
"facebook_library_play_count": 6792774635,
"facebook_library_page_count": 556,
"facebook_library_put_days": 90,
"facebook_library_found_time": 1685000000,
"facebook_library_latest_found_time": 1752202412,
"facebook_library_min_cpm": 20.0,
"facebook_library_max_cpm": 50.0,
"facebook_library_min_cpa": 70,
"facebook_library_max_cpa": 550,
"facebook_library_reach": 15000000,
"facebook_library_adset_count": 150,
"facebook_library_adset_active_count": 80,
"facebook_library_ad_active_count": 200,
"facebook_library_ad_inactive_count": 100,
"facebook_library_ad_offline_count": 400,
"facebook_library_ad_state": 1,
"website_info": {
"website_id": "web_001",
"website_icon": "https://fb-cdn.pipispy.com/images/icon.png",
"website_title": "Example Shop",
"website_url": "https://example-shop.com",
"website_languages": ["en", "de", "fr"],
"website_countries": ["US", "CA", "GB"],
"website_currencies": ["USD", "EUR", "GBP"],
"website_monthly_visits": 5000000,
"website_bounce_rate": 0.45,
"website_visit_seconds": 180
}
},
"version": "v1",
"timestamp": null,
"sign": null,
"remaining_credits": 9980,
"consumed_credits": 1,
"success": true,
"fail": false
}
错误码说明
| 错误码 |
描述 |
| 200 |
成功 |
| 400 |
请求参数错误,如缺少广告主 ID |
| 403 |
权限不足 |
| 404 |
广告主不存在 |
| 444 |
请求过于频繁,已触发限流 |
| 500 |
服务器内部错误 |