{ "openapi": "3.0.0", "x-mint": { "mcp": { "enabled": true } }, "servers": [ { "url": "https://api.pubrio.com" } ], "info": { "description": "Pubrio API 提供市场扩张情报——实时捕捉企业进入新市场的信号，以及其底层的公司与人员数据。可搜索、查找并丰富账户与联系人信息，并订阅覆盖 200+ 市场、带类型与日期的动向信号。", "version": "1.0.0", "title": "Pubrio OpenAPI", "termsOfService": "https://pubrio.com/zh-CN/terms-of-service", "contact": { "email": "king.lai@pubrio.com", "name": "King Lai", "url": "https://pubrio.com/zh-CN/get-in-touch" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "tags": [ { "name": "Profile", "description": "工作区配置信息和使用统计" }, { "name": "Enrichment", "description": "通过详细的 B2B 数据丰富人员和公司记录" }, { "name": "Lookalike", "description": "查找与指定公司相似的公司" }, { "name": "Search", "description": "使用筛选条件搜索人员、公司、职位、新闻和广告" }, { "name": "Lookup", "description": "查找特定人员、公司、职位、新闻、广告和技术的详细信息" }, { "name": "LinkedIn", "description": "通过 LinkedIn 个人资料 URL 查找人员和公司数据" }, { "name": "Redeem", "description": "兑换积分以解锁人员联系方式（单个和批量）" }, { "name": "Channels", "description": "管理外展渠道模板（创建、更新、删除、列表）" }, { "name": "Monitor", "description": "创建和管理数据监控，包括 Webhook、统计和处理" }, { "name": "Filters", "description": "获取搜索参数的可用筛选值（技术、地点、垂直领域等）" }, { "name": "API Keys", "description": "查看 API 密钥的请求日志和使用情况分析" }, { "name": "Insights", "description": "公司的信号聚合洞察(招聘、新闻、广告)。" }, { "name": "Export", "description": "批量数据导出(消耗积分)。" }, { "name": "Expansion", "description": "公司市场扩张情报:信号、阶段、市场与导出。" } ], "paths": { "/companies/lookup/enrich": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文——回显的 `filters` 与 `parameters`，以及在请求积分核算时返回的、包含 `credit`、`topup_credit` 和 `total_credit_cost` 的 `profile` 区块。" }, "data": { "$ref": "#/components/schemas/data" }, "jobs": { "type": "array", "description": "该公司近期的招聘职位，随本次响应一并返回，无需再单独调用职位搜索。", "items": { "type": "object" } }, "news": { "type": "array", "description": "该公司近期的新闻报道，随本次响应一并返回，无需再单独调用新闻搜索。", "items": { "type": "object" } }, "advertisements": { "type": "array", "description": "该公司近期的广告投放，随本次响应一并返回，无需再单独调用广告搜索。", "items": { "type": "object" } }, "similar_companies": { "type": "array", "description": "与该公司相似的公司列表。未找到相近匹配时为空。", "items": { "type": "object" } } } }, "example": { "metadata": { "is_enrichment_available": false, "parameters": null }, "data": { "logo_url": "https://buckets.pubrio.com/company-logo/MTA4NjI1MTNzdHJpcGUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "estimated_revenue": 14400000000, "publicly_traded_symbol": null, "publicly_traded_exchange": null, "linkedin_name": "stripe", "domains": [ "stripe.com" ], "locations": [ "US" ], "categories": [ "1", "26", "28", "33", "37", "38", "39", "43", "56", "60", "64", "69", "71", "81", "116", "129", "147", "254", "979", "3014", "707847256" ], "verticals": [ "24076059", "24096599", "69085143", "69107205" ], "vertical_categories": [ "9", "16", "18" ], "vertical_sub_categories": [ "74", "103", "120" ], "company_ranking": 221, "title": "Help increase the GDP of the internet.", "company_type": "Privately Held", "description": "Stripe is a financial infrastructure platform for businesses. Millions of companies—from the world’s largest enterprises to the most ambitious startups—use Stripe to accept payments, grow their revenue, and accelerate new business opportunities. Headquartered in San Francisco and Dublin, the company aims to increase the GDP of the internet.", "company_address": "South San Francisco, California", "linkedin_uid": "2135371", "company_name": "Stripe", "founded_year": 2010, "industry": "Technology, Information And Internet", "specialties": [ "Technology, Information And Internet", "Financial Services", "E-commerce", "Information Technology & Services" ], "domain": "stripe.com", "domain_search_id": "5378845d-7726-4817-aba9-ced8c5f41dee", "domain_id": 10862513, "parent_id": null, "linkedin_company_id": 1407685, "domain_ids": [ 10862513, 3254042745, 2617941789, 953909397, 368243151 ], "country_code": "US", "company_size": 11300, "company_keywords": [ "payments", "developer tools", "cloud infrastructure", "credit cards", "consumer internet", "enterprise software", "software", "internet", "information technology", "technology, information & internet", "global payments", "online payments", "payment links", "checkout solutions", "subscription billing", "invoicing", "fraud prevention", "identity verification", "financial automation", "business financing", "virtual cards", "embedded finance", "transaction monitoring", "data analytics", "payment methods" ], "is_company_url_active": true, "company_url": "https://stripe.com/", "youtube_url": null, "github_url": null, "x_url": null, "crunchbase_url": null, "linkedin_url": "https://www.linkedin.com/company/stripe", "instagram_url": null, "facebook_url": "https://facebook.com/stripehq", "twitter_url": "http://twitter.com/stripe", "country": "United States", "location": "United States", "sequences": null, "saved_lists": null, "company_addresses": [ "354 Oyster Point Blvd South San Francisco, California 94080, US", "1 Grand Canal Street Lower Dublin, County Dublin, IE", "920 5th Ave Seattle, Washington 98104, US", "211 Old Street London, England EC1V 9NR, GB", "10, Boulevard Haussmann Paris, Ile-de-France 75009, FR", "89 Neil Rd Central Business District, Singapore 088894, SG", "1-5-8 Jingumae Tokyo, Shibuya-ku 150-0001, JP", "515 N State St Chicago, Illinois 60610, US", "11 Park Pl New York, NY 10301, US", "Singel 542 Amsterdam, North Holland 1017, NL", "Avenida Paseo De La Reforma 296 Ciudad De Mexico, Colonia Juarez 06600, MX", "222 Exhibition St Melbourne, Victoria 3000, AU", "Avenida Paulista 1374 Paulínia, São Paulo 13140-000, BR", "Church Street Haridevpur, Shanthala Nagar, Ashok Nagar Bengaluru, Karnataka 560001, IN" ], "company_size_printed": "11,300+" }, "jobs": [ { "job_id": "e4077f8d-2b3d-4a9b-935e-123faae6f9a2", "job_search_id": "e4077f8d-2b3d-4a9b-935e-123faae6f9a2", "last_modified": "2025-06-05T08:04:00.294Z", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/MTA4NjI1MTNzdHJpcGUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "5378845d-7726-4817-aba9-ced8c5f41dee", "company_name": "Stripe", "linkedin_name": "stripe", "country_code": "US", "domain": "stripe.com" }, "location": "Toronto, Ontario, Canada", "job_url": "https://ca.linkedin.com/jobs/view/program-lead-stripe-startups-at-stripe-4244851093?position=9&pageNum=0&refId=dSWk2H9vKbZkQFgUb0YAqA%3D%3D&trackingId=tU1BYodLertdWt%2F7NIn4Tw%3D%3D", "posting_date": "2025-06-04", "country_code": "CA", "location_id": 395, "title": "Program Lead, Stripe Startups", "country": "Canada" }, "..." ], "news": [ { "news_id": "032606ce-46b6-4bf5-9aa9-8ecc96f126bc", "news_search_id": "15872966-7b73-4361-be8f-2415bf4c72d9", "domains": [ "openai.com", "microsoft.com", "anthropic.com", "perplexity.ai", "stripe.com", "github.com", "salesforce.com", "canva.com", "adobe.com", "atlassian.com", "zoom.us" ], "companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MzA2MTI3NThhdGxhc3NpYW4uY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "1437c841-a4b8-48c1-9be3-3dafb68dfd41", "country_code": "AU", "company_name": "Atlassian", "linkedin_name": "atlassian", "domain": "atlassian.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/NTU1MDU5MDdhbnRocm9waWMuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "15dd54c6-12b4-494a-84f4-9fff676ac7e0", "country_code": "US", "company_name": "Anthropic", "linkedin_name": "anthropicresearch", "domain": "anthropic.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MjMzNDM2OTQxYWRvYmUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "1fda6cfb-dacd-40a9-bb77-21ebc81c79e2", "country_code": "US", "company_name": "Adobe", "linkedin_name": "adobe", "domain": "adobe.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MjY5OTUyODdzYWxlc2ZvcmNlLmNvbWxpbmtlZGluX3BfbG9nbzE1.jpg", "domain_search_id": "29437edb-9d9a-45a3-8f43-481cbfaab1bf", "country_code": "US", "company_name": "Salesforce", "linkedin_name": "salesforce", "domain": "salesforce.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MTA4NjI1MTNzdHJpcGUuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "5378845d-7726-4817-aba9-ced8c5f41dee", "country_code": "US", "company_name": "Stripe", "linkedin_name": "stripe", "domain": "stripe.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MzA2MTIzNTVvcGVuYWkuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "67c4696b-b7b0-46b5-b2af-9f434543661e", "country_code": "US", "company_name": "Openai", "linkedin_name": "openai", "domain": "openai.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MzY4MjQyNzQ4aWxqOXNzbmoxZ2l0aHViLmNvbWxpbmtlZGluXzE0MDY4NDg=.jpg", "domain_search_id": "838c52f2-ab18-4258-b37c-e00bc568f747", "country_code": "US", "company_name": "Github", "linkedin_name": "github", "domain": "github.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MTU0MDk4MjAxMHpvb20udXNsaW5rZWRpbl9wX2xvZ28xNQ==.jpg", "domain_search_id": "a90c7f40-ed1a-4675-b348-f36cbcf94481", "country_code": "US", "company_name": "Zoom", "linkedin_name": "zoom", "domain": "zoom.us" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MzA2MTIyODdjYW52YS5jb21saW5rZWRpbl9wX2xvZ28xNQ==.jpg", "domain_search_id": "b5405a6c-81a7-4f86-bd09-ebf728b667bf", "country_code": "AU", "company_name": "Canva", "linkedin_name": "canva", "domain": "canva.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MTQyMjQxMjk4bWljcm9zb2Z0LmNvbWxpbmtlZGluX3BfbG9nbzE1.jpg", "domain_search_id": "dd225537-283f-46bf-ba1c-cb0c6a1311bb", "country_code": "US", "company_name": "Microsoft", "linkedin_name": "microsoft", "domain": "microsoft.com" }, { "logo_url": "https://buckets.pubrio.com/company-logo/MTU0MDk4MjEyNnBlcnBsZXhpdHkuYWlsaW5rZWRpbl9wX2xvZ28xNQ==.jpg", "domain_search_id": "fe169c45-f426-4ec4-985e-c88b2d78d044", "country_code": "US", "company_name": "Perplexity", "linkedin_name": "perplexity-ai", "domain": "perplexity.ai" } ], "news_galleries": [ { "slug": "technology", "news_gallery_id": "9536114f-231a-489c-8a8a-1cbf82a327a4", "name": "Technology" } ], "locations": [ "China" ], "last_modified": "2025-06-04T07:43:14.260Z", "image_url": "https://analyticsindiamag.com/wp-content/uploads/2025/06/ai-monetisation-llm.jpg", "url": "https://analyticsindiamag.com/ai-features/llm-companies-vs-saas-giants-whos-winning-in-ai-monetisation/", "published_at": "2025-06-04T07:03:49.000000Z", "language": "en", "source": "analyticsindiamag.com", "category": "launches", "title": "LLM companies vs SaaS giants: AI monetization race", "summary": "LLM companies show rapid growth but struggle with profitability, while SaaS giants integrate AI cautiously into existing services, leveraging their large user base.", "news_category_name": "Launches" }, "..." ], "similar_companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MzY4MjQzODc3cmlwcGxlLmNvbWxpbmtlZGluX3BfbG9nbzE1.jpg", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "similarity_score": 0.6540610253955462, "estimated_revenue": 500000000, "publicly_traded_symbol": null, "publicly_traded_exchange": null, "linkedin_name": "rippleofficial", "domains": [ "ripple.com" ], "locations": [ "US" ], "categories": null, "verticals": [ "69086483", "24076059", "69085537", "69107205" ], "vertical_categories": [ "16", "18" ], "vertical_sub_categories": [ "103", "120" ], "company_ranking": 8133, "title": "We're building the Internet of Value.", "company_type": "Privately Held", "description": "Using proven crypto and blockchain technology honed over a decade, Ripple’s enterprise-grade solutions are faster, more transparent, and more cost-effective than traditional financial services. Our customers use these solutions to source crypto, facilitate instant payments, empower their treasury, engage new audiences, lower capital requirements, and drive new revenue. Founded in 2012, Ripple's vision is to enable a world where value moves as seamlessly as information flows today—an Internet of Value. Ripple is the only enterprise blockchain company today with products in commercial use. Ripple’s global payments network includes over 300 customers across 40+ countries and six continents.", "company_address": "San Francisco, CA", "linkedin_uid": "3249443", "company_name": "Ripple", "founded_year": 2012, "industry": "Technology, Information And Internet", "specialties": [ "Technology", "Technology, Information And Internet", "Financial Services", "Blockchain" ], "domain": "ripple.com", "domain_search_id": "eac9e802-d574-4f5f-b7d9-4daadbdcd630", "domain_id": 368243877, "parent_id": null, "linkedin_company_id": 1408892, "domain_ids": [ 368243877, 3252571626, 1758856012, 2617948464 ], "country_code": "US", "company_size": 1400, "company_keywords": [ "crossborder payments", "financial technology", "cryptography", "distributed ledgers", "fintech", "finance", "blockchain", "payments", "cryptocurrency", "fin tech", "blockchains", "blockchain / cryptocurrency", "technology, information & internet", "digital asset custody", "blockchain technology", "real-time settlement", "liquidity management", "stablecoin issuance", "enterprise blockchain", "xrp ledger", "secure custody solutions", "digital asset management", "financial institutions", "tokenization" ], "is_company_url_active": true, "company_url": "https://www.ripple.com/", "youtube_url": null, "github_url": null, "x_url": "https://x.com/ripple", "crunchbase_url": null, "linkedin_url": "https://www.linkedin.com/company/rippleofficial", "instagram_url": null, "facebook_url": null, "twitter_url": "https://twitter.com/ripple", "country": "United States", "location": "United States", "sequences": null, "saved_lists": null, "company_addresses": [ "San Francisco, CA 94104, US" ], "company_size_printed": "1,400+" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ] } } } }, "operationId": "companies_enrich", "summary": "丰富公司记录", "description": "实时公司数据增强。一次调用即可返回公司记录及其近期的招聘、媒体、广告与相似公司信号。\n\n**首次针对某家公司的调用可能较慢。** 当记录需要从零开始增强时，耗时可达数十秒 —— 实测一次冷调用耗时 45 秒。完成增强后，同一家公司的再次调用会在一秒以内返回。请将 HTTP 客户端超时设置为至少 90 秒：许多客户端默认 30 秒，会中断本可成功的冷调用。若你始终只需要已存储的记录，请改用 [Company Lookup](/cn/api-reference/endpoint/companies/lookup)，它始终很快。", "tags": [ "Enrichment" ] } }, "/people/search": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文：回显的 `filters` 和 `parameters`、可选的 `profile` 额度块，以及 `ignored_fields`（端点丢弃的请求键）。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "metadata": { "filters": { "management_levels": [ "c_suite" ] }, "profile": null }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 199616132, "total_pages": 100, "total_display_pages": 100, "is_timeout": false }, "peoples": [ { "people_search_id": "134591fb-f0fa-41ba-9c8c-f1eb8aab8946", "name": "Doug McMillon", "first_name": "Doug", "last_name": "McMillon", "title": "President & CEO", "seniority": "c_suite", "functions": null, "headline": "President & CEO at Walmart Inc.", "tagline": null, "introduction": null, "description": null, "departments": [ "c_suite" ], "subdepartments": [ "executive" ], "keywords": null, "employment_history": [ { "title": "President & CEO", "current": true, "end_date": null, "start_date": "2014-02-01", "company_name": "Walmart" }, { "title": "President & CEO, Walmart International", "current": false, "end_date": "2014-01-01", "start_date": "2009-02-01", "company_name": "Walmart" }, { "title": "President & CEO", "current": false, "end_date": "2009-01-01", "start_date": "2005-08-01", "company_name": "Sam's Club" } ], "country": "United States", "country_code": "US", "location": "United States", "state": "Arkansas", "city": "Bentonville", "wantedly_name": null, "rocketpunch_name": null, "contacts": null, "contact_types": [], "emails": null, "phones": null, "facebook_url": null, "github_url": null, "twitter_url": null, "linkedin_url": "http://www.linkedin.com/in/dougmcmillon", "wantedly_url": null, "rocketpunch_url": null, "saved_lists": null, "sequences": null, "social_metadata": {}, "company": { "company_name": "Walmart", "company_url": "http://walmart.com", "is_company_url_active": true, "domain": "walmart.com", "domain_id": 26067151, "domain_ids": [ 757023267, 368242703, 26067151 ], "domain_search_id": "2a0d6cd7-cc10-44d6-94ec-41fd528a11b6", "founded_year": 1962, "country": "United States", "country_code": "US", "location": "United States", "phones": null, "emails": [], "contacts": [], "wantedly_name": null, "rocketpunch_name": null, "tiktok_name": null, "company_size_printed": "466,000", "company_size": 466000, "industry": "Retail", "specialties": [ "Retail", "E-commerce" ], "logo_url": "https://buckets.pubrio.com/company-logo/NzU3MDIzMjY3aWxqOXNzbmoxd2FsbWFydC5jb21saW5rZWRpbl8zMzMxOTgxMg==.jpg", "linkedin_url": "http://www.linkedin.com/company/walmart", "facebook_url": "http://facebook.com/walmart", "twitter_url": "https://twitter.com/walmart", "crunchbase_url": null, "instagram_url": "http://instagram.com/walmart", "youtube_url": "http://youtube.com/user/walmart", "x_url": null, "github_url": null, "tiktok_url": null, "wantedly_url": null, "rocketpunch_url": null, "social_metadata": {} } }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "search_term": { "$ref": "#/components/schemas/search_term" }, "people_name": { "$ref": "#/components/schemas/people_name" }, "people_titles": { "$ref": "#/components/schemas/people_titles" }, "exclude_people_titles": { "$ref": "#/components/schemas/exclude_people_titles" }, "peoples": { "$ref": "#/components/schemas/peoples" }, "management_levels": { "$ref": "#/components/schemas/management_levels" }, "departments": { "$ref": "#/components/schemas/departments" }, "exclude_departments": { "$ref": "#/components/schemas/exclude_departments" }, "department_functions": { "$ref": "#/components/schemas/functions" }, "exclude_department_functions": { "$ref": "#/components/schemas/exclude_department_functions" }, "employees": { "$ref": "#/components/schemas/employees" }, "people_locations": { "$ref": "#/components/schemas/people_locations" }, "exclude_people_locations": { "$ref": "#/components/schemas/exclude_people_locations" }, "company_locations": { "$ref": "#/components/schemas/company_locations" }, "company_exclude_locations": { "$ref": "#/components/schemas/company_exclude_locations" }, "company_linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "linkedin_urls": { "$ref": "#/components/schemas/people_linkedin_urls" }, "companies": { "$ref": "#/components/schemas/companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "company_filters": { "$ref": "#/components/schemas/company_filters" }, "filter_conditions": { "$ref": "#/components/schemas/people_filter_conditions" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/is_enable_similarity_search" }, "similarity_score": { "$ref": "#/components/schemas/similarity_score" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "query": { "type": "string", "example": "decision makers in marketing", "description": "自然语言搜索。提供后，Pubrio 会将其解析为下方的人员和公司筛选条件（职位、职级、部门、地区、行业、公司规模等）。您同时传入的显式筛选条件将优先于解析结果。留空则仅按结构化筛选条件搜索。" }, "is_include_similar_people_titles": { "type": "boolean", "description": "启用后，`people_titles` 除精确匹配外，还会匹配相近的职位名称（例如 `software engineer` 可匹配 `senior software engineer`）。" }, "people_title_similarity_score": { "type": "number", "format": "float", "example": 0.9, "description": "与 `is_include_similar_people_titles` 配合使用。控制职位名称需要多接近才算匹配，数值越高，匹配越严格。" } } } } } }, "operationId": "people_search", "summary": "搜索人员", "description": "在 Pubrio 数据库中搜索符合指定条件（如职位、地点、公司和资历）的人员。", "tags": [ "Search" ] } }, "/people/search/similar": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文——回显的 `filters` 与 `parameters`，以及在请求积分核算时返回的、包含 `credit`、`topup_credit` 和 `total_credit_cost` 的 `profile` 区块。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "metadata": { "filters": { "management_levels": [ "c_suite" ] }, "profile": null }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 199616132, "total_pages": 100, "total_display_pages": 100, "is_timeout": false }, "peoples": [ { "people_search_id": "134591fb-f0fa-41ba-9c8c-f1eb8aab8946", "name": "Doug McMillon", "first_name": "Doug", "last_name": "McMillon", "title": "President & CEO", "seniority": "c_suite", "functions": null, "headline": "President & CEO at Walmart Inc.", "tagline": null, "introduction": null, "description": null, "departments": [ "c_suite" ], "subdepartments": [ "executive" ], "keywords": null, "employment_history": [ { "title": "President & CEO", "current": true, "end_date": null, "start_date": "2014-02-01", "company_name": "Walmart" }, { "title": "President & CEO, Walmart International", "current": false, "end_date": "2014-01-01", "start_date": "2009-02-01", "company_name": "Walmart" }, { "title": "President & CEO", "current": false, "end_date": "2009-01-01", "start_date": "2005-08-01", "company_name": "Sam's Club" } ], "country": "United States", "country_code": "US", "location": "United States", "state": "Arkansas", "city": "Bentonville", "wantedly_name": null, "rocketpunch_name": null, "contacts": null, "contact_types": [], "emails": null, "phones": null, "facebook_url": null, "github_url": null, "twitter_url": null, "linkedin_url": "http://www.linkedin.com/in/dougmcmillon", "wantedly_url": null, "rocketpunch_url": null, "saved_lists": null, "sequences": null, "social_metadata": {}, "company": { "company_name": "Walmart", "company_url": "http://walmart.com", "is_company_url_active": true, "domain": "walmart.com", "domain_id": 26067151, "domain_ids": [ 757023267, 368242703, 26067151 ], "domain_search_id": "2a0d6cd7-cc10-44d6-94ec-41fd528a11b6", "founded_year": 1962, "country": "United States", "country_code": "US", "location": "United States", "phones": null, "emails": [], "contacts": [], "wantedly_name": null, "rocketpunch_name": null, "tiktok_name": null, "company_size_printed": "466,000", "company_size": 466000, "industry": "Retail", "specialties": [ "Retail", "E-commerce" ], "logo_url": "https://buckets.pubrio.com/company-logo/NzU3MDIzMjY3aWxqOXNzbmoxd2FsbWFydC5jb21saW5rZWRpbl8zMzMxOTgxMg==.jpg", "linkedin_url": "http://www.linkedin.com/company/walmart", "facebook_url": "http://facebook.com/walmart", "twitter_url": "https://twitter.com/walmart", "crunchbase_url": null, "instagram_url": "http://instagram.com/walmart", "youtube_url": "http://youtube.com/user/walmart", "x_url": null, "github_url": null, "tiktok_url": null, "wantedly_url": null, "rocketpunch_url": null, "social_metadata": {} } }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "people_search_id": { "type": "string", "description": "作为参照对象的 Pubrio 人物 ID。" }, "linkedin_url": { "type": "string", "description": "作为参照对象的单个 LinkedIn 个人主页 URL。" }, "identifier": { "type": "string", "description": "用于驱动相似度搜索的自由格式参照字符串（姓名、职位或主页 URL）。" }, "search_term": { "$ref": "#/components/schemas/search_term" }, "people_name": { "$ref": "#/components/schemas/people_name" }, "people_titles": { "$ref": "#/components/schemas/people_titles" }, "peoples": { "$ref": "#/components/schemas/peoples" }, "management_levels": { "$ref": "#/components/schemas/management_levels" }, "departments": { "$ref": "#/components/schemas/departments" }, "department_functions": { "$ref": "#/components/schemas/functions" }, "employees": { "$ref": "#/components/schemas/employees" }, "people_locations": { "$ref": "#/components/schemas/people_locations" }, "company_locations": { "$ref": "#/components/schemas/company_locations" }, "company_linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "linkedin_urls": { "$ref": "#/components/schemas/people_linkedin_urls" }, "companies": { "$ref": "#/components/schemas/companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "filter_conditions": { "$ref": "#/components/schemas/people_filter_conditions" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/is_enable_similarity_search" }, "similarity_score": { "$ref": "#/components/schemas/similarity_score" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "company_filters": { "$ref": "#/components/schemas/company_filters" } }, "anyOf": [ { "title": "peoples", "required": [ "peoples" ] }, { "title": "people_search_id", "required": [ "people_search_id" ] }, { "title": "people_titles", "required": [ "people_titles" ] }, { "title": "linkedin_url", "required": [ "linkedin_url" ] }, { "title": "linkedin_urls", "required": [ "linkedin_urls" ] }, { "title": "identifier", "required": [ "identifier" ] } ] } } } }, "operationId": "people_search_similar", "summary": "搜索相似人员", "description": "查找与参考人员相似的人员。提供一个参考（`people_search_id`、`linkedin_url`、`linkedin_urls`、`peoples` 或 `people_titles`）；结果行带有 `similarity_score` 并按其从高到低排序。", "tags": [ "Lookalike" ] } }, "/companies/search": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文：`recent_search_log_identifier`、回显的 `parameters` 和 `filters`、可选的 `profile` 额度块，以及 `ignored_fields`（端点丢弃的请求键）。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 45234700, "total_pages": 1809388 }, "companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MjI0NDc1OTMxaWxqOXNzbmoxdHdpdHRlci5jb20=.jpg", "company_name": "Twitter", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "founded_year": 2006, "specialties": [ "Software Development" ], "industry": "Software Development", "domain": "twitter.com", "domain_search_id": "61a73da7-2efc-41a5-a252-a8a8df29925a", "domain_id": 224475931, "linkedin_company_id": 44005587, "linkedin_name": "twitter", "is_company_url_active": true, "domain_ids": [ 224475931, 1758889566, 368242865 ], "company_keywords": [ "realtime information", "social commerce", "online shopping", "classifieds", "craigslist killers", "e-commerce", "killers", "consumer internet", "internet", "information technology", "edp services", "technology", "software development", "microblogging", "social networking", "public conversation", "user engagement", "content sharing", "advertising solutions", "monetization", "community building", "digital wallet", "ai integration", "user safety" ], "company_size": 1500, "youtube_url": null, "crunchbase_url": null, "linkedin_url": "http://www.linkedin.com/company/twitter", "instagram_url": null, "facebook_url": "http://facebook.com/twitterinc", "twitter_url": "https://twitter.com/x", "github_url": null, "x_url": null, "location": "United States", "company_ranking": null, "company_url": "http://twitter.com", "saved_lists": null, "company_size_printed": "1,500" }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_name": { "$ref": "#/components/schemas/company_name" }, "companies": { "$ref": "#/components/schemas/companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "company_filters": { "$ref": "#/components/schemas/company_filters" }, "locations": { "$ref": "#/components/schemas/locations" }, "exclude_locations": { "$ref": "#/components/schemas/exclude_locations" }, "places": { "$ref": "#/components/schemas/places" }, "exclude_places": { "$ref": "#/components/schemas/exclude_places" }, "job_locations": { "$ref": "#/components/schemas/locations" }, "job_exclude_locations": { "$ref": "#/components/schemas/job_exclude_locations" }, "job_posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "job_titles": { "$ref": "#/components/schemas/people_titles" }, "verticals": { "$ref": "#/components/schemas/verticals" }, "vertical_categories": { "$ref": "#/components/schemas/vertical_categories" }, "vertical_sub_categories": { "$ref": "#/components/schemas/vertical_sub_categories" }, "categories": { "$ref": "#/components/schemas/categories" }, "technologies": { "$ref": "#/components/schemas/technologies" }, "employees": { "$ref": "#/components/schemas/employees" }, "revenues": { "$ref": "#/components/schemas/revenues" }, "founded_dates": { "$ref": "#/components/schemas/founded_dates" }, "keywords": { "$ref": "#/components/schemas/keywords" }, "social_media": { "$ref": "#/components/schemas/company_social_media" }, "news_categories": { "$ref": "#/components/schemas/news_categories" }, "news_published_dates": { "$ref": "#/components/schemas/published_dates" }, "advertisement_search_terms": { "$ref": "#/components/schemas/advertisement_search_terms" }, "advertisement_target_locations": { "$ref": "#/components/schemas/advertisement_target_locations" }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/advertisement_exclude_target_locations" }, "advertisement_start_dates": { "$ref": "#/components/schemas/advertisement_start_dates" }, "advertisement_end_dates": { "$ref": "#/components/schemas/advertisement_end_dates" }, "advertisement_active_dates": { "$ref": "#/components/schemas/advertisement_active_dates" }, "advertisement_status": { "$ref": "#/components/schemas/advertisement_status" }, "advertisement_headlines": { "$ref": "#/components/schemas/advertisement_headlines" }, "advertisement_platforms": { "$ref": "#/components/schemas/advertisement_platforms" }, "advertisement_publisher_platforms": { "$ref": "#/components/schemas/advertisement_publisher_platforms" }, "advertisement_exclude_publisher_platforms": { "$ref": "#/components/schemas/advertisement_exclude_publisher_platforms" }, "advertisement_formats": { "$ref": "#/components/schemas/advertisement_formats" }, "advertisement_active_ads": { "$ref": "#/components/schemas/advertisement_active_ads" }, "advertisement_running_ads": { "$ref": "#/components/schemas/advertisement_running_ads" }, "advertisement_total_ads": { "$ref": "#/components/schemas/advertisement_total_ads" }, "advertisement_platform_count": { "$ref": "#/components/schemas/advertisement_platform_count" }, "advertisement_format_count": { "$ref": "#/components/schemas/advertisement_format_count" }, "advertisement_impressions_estimate": { "$ref": "#/components/schemas/advertisement_impressions_estimate" }, "advertisement_country_activity": { "$ref": "#/components/schemas/advertisement_country_activity" }, "sort_by": { "$ref": "#/components/schemas/company_sort_by" }, "is_ascending_order": { "type": "boolean", "example": true, "description": "`sort_by` 的排序方向。默认为升序，对 `advertisement_country_rank` 而言即投放量最大的广告主排在最前。" }, "filter_conditions": { "$ref": "#/components/schemas/company_filter_conditions" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/is_enable_similarity_search" }, "similarity_score": { "$ref": "#/components/schemas/similarity_score" }, "exclude_fields": { "$ref": "#/components/schemas/exclude_fields" }, "is_parameter_metadata_available": { "$ref": "#/components/schemas/is_parameter_metadata_available" }, "is_profile_metadata_available": { "$ref": "#/components/schemas/is_profile_metadata_available" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "cloud_footprint_providers": { "$ref": "#/components/schemas/cloud_footprint_providers" }, "cloud_footprint_exclude_providers": { "$ref": "#/components/schemas/exclude_providers" }, "cloud_footprint_target_locations": { "$ref": "#/components/schemas/cloud_footprint_target_locations" }, "cloud_footprint_exclude_target_locations": { "$ref": "#/components/schemas/cloud_footprint_exclude_target_locations" }, "cloud_footprint_cloud_regions": { "$ref": "#/components/schemas/cloud_regions" }, "cloud_footprint_exclude_cloud_regions": { "$ref": "#/components/schemas/exclude_cloud_regions" }, "cloud_footprint_cities": { "$ref": "#/components/schemas/cities" }, "cloud_footprint_exclude_cities": { "$ref": "#/components/schemas/exclude_cities" }, "cloud_footprint_first_seen_dates": { "$ref": "#/components/schemas/first_seen_dates" }, "cloud_footprint_last_seen_dates": { "$ref": "#/components/schemas/last_seen_dates" }, "cloud_footprint_is_cross_border_only": { "$ref": "#/components/schemas/is_cross_border_only" }, "cloud_footprint_host_count": { "$ref": "#/components/schemas/cloud_footprint_host_count" }, "cloud_footprint_server_count": { "$ref": "#/components/schemas/cloud_footprint_server_count" }, "cloud_footprint_shared_server_count": { "$ref": "#/components/schemas/cloud_footprint_shared_server_count" }, "cloud_footprint_provider_count": { "$ref": "#/components/schemas/cloud_footprint_provider_count" }, "cloud_footprint_country_count": { "$ref": "#/components/schemas/cloud_footprint_country_count" }, "cloud_footprint_cross_border_country_count": { "$ref": "#/components/schemas/cloud_footprint_cross_border_country_count" }, "cloud_footprint_region_count": { "$ref": "#/components/schemas/cloud_footprint_region_count" }, "cloud_footprint_city_count": { "$ref": "#/components/schemas/cloud_footprint_city_count" }, "cloud_footprint_primary_provider": { "$ref": "#/components/schemas/cloud_footprint_primary_provider" }, "cloud_footprint_country_activity": { "$ref": "#/components/schemas/cloud_footprint_country_activity" } } } } } }, "operationId": "companies_search", "summary": "搜索公司", "description": "在 Pubrio 数据库中搜索符合指定条件（如行业、规模、地点和技术）的公司。", "tags": [ "Search" ] } }, "/companies/search/similar": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文。包含回显的 `filters` 与 `parameters`，以及带有 `credit`、`topup_credit` 和 `total_credit_cost` 的 `profile` 区块 —— 这是 API 返回的唯一按次积分核算信息。" }, "data": { "type": "array", "description": "按相似度排序的相似公司列表。请注意本端点直接返回数组 —— 与其他搜索端点不同，`data` 内没有 `pagination` 包装层。", "items": { "type": "object" } } } }, "example": { "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 45234700, "total_pages": 1809388 }, "companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MjI0NDc1OTMxaWxqOXNzbmoxdHdpdHRlci5jb20=.jpg", "company_name": "Twitter", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "founded_year": 2006, "specialties": [ "Software Development" ], "industry": "Software Development", "domain": "twitter.com", "domain_search_id": "61a73da7-2efc-41a5-a252-a8a8df29925a", "domain_id": 224475931, "linkedin_company_id": 44005587, "linkedin_name": "twitter", "is_company_url_active": true, "domain_ids": [ 224475931, 1758889566, 368242865 ], "company_keywords": [ "realtime information", "social commerce", "online shopping", "classifieds", "craigslist killers", "e-commerce", "killers", "consumer internet", "internet", "information technology", "edp services", "technology", "software development", "microblogging", "social networking", "public conversation", "user engagement", "content sharing", "advertising solutions", "monetization", "community building", "digital wallet", "ai integration", "user safety" ], "company_size": 1500, "youtube_url": null, "crunchbase_url": null, "linkedin_url": "http://www.linkedin.com/company/twitter", "instagram_url": null, "facebook_url": "http://facebook.com/twitterinc", "twitter_url": "https://twitter.com/x", "github_url": null, "x_url": null, "location": "United States", "company_ranking": null, "company_url": "http://twitter.com", "saved_lists": null, "company_size_printed": "1,500", "similarity_score": 0.87 }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_search_id": { "type": "string", "description": "Pubrio company identifier." }, "domain": { "type": "string", "description": "公司的主域名，例如 `stripe.com`。", "example": "stripe.com" }, "linkedin_url": { "type": "string", "description": "LinkedIn company URL." }, "tiktok_url": { "type": "string", "description": "公司的 TikTok 主页 URL。" }, "wantedly_url": { "type": "string", "description": "公司的 Wantedly 主页 URL。" }, "tw104_url": { "type": "string", "description": "公司的 104（台湾）主页 URL。" }, "rocketpunch_url": { "type": "string", "description": "公司的 RocketPunch 主页 URL。" }, "remember_url": { "type": "string", "description": "公司的 Remember 主页 URL。" }, "youtrust_url": { "type": "string", "description": "公司的 YOUTRUST 主页 URL。" }, "company_name": { "$ref": "#/components/schemas/company_name" }, "companies": { "$ref": "#/components/schemas/companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "locations": { "$ref": "#/components/schemas/locations" }, "exclude_locations": { "$ref": "#/components/schemas/exclude_locations" }, "places": { "$ref": "#/components/schemas/places" }, "exclude_places": { "$ref": "#/components/schemas/exclude_places" }, "job_locations": { "$ref": "#/components/schemas/locations" }, "job_exclude_locations": { "$ref": "#/components/schemas/job_exclude_locations" }, "job_posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "job_titles": { "$ref": "#/components/schemas/people_titles" }, "verticals": { "$ref": "#/components/schemas/verticals" }, "vertical_categories": { "$ref": "#/components/schemas/vertical_categories" }, "vertical_sub_categories": { "$ref": "#/components/schemas/vertical_sub_categories" }, "categories": { "$ref": "#/components/schemas/categories" }, "technologies": { "$ref": "#/components/schemas/technologies" }, "employees": { "$ref": "#/components/schemas/employees" }, "revenues": { "$ref": "#/components/schemas/revenues" }, "founded_dates": { "$ref": "#/components/schemas/founded_dates" }, "keywords": { "$ref": "#/components/schemas/keywords" }, "news_categories": { "$ref": "#/components/schemas/news_categories" }, "news_published_dates": { "$ref": "#/components/schemas/published_dates" }, "advertisement_search_terms": { "$ref": "#/components/schemas/advertisement_search_terms" }, "advertisement_target_locations": { "$ref": "#/components/schemas/advertisement_target_locations" }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/advertisement_exclude_target_locations" }, "advertisement_start_dates": { "$ref": "#/components/schemas/advertisement_start_dates" }, "advertisement_end_dates": { "$ref": "#/components/schemas/advertisement_end_dates" }, "filter_conditions": { "$ref": "#/components/schemas/company_filter_conditions" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/is_enable_similarity_search" }, "similarity_score": { "$ref": "#/components/schemas/similarity_score" }, "exclude_fields": { "$ref": "#/components/schemas/exclude_fields" }, "is_parameter_metadata_available": { "$ref": "#/components/schemas/is_parameter_metadata_available" }, "is_profile_metadata_available": { "$ref": "#/components/schemas/is_profile_metadata_available" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "company_filters": { "$ref": "#/components/schemas/company_filters" } }, "anyOf": [ { "title": "domain_search_id", "required": [ "domain_search_id" ] }, { "title": "domain", "required": [ "domain" ] }, { "title": "linkedin_url", "required": [ "linkedin_url" ] }, { "title": "tiktok_url", "required": [ "tiktok_url" ] }, { "title": "wantedly_url", "required": [ "wantedly_url" ] }, { "title": "tw104_url", "required": [ "tw104_url" ] }, { "title": "rocketpunch_url", "required": [ "rocketpunch_url" ] }, { "title": "remember_url", "required": [ "remember_url" ] }, { "title": "youtrust_url", "required": [ "youtrust_url" ] } ] } } } }, "operationId": "companies_search_similar", "summary": "搜索相似公司", "description": "查找与参考公司相似的公司。只提供一个单数标识符（`domain_search_id`、`domain`、`linkedin_url` 或其他 `*_url`）；结果行带有 `similarity_score` 并按其从高到低排序。", "tags": [ "Lookalike" ] } }, "/companies/lookalikes/search": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文。包含回显的 `filters` 与 `parameters`，以及带有 `credit`、`topup_credit` 和 `total_credit_cost` 的 `profile` 区块 —— 这是 API 返回的唯一按次积分核算信息。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 45234700, "total_pages": 1809388 }, "companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MjI0NDc1OTMxaWxqOXNzbmoxdHdpdHRlci5jb20=.jpg", "company_name": "Twitter", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "founded_year": 2006, "specialties": [ "Software Development" ], "industry": "Software Development", "domain": "twitter.com", "domain_search_id": "61a73da7-2efc-41a5-a252-a8a8df29925a", "domain_id": 224475931, "linkedin_company_id": 44005587, "linkedin_name": "twitter", "is_company_url_active": true, "domain_ids": [ 224475931, 1758889566, 368242865 ], "company_keywords": [ "realtime information", "social commerce", "online shopping", "classifieds", "craigslist killers", "e-commerce", "killers", "consumer internet", "internet", "information technology", "edp services", "technology", "software development", "microblogging", "social networking", "public conversation", "user engagement", "content sharing", "advertising solutions", "monetization", "community building", "digital wallet", "ai integration", "user safety" ], "company_size": 1500, "youtube_url": null, "crunchbase_url": null, "linkedin_url": "http://www.linkedin.com/company/twitter", "instagram_url": null, "facebook_url": "http://facebook.com/twitterinc", "twitter_url": "https://twitter.com/x", "github_url": null, "x_url": null, "location": "United States", "company_ranking": null, "company_url": "http://twitter.com", "saved_lists": null, "company_size_printed": "1,500" }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "$ref": "#/components/schemas/locations" }, "exclude_locations": { "$ref": "#/components/schemas/exclude_locations" }, "technologies": { "$ref": "#/components/schemas/technologies" }, "categories": { "$ref": "#/components/schemas/categories" }, "verticals": { "$ref": "#/components/schemas/verticals" }, "vertical_categories": { "$ref": "#/components/schemas/vertical_categories" }, "vertical_sub_categories": { "$ref": "#/components/schemas/vertical_sub_categories" }, "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" }, "employees": { "$ref": "#/components/schemas/employees" }, "founded_dates": { "$ref": "#/components/schemas/founded_dates" }, "revenues": { "$ref": "#/components/schemas/revenues" }, "job_locations": { "$ref": "#/components/schemas/locations" }, "job_posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "job_titles": { "$ref": "#/components/schemas/people_titles" }, "news_categories": { "$ref": "#/components/schemas/news_categories" }, "news_published_dates": { "$ref": "#/components/schemas/published_dates" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/is_enable_similarity_search" }, "similarity_score": { "$ref": "#/components/schemas/similarity_score" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ] } } } }, "operationId": "companies_search_lookalikes", "summary": "搜索相似公司", "description": "**已弃用。** 请改用 `POST /companies/search/similar` — 数据相同,请求体相同。\n\n根据公司特征和技术属性，查找与指定目标公司相似的公司。", "tags": [ "Lookalike" ], "deprecated": true } }, "/companies/jobs/search": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/search_metadata" }, "data": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/search_pagination" }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/job_search_result" } } } } } }, "example": { "metadata": { "profile": null, "filters": { "domains": [ "google.com" ], "per_page": 25, "language": "en" }, "ignored_fields": [] }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 2228628, "total_pages": 89146, "is_timeout": false, "total_display_pages": 250 }, "jobs": [ { "job_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "job_search_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "last_modified": "2025-05-31T20:41:27.894Z", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/OTQxMjYxMTFnb29nbGUuY29tLnBrbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "539e2c34-de6b-4613-8f5b-e3aa18b4ef47", "company_name": "Google", "linkedin_name": "google", "country_code": "US", "domain": "google.com" }, "location": "Seoul, Seoul, South Korea", "job_url": "https://kr.linkedin.com/jobs/view/software-engineer-greach-program-for-people-with-disabilities-%EC%9E%A5%EC%95%A0%EC%9D%B8-%EC%B1%84%EC%9A%A9-at-google-4224659596?position=7&pageNum=0&refId=DwDpGXGftUql%2FkETvFCwXw%3D%3D&trackingId=gAvrIP0yUQuf8fjK67HSbQ%3D%3D", "posting_date": "2025-05-31", "country_code": "KR", "location_id": 491, "title": "Software Engineer, gReach Program for People with Disabilities (장애인 채용)", "country": "South Korea", "created_at": "2025-05-10T14:30:58.348Z", "source_type": "linkedin", "functions": null, "seniority_rank": 0, "base_salary": null, "experience_requirement": null, "education_requirement": null, "employment_type": null }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "$ref": "#/components/schemas/locations" }, "exclude_locations": { "type": "array", "items": { "type": "string" }, "example": [ "TW" ], "description": "从职位结果中排除的 ISO 3166-1 alpha-2 (cca2) 地区代码。有效代码请查看过滤器选项卡下的 `location` 端点。" }, "location_ids": { "$ref": "#/components/schemas/job_location_ids" }, "company_locations": { "$ref": "#/components/schemas/company_locations" }, "companies": { "$ref": "#/components/schemas/companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "search_term": { "$ref": "#/components/schemas/search_term" }, "search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "Software Developer" ], "description": "用于过滤职位发布的关键词字符串数组。每个词与职位内容进行匹配。使用 `search_term` 传入单个字符串，或使用 `search_terms` 传入多个关键词。" }, "titles": { "$ref": "#/components/schemas/people_titles" }, "functions": { "$ref": "#/components/schemas/job_functions" }, "seniority_ranks": { "$ref": "#/components/schemas/job_seniority_ranks" }, "posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "launch_dates": { "$ref": "#/components/schemas/job_launch_dates" }, "created_at": { "$ref": "#/components/schemas/search_created_at" }, "is_realtime_enrichment": { "$ref": "#/components/schemas/is_realtime_enrichment" }, "is_ascending_order": { "$ref": "#/components/schemas/is_ascending_order" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" } } } } } }, "operationId": "companies_search_jobs", "summary": "搜索职位发布", "description": "搜索职位发布。参见[职位搜索指南](/cn/developer-guides/search/job-search)。", "tags": [ "Search" ] } }, "/companies/news/search": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/search_metadata" }, "data": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/search_pagination" }, "news": { "type": "array", "items": { "$ref": "#/components/schemas/news_search_result" } } } } } }, "example": { "metadata": { "profile": null, "filters": { "domains": [ "stripe.com" ], "per_page": 25, "language": "en" }, "ignored_fields": [] }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 351800, "total_pages": 14072, "is_timeout": false, "total_display_pages": 250 }, "news": [ { "news_id": "0b0f1c53-7a04-4a46-b5bc-3b17a7c4cfbd", "news_search_id": "4110b929-17cd-42aa-a159-906ead0c9b56", "country_codes": [ "CN", "SG" ], "company_country_codes": [ "CN", "FR" ], "domains": [ "insead.edu", "digitalchina.com" ], "companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MjY5OTY5NDJpbnNlYWQuZWR1bGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "dfbe6797-5311-46f9-9518-bf1a7c3d09bc", "country_code": "FR", "company_name": "Insead", "linkedin_name": "insead", "domain": "insead.edu" }, { "logo_url": "https://buckets.pubrio.com/company-logo/NDA2NTQ5NTFkaWdpdGFsY2hpbmEuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "e13a9e24-a07d-4630-9b47-fceb778df74e", "country_code": "CN", "company_name": "Digital China", "linkedin_name": "digital-china", "domain": "digitalchina.com" } ], "news_galleries": [ { "slug": "banking-financial-service", "news_gallery_id": "7c8ec9cc-66c5-4153-82da-9c8f356c6c99", "name": "Banking/Financial Service" } ], "locations": [ "Singapore", "China" ], "last_modified": "2025-06-01T08:15:23.945Z", "image_url": null, "url": "http://enold.prnasia.com/p/asia-story-125304015-0.shtml", "published_at": "2025-06-01T08:00:00.000Z", "language": "id", "source": "prnasia.com", "category": "launches", "title": "Digital China's AI-driven transformation showcased at INSEAD", "summary": "Guo Wei, Chairman of Digital China, presented on AI-era corporate management at INSEAD 2025 Asia AI Conference, launching a case study on Digital China's AI transformation journey.", "news_category_name": "Launches" }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "$ref": "#/components/schemas/locations" }, "company_locations": { "$ref": "#/components/schemas/company_locations" }, "companies": { "$ref": "#/components/schemas/companies" }, "news_search_id": { "allOf": [ { "$ref": "#/components/schemas/news_search_id" } ], "description": "仅返回这一条记录。适合在不翻页的情况下重新获取你此前存储的某一行。" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "search_term": { "$ref": "#/components/schemas/search_term" }, "search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "Trump" ], "description": "用于过滤新闻文章的关键词字符串数组。每个词与文章内容进行匹配。使用 `search_term` 传入单个字符串，或使用 `search_terms` 传入多个关键词。" }, "categories": { "$ref": "#/components/schemas/news_categories" }, "news_gallery_ids": { "$ref": "#/components/schemas/news_gallery_ids" }, "published_dates": { "$ref": "#/components/schemas/published_dates" }, "published_at": { "$ref": "#/components/schemas/news_published_at_from" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "is_ascending_order": { "$ref": "#/components/schemas/is_ascending_order" }, "news_galleries": { "type": "array", "items": { "type": "string" }, "example": [ "electronic-commerce" ], "description": "用于按画廊过滤新闻的 `画廊 slug` 列表。要查找 slug，请调用过滤器选项卡下的 `news galleries` 端点。" }, "news_languages": { "type": "array", "items": { "type": "string" }, "example": [ "en" ], "description": "用于按语言过滤新闻的 `locale_code` 值列表。要查找可用代码，请调用过滤器选项卡下的 `news languages` 端点。" }, "is_expansion_signal_available": { "$ref": "#/components/schemas/is_expansion_signal_available" }, "expansion_signal_types": { "$ref": "#/components/schemas/expansion_signal_types" }, "expansion_signal_polarities": { "$ref": "#/components/schemas/expansion_signal_polarities" } } } } } }, "operationId": "companies_search_news", "summary": "搜索公司新闻", "description": "搜索公司新闻。参见[新闻搜索指南](/cn/developer-guides/search/news-search)。", "tags": [ "Search" ] } }, "/redeem/people/batch/query": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" } ], "properties": { "peoples": { "type": "array", "description": "已兑换的联系人列表。当某人没有匹配结果时，`emails` 与 `phones` 为 `null`（而非 `[]`），遍历前请先判空。`total_credit_cost` 仅计入成功匹配的部分，未兑换到任何内容时为 `0`；费用随请求的联系方式类型数量而增加。", "items": { "type": "object" } } } } } }, "example": { "data": { "profile": { "credit": 450376, "topup_credit": 235237, "total_charged_credit": 465 }, "query": { "redeem_query_id": "a046c1da-b3d4-4ca1-aca6-1dd8c8055701", "is_completed": true, "estimated_time": 6, "estimated_time_type": "second" }, "peoples": [ { "people_search_id": "540574d1-ff74-475b-aea2-f8ae643b806d", "emails": [ { "value": "example@gmail.com", "type": "email-personal", "status": null }, { "value": "example@pubrio.com", "type": "email-work", "status": "Verified" } ], "phones": [ { "value": "+1123456789", "type": "phone", "status": null } ] }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "redeem_query_id": { "$ref": "#/components/schemas/redeem_query_id" } }, "required": [ "redeem_query_id" ] } } } }, "operationId": "redeem_people_batch_query", "summary": "查询批量兑换状态", "description": "检查先前提交的批量兑换请求的状态和结果。", "tags": [ "Redeem" ] } }, "/redeem/people/batch": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" } ], "properties": { "peoples": { "type": "array", "description": "已兑换的联系人列表。当某人没有匹配结果时，`emails` 与 `phones` 为 `null`（而非 `[]`），遍历前请先判空。`total_credit_cost` 仅计入成功匹配的部分，未兑换到任何内容时为 `0`；费用随请求的联系方式类型数量而增加。", "items": { "type": "object" } } } } } }, "example": { "data": { "redeem_query_id": "a046c1da-b3d4-4ca1-aca6-1dd8c8055701", "is_completed": false, "estimated_time": 6, "estimated_time_type": "second" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "peoples": { "$ref": "#/components/schemas/peoples" }, "people_contact_types": { "$ref": "#/components/schemas/people_contact_types" } }, "required": [ "peoples", "people_contact_types" ] } } } }, "operationId": "redeem_people_batch", "summary": "批量兑换人员联系方式", "description": "提交批量请求，一次性解锁多个人员的联系方式。", "tags": [ "Redeem" ] } }, "/redeem/people": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" } ], "properties": { "peoples": { "type": "array", "description": "已兑换的联系人列表。当某人没有匹配结果时，`emails` 与 `phones` 为 `null`（而非 `[]`），遍历前请先判空。`total_credit_cost` 仅计入成功匹配的部分，未兑换到任何内容时为 `0`；费用随请求的联系方式类型数量而增加。", "items": { "type": "object" } } } } } }, "example": { "data": { "profile": { "credit": 450376, "topup_credit": 235237, "total_credit_cost": 45 }, "peoples": [ { "people_search_id": "e37ccf38-ea8f-422e-9874-cb23b15e8fe4", "emails": [ { "value": "example@gmail.com", "type": "email-personal", "status": null }, { "value": "example@pubrio.com", "type": "email-work", "status": "Verified" } ], "phones": [ { "value": "+1123456789", "type": "phone", "status": null } ] } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "people_search_id": { "$ref": "#/components/schemas/people_search_id" }, "linkedin_url": { "$ref": "#/components/schemas/people_linkedin_url" }, "people_contact_types": { "$ref": "#/components/schemas/people_contact_types" } }, "anyOf": [ { "title": "People Search ID", "required": [ "people_search_id", "people_contact_types" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url", "people_contact_types" ] } ] } } } }, "operationId": "redeem_people", "summary": "兑换人员联系方式", "description": "消耗积分解锁指定人员的完整联系方式（电子邮件、电话）。", "tags": [ "Redeem" ] } }, "/redeem/people/contact/lookup": { "post": { "responses": { "200": { "description": "成功响应，包含匹配到的人员及匹配元数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" } ], "properties": { "peoples": { "type": "array", "description": "已兑换的联系人列表。当某人没有匹配结果时，`emails` 与 `phones` 为 `null`（而非 `[]`），遍历前请先判空。`total_credit_cost` 仅计入成功匹配的部分，未兑换到任何内容时为 `0`；费用随请求的联系方式类型数量而增加。", "items": { "type": "object" } } } } } }, "example": { "data": { "profile": { "credit": 450375, "topup_credit": 235236, "total_credit_cost": 1 }, "peoples": [ { "people_search_id": "e37ccf38-ea8f-422e-9874-cb23b15e8fe4", "first_name": "King", "last_name": "Lai", "people_name": "King Lai", "company_name": "Pubrio", "domain": "pubrio.com", "match": { "confidence": "exact", "input": { "value": "king.lai@pubrio.com", "type": "email-work" }, "is_duplicate_input": false } } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "$ref": "#/components/schemas/contact_lookup_email" }, "phone": { "$ref": "#/components/schemas/contact_lookup_phone" }, "first_name": { "$ref": "#/components/schemas/contact_lookup_first_name" }, "last_name": { "$ref": "#/components/schemas/contact_lookup_last_name" }, "domain": { "$ref": "#/components/schemas/contact_lookup_domain" }, "company": { "$ref": "#/components/schemas/contact_lookup_company" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/contact_lookup_is_enable_similarity_search" } }, "anyOf": [ { "title": "邮箱", "required": [ "email" ] }, { "title": "电话", "required": [ "phone" ] }, { "title": "姓名 + 域名(相似度匹配)", "required": [ "first_name", "last_name", "domain", "is_enable_similarity_search" ] }, { "title": "姓名 + 公司名(相似度匹配)", "required": [ "first_name", "last_name", "company", "is_enable_similarity_search" ] } ] } } } }, "operationId": "redeem_people_contact_lookup", "summary": "通过联系标识查找人员", "description": "通过邮箱、电话，或（启用相似度搜索时）名字 + 姓氏 + 域名或公司，反向查找人员。返回匹配人员的 `people_search_id` 与基础信息，以及描述匹配方式的 `match` 元数据。每次可计费匹配消耗 1 个积分。", "tags": [ "Redeem" ] } }, "/redeem/people/contact/lookup/batch": { "post": { "responses": { "200": { "description": "成功响应，包含匹配到的人员及每条记录的匹配元数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" } ], "properties": { "peoples": { "type": "array", "description": "已兑换的联系人列表。当某人没有匹配结果时，`emails` 与 `phones` 为 `null`（而非 `[]`），遍历前请先判空。`total_credit_cost` 仅计入成功匹配的部分，未兑换到任何内容时为 `0`；费用随请求的联系方式类型数量而增加。", "items": { "type": "object" } } } } } }, "example": { "data": { "profile": { "credit": 450374, "topup_credit": 235236, "total_credit_cost": 2 }, "peoples": [ { "people_search_id": "e37ccf38-ea8f-422e-9874-cb23b15e8fe4", "people_name": "King Lai", "company_name": "Pubrio", "domain": "pubrio.com", "match": { "confidence": "exact", "input": { "value": "king.lai@pubrio.com", "type": "email-work" }, "is_duplicate_input": false } }, { "people_search_id": "1c4f0a9d-9a8e-4ab0-9b07-2cd09c4a3a6b", "people_name": "John Smith", "company_name": "Example", "domain": "example.com", "match": { "confidence": "similarity_domain", "input": { "value": "example.com", "type": "domain" }, "is_duplicate_input": false } } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "peoples": { "$ref": "#/components/schemas/contact_lookup_peoples" }, "is_enable_similarity_search": { "$ref": "#/components/schemas/contact_lookup_is_enable_similarity_search" } }, "required": [ "peoples" ] } } } }, "operationId": "redeem_people_contact_lookup_batch", "summary": "批量通过联系标识查找人员", "description": "`/redeem/people/contact/lookup` 的批量版本。单次请求最多可提交至您订阅计划的批量上限。`peoples` 中每个条目接受与单条查询请求体相同的标识符。每次可计费匹配消耗 1 个积分——重复输入与未匹配的条目不计费。", "tags": [ "Redeem" ] } }, "/locations": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "location_id": 472, "flag": "🇦🇩", "idd": { "root": "+3", "suffixes": [ "76" ] }, "dial_code": "+376", "iso_code": "AD", "location_name": "Andorra" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_locations", "summary": "列出可用地点", "description": "获取可用于搜索筛选的地点列表。", "tags": [ "Filters" ] } }, "/technologies": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "icon": "Cart-generic.svg", "name": "Cart Functionality", "tag_id": 6630, "website": "https://www.shopify.com/blog/shopping-cart", "logo_url": "https://buckets.pubrio.com/technology-logo/NjYzMGIyOXNtYjhheGNhcnQtZnVuY3Rpb25hbGl0eQ==.jpg", "categories": [ { "name": "Ecommerce", "category_id": 26 }, { "name": "Programming languages", "category_id": 707847256 } ] }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "$ref": "#/components/schemas/keyword" } } } } } }, "operationId": "filters_list_technologies", "summary": "列出可用技术", "description": "获取可用于搜索筛选的技术列表。", "tags": [ "Filters" ] } }, "/technologies/categories": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "category_id": 2159464, "slug": "remote-access", "name": "Remote access" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "$ref": "#/components/schemas/keyword" } } } } } }, "operationId": "filters_list_technology_categories", "summary": "列出技术分类", "description": "获取用于筛选的技术分类列表。", "tags": [ "Filters" ] } }, "/verticals": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "vertical_id": 69276002, "slug": "ai", "vertical_identifier": "99b5d4d2-ca62-4193-a4de-6b20be4bdf8d", "vertical_sub_category_id": 120, "vertical_category_id": 18, "name": "AI", "name_en": "AI" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "$ref": "#/components/schemas/keyword" } } } } } }, "operationId": "filters_list_verticals", "summary": "列出行业垂直领域", "description": "获取用于筛选的行业垂直领域列表。", "tags": [ "Filters" ] } }, "/verticals/categories": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "vertical_category_id": 6, "gics_sector_code": 25, "gics_industry_group_code": 2510, "vertical_category_identifier": "d968669f-9379-4027-98d9-f4df49da1d4d", "description": null, "slug": "automobiles-components", "name": "Automobiles & Components", "name_en": "Automobiles & Components" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "$ref": "#/components/schemas/keyword" } } } } } }, "operationId": "filters_list_vertical_categories", "summary": "列出垂直领域分类", "description": "获取用于筛选的垂直领域分类列表。", "tags": [ "Filters" ] } }, "/verticals/sub_categories": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "vertical_sub_category_id": 134, "gics_sector_code": 50, "gics_industry_group_code": 5020, "gics_sub_industry_group_code": 50201010, "vertical_sub_category_identifier": "dd2dc328-9ff6-4f7a-aee8-fdf1d09d856d", "description": null, "slug": "advertising", "name": "Advertising" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "$ref": "#/components/schemas/keyword" } } } } } }, "operationId": "filters_list_vertical_sub_categories", "summary": "列出垂直领域子分类", "description": "获取用于筛选的垂直领域子分类列表。", "tags": [ "Filters" ] } }, "/companies/news/categories": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "news_category_id": "d1920fb3-977d-4a4d-8f7a-72e21d81e5b9", "slug": "acquires", "name": "Mergers & Acquisitions", "name_en": "Mergers & Acquisitions" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_news_categories", "summary": "列出新闻分类", "description": "获取用于筛选的新闻文章分类列表。", "tags": [ "Filters" ] } }, "/companies/news/galleries": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "news_gallery_id": "97a01204-cf56-43ad-98d2-e4991152b148", "slug": "art-fashion", "name": "Art/Fashion", "name_en": "Art/Fashion" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_news_galleries", "summary": "列出新闻画廊", "description": "获取用于筛选的新闻画廊列表。", "tags": [ "Filters" ] } }, "/profile": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "profile_id": 1, "credit": 457499, "topup_credit": 235237, "name": "Pubrio", "description": null, "is_auto_top_up_credits_enabled": false, "auto_top_up_credit": 2500, "auto_top_up_balance_fall_below": 500, "subscription": { "id": 7, "credit": 2250, "max_api_monthly_query": 0, "max_api_daily_query": 0, "max_api_hourly_query": 0, "is_not_able_to_subscribe": false, "max_portal_monthly_query": 60000, "max_portal_daily_query": 2000, "max_portal_hourly_query": 1000, "amount": 59, "is_custom_plan": false, "currency_id": 14, "currency": "usd", "topup_credit_amount": 0.035, "name": "Business - Annual Subscription", "slug": "business-annual", "collection": "business", "is_annual": true, "is_default": null, "identifier": "2618b67a-cc4d-4fd1-bbe8-f906e4f6632d", "last_charged": "2024-11-09T03:40:41.995Z", "next_charge_date": "2025-11-09T03:40:41.995Z", "last_usage_charged": "2024-10-30T15:01:54.895Z", "next_usage_charge_date": "2024-11-13T15:01:54.895Z", "last_refill_date": "2024-11-09T03:40:41.995Z", "next_refill_date": "2024-12-09T03:40:41.995Z", "usage_charge_period": 2, "usage_charge_period_type": "week", "charge_period": 12, "charge_period_type": "month", "web_intent_signal_credit": 25, "max_search_page": 100, "max_search_per_page": 25, "phone_number_redeem_credit": 30, "email_redeem_credit": 15, "people_search_credit": 3, "company_search_credit": 1, "data_export_credit": 1, "max_session_per_page": 100, "max_export_limit": 25000, "max_select_limit": 5000, "max_record_upload_size": 100000, "max_company_search_select_limit": 1000, "max_people_search_select_limit": 25, "max_channel_email_account": 1, "max_channel_linkedin_account": 1, "max_channel_slack_account": 0, "is_full_export_available": true, "is_api_access_available": false, "is_add_user_available": true, "is_refill_without_charge": false, "is_skip_user_related_calculation": false, "is_credit_rollover_available": false, "is_quota_sharing_available": true, "last_modified": "2024-11-09T03:40:41.995Z", "total_credit_used": 7025, "total_charge_credit": 7000, "credit_refill": 459000, "total_amount": 8988, "products": [ { "currency_id": 14, "currency": "usd", "waived_quantity": 6, "is_full_waived": false, "id": 3, "name": "Additional User Licence", "slug": "additional-user-licence", "quantity": 16, "amount": 59, "prorated_amount": 11328, "metadata": { "next_charge_date": "2025-11-09T03:40:41.995Z", "is_annual": true, "charge_period": 12, "charge_period_type": "month", "total_used_subscription": 16, "total_user_subscriptions": 33 }, "total_amount": 7080 }, { "currency_id": 14, "currency": "usd", "waived_quantity": 0, "is_full_waived": false, "id": 5, "name": "Profile Subscription", "slug": "profile-subscription", "quantity": 1, "amount": 59, "prorated_amount": 708, "metadata": { "next_charge_date": "2025-11-09T03:40:41.995Z", "is_annual": true, "charge_period": 12, "charge_period_type": "month" }, "total_amount": 708 } ], "usage_products": [ { "currency_id": 14, "currency": "usd", "waived_quantity": 1, "is_full_waived": false, "id": 2, "name": "Website Intent Data", "slug": "website-intent-data", "quantity": 281, "amount": 0.88, "prorated_amount": 245.88, "metadata": { "web_intent_signal_credit": 25, "topup_credit_amount": 0.035 }, "total_amount": 245, "total_credit_used": 7025, "total_charge_credit": 7000 } ] } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "operationId": "profile_get", "summary": "获取工作区配置", "description": "获取当前工作区配置详情，包括计划信息和设置。", "tags": [ "Profile" ] } }, "/profile/usage": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "api_monthly_usage": 0, "api_daily_usage": 0, "api_hourly_usage": 0, "api_last_refreshed": "2024-11-13T10:01:13.051Z", "portal_monthly_usage": 848, "portal_daily_usage": 163, "portal_hourly_usage": 4, "portal_last_refreshed": "2024-11-13T10:01:13.051Z", "max_api_monthly_query": 0, "max_api_daily_query": 0, "max_api_hourly_query": 0, "max_portal_monthly_query": 60000, "max_portal_daily_query": 2000, "max_portal_hourly_query": 1000, "total_max_api_monthly_query": 0, "total_max_api_daily_query": 0, "total_max_api_hourly_query": 0, "total_max_portal_monthly_query": 2040000, "total_max_portal_daily_query": 68000, "total_max_portal_hourly_query": 34000, "is_api_access_available": false, "is_quota_sharing_enabled": true, "is_quota_sharing_available": true } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "operationId": "profile_get_usage", "summary": "获取工作区使用统计", "description": "获取当前工作区配置的积分使用和配额统计。", "tags": [ "Profile" ] } }, "/user": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "timezone_id": 172, "language": "en", "email": "king.lai@pubrio.com", "user_id": "2981d4b3-f8b1-44d8-9759-8f3faf89bfa2", "nickname": "King Lai", "raw_phone_number": "12345679", "phone_number": "12345679", "company": "Pubrio", "profiles": [ { "profile_id": 1, "name": "Pubrio" } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "user_get", "summary": "获取当前用户信息", "description": "获取当前已认证用户的详细信息。", "tags": [ "Profile" ] } }, "/timezones": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "timezone_id": 1, "timezone": "Africa/Abidjan", "utc_offset": "+00:00" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_timezones", "summary": "列出时区", "description": "获取支持的时区列表。", "tags": [ "Filters" ] } }, "/management_levels": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "management_level_id": 3, "slug": "c_suite", "name": "C suite" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_management_levels", "summary": "列出管理级别", "description": "获取用于筛选的管理和资历级别列表。", "tags": [ "Filters" ] } }, "/departments/title": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "department_id": 10, "slug": "consulting", "name": "Consulting" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_department_titles", "summary": "列出部门职称", "description": "获取用于筛选的部门职称列表。", "tags": [ "Filters" ] } }, "/departments/function": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "department_function_id": 53, "slug": "accounting", "name": "Accounting" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_department_functions", "summary": "列出部门职能", "description": "获取用于筛选的部门职能列表。", "tags": [ "Filters" ] } }, "/company_sizes": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "company_size_id": 1, "slug": "1-20", "name": "1 - 20" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_company_sizes", "summary": "列出公司规模选项", "description": "获取用于筛选的公司规模分类列表。", "tags": [ "Filters" ] } }, "/people/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文——`is_enrichment_available`、`parameters`、`filters`，以及（按需返回的）包含 `credit`、`topup_credit` 与 `total_credit_cost` 的 `profile` 区块。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "people_search_id": "134591fb-f0fa-41ba-9c8c-f1eb8aab8946", "name": "Doug McMillon", "first_name": "Doug", "last_name": "McMillon", "title": "President & CEO", "seniority": "c_suite", "functions": null, "headline": "President & CEO at Walmart Inc.", "departments": [ "c_suite" ], "subdepartments": [ "executive" ], "keywords": null, "employment_history": [ { "title": "President & CEO", "current": true, "end_date": null, "start_date": "2014-02-01", "company_name": "Walmart" }, { "title": "President & CEO, Walmart International", "current": false, "end_date": "2014-01-01", "start_date": "2009-02-01", "company_name": "Walmart" }, { "title": "President & CEO", "current": false, "end_date": "2009-01-01", "start_date": "2005-08-01", "company_name": "Sam's Club" } ], "location": "United States", "state": "Arkansas", "city": "Bentonville", "contacts": null, "emails": null, "phones": null, "facebook_url": null, "github_url": null, "twitter_url": null, "linkedin_url": "http://www.linkedin.com/in/dougmcmillon", "saved_lists": null, "company": { "company_name": "Walmart", "company_url": "http://walmart.com", "domain_id": 26067151, "domain_ids": [ 757023267, 368242703, 26067151 ], "domain_search_id": "2a0d6cd7-cc10-44d6-94ec-41fd528a11b6", "founded_year": 1962, "location": "United States", "phones": null, "company_size_printed": "466,000", "company_size": 466000, "industry": "Retail", "logo_url": "https://buckets.pubrio.com/company-logo/NzU3MDIzMjY3aWxqOXNzbmoxd2FsbWFydC5jb21saW5rZWRpbl8zMzMxOTgxMg==.jpg", "linkedin_url": "http://www.linkedin.com/company/walmart", "facebook_url": "http://facebook.com/walmart", "twitter_url": "https://twitter.com/walmart", "crunchbase_url": null, "instagram_url": "http://instagram.com/walmart", "youtube_url": "http://youtube.com/user/walmart" } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "people_search_id": { "$ref": "#/components/schemas/people_search_id" }, "linkedin_url": { "$ref": "#/components/schemas/people_linkedin_url" }, "wantedly_url": { "type": "string", "description": "该联系人的 Wantedly 个人主页 URL。" }, "tw104_url": { "type": "string", "description": "该联系人的 104（台湾）个人主页 URL。" }, "rocketpunch_url": { "type": "string", "description": "该联系人的 RocketPunch 个人主页 URL。" }, "remember_url": { "type": "string", "description": "该联系人的 Remember 个人主页 URL。" }, "youtrust_url": { "type": "string", "description": "该联系人的 YOUTRUST 个人主页 URL。" }, "is_enrichment_available": { "type": "boolean", "description": "当已存储记录不完整时执行实时增强——补全联系方式、任职经历与社交资料。会消耗积分。不设置则仅读取缓存。", "example": true }, "is_profile_metadata_available": { "type": "boolean", "description": "在 `metadata.profile` 中返回本次调用的工作区积分核算信息。", "example": true }, "exclude_fields": { "type": "array", "description": "需要从返回记录中省略的字段标识。", "items": { "type": "string" } } }, "anyOf": [ { "title": "People Search ID", "required": [ "people_search_id" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] }, { "title": "Wantedly URL", "required": [ "wantedly_url" ] }, { "title": "104 URL", "required": [ "tw104_url" ] }, { "title": "RocketPunch URL", "required": [ "rocketpunch_url" ] }, { "title": "Remember URL", "required": [ "remember_url" ] }, { "title": "YOUTRUST URL", "required": [ "youtrust_url" ] } ] } } } }, "operationId": "people_lookup", "summary": "按 ID 查找人员", "description": "使用 Pubrio 搜索 ID 或 LinkedIn URL 获取特定人员的详细信息。", "tags": [ "Lookup" ] } }, "/people/linkedin/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "linkedin_name": "jeffweiner08", "linkedin_url": "https://www.linkedin.com/in/jeffweiner08", "name": "Jeff Weiner", "created_at": "2025-06-08T16:58:16.145Z", "image_url": "https://media.licdn.com/dms/image/v2/C4D16AQFJHyicpAYHXQ/profile-displaybackgroundimage-shrink_200_800/profile-displaybackgroundimage-shrink_200_800/0/1515797967677?e=2147483647&v=beta&t=bAdvQ-o7JZ1b7OKSKau1vB3DMZIHPtefC40_43yzasI", "logo_url": "https://media.licdn.com/dms/image/v2/C4D03AQFM3Y2r-OEStw/profile-displayphoto-shrink_200_200/profile-displayphoto-shrink_200_200/0/1515623804978?e=2147483647&v=beta&t=8gxxYGav4qEN7hXdbULm_h_JbZKg9lreAZ7HPXDUbF0", "headline": "Executive Chairman at LinkedIn / Founding Partner Next Play Ventures", "description": "Jeff Weiner is the executive chairman of LinkedIn, where he continues to help LinkedIn realize its vision of creating economic opportunity for every member of the global workforce through mentorship, coaching and advising current leadership. \n\nPrior to becoming executive chairman in June 2020, Jeff was the CEO of LinkedIn. During his 11-year tenure, LinkedIn grew its membership base from 33M to more than 690M, increased its revenue from $78M to over $7.9B and expanded the team from 338 employees to over 16,000.\n\nIn addition to his ongoing work at LinkedIn, Jeff is the founding partner of Next Play Ventures, where he’s focused on investing in and coaching early stage start-ups and growth stage companies. \n\nHe is also a founding LP and serves on the Investment Committee of Concrete Rose Capital, an early stage venture fund focused on investing in diverse founders, start-ups serving underserved communities and/or building diverse teams. \n\nJeff is also the co-founder of The Compassion Project, whose mission is to ensure compassion is taught in every elementary school in the U.S.\n\nHe presently resides on the board of directors of Donorschoose.org. \n\nPrior to LinkedIn, Jeff was an Executive in Residence at Accel Partners and Greylock Partners, primarily focused on advising the leadership teams of the firm's existing consumer technology portfolio companies while also working closely with the firm’s partners to evaluate new investment opportunities.\n\nPreviously, he served in key leadership roles at Yahoo! for over seven years, including Executive Vice President of Yahoo!'s Network Division managing Yahoo's consumer web product portfolio, including Yahoo's Front Page, Mail, Search, and Media products.", "country_code": "US", "location": null, "city": "United States", "linkedin_uid": "22330283", "company": { "linkedin_url": "https://www.linkedin.com/company/linkedin", "company_name": "LinkedIn", "linkedin_name": "linkedin", "location": null }, "employment_history": [ { "title": "LinkedIn", "company_name": "LinkedIn", "linkedin_name": "linkedin", "linkedin_url": "https://www.linkedin.com/company/linkedin?trk=public_profile_experience-group-header", "logo_url": null, "positions": [ { "subtitle": "LinkedIn", "meta": "Jul 2020 - Present 5 years", "start_date": "Jul 2020", "end_date": "Present", "title": "Executive Chairman", "description_html": null, "location": null }, { "subtitle": "LinkedIn", "meta": "Dec 2008 - Jun 2020 11 years 7 months", "start_date": "Dec 2008", "end_date": "Jun 2020", "title": "CEO", "description_html": null, "location": null } ], "duration": "16 years 7 months", "unformatted_description": null }, "..." ], "follower_size": 10410599, "connection_size": 500, "recommendations": [ "Akosua Boadi-Agyemang “Personally, Jeff, has impacted my journey so much during his tenure as CEO of LinkedIn. In so doing, he has shown me the true personification of servant leadership. Jeff has showed up for me in ways that have changed the trajectory of my career and life, and he did so without knowing me, initially. While I was searching for an internship in 2017, Jeff showed up (commented on my LinkedIn post) and said “Akosua, would be surprised if something doesn’t materialize.” This played a massive part in where I am in my career at Microsoft today. He showed up to support my first LinkedIn Live stream as a beta tester for the feature. I told him the day and time. I was nervous, had never beta tested anything before. I asked the audience “can anyone see and hear me?” and he showed up, saying, “can hear and see you perfectly”. His support is incredible. When I wrote my first article documenting #theBOLDjourney, Jeff showed up - “This is just the beginning.” Again with the encouragement. To say the least, Jeff has used his power and platform as CEO of LinkedIn to not only empower me but, to uplift millions, globally. In addition, through the #plusonepledge he initiated during his tenure, he ensured that others show up for one another, as well. Jeff, thank you for always showing up. And for embodying the true meaning of the Ngoni Bantu word, “Ubuntu” (I am, because we are).”", "Derek E. Baird, M.Ed. “While I was at Yahoo!, I had the honor of working for Jeff on the Yahoo! Teachers social networking product. Jeff was our executive sponsor on this project and he was our strongest and most passionate advocate. His knowledge of the consumer Internet and youth media space was invaluable and his strategic eye was instrumental in moving our product from a hack day idea into a full beta. On this project Jeff also demonstrated his deep and unwavering commitment to social responsibility. Jeff is a doer. Throughout his tenure on this project he was always more than willing to channel the many resources at Yahoo!, as well as his many connections, to help improve public education in this country. Jeff is a truly exceptional, visionary and inspiring leader. It was a true pleasure to have had the opportunity to work for Jeff Weiner. It was, and continues to be, a highlight of my career.”" ], "honors_and_awards": null, "education": null, "bio": [ { "title": "Company Website", "url": "http://www.linkedin.com/" }, "..." ], "people_also_viewed": [ { "linkedin_url": "https://www.linkedin.com/in/coppedge?trk=public_profile_browsemap-profile", "name": "Rob Coppedge", "headline": null, "location": "Portland, Oregon Metropolitan Area" }, "..." ], "similar_profiles": [ { "linkedin_url": "https://www.linkedin.com/in/coppedge", "name": "Rob Coppedge", "headline": null }, "..." ], "recent_activities": [ { "id": "7328934302337945608", "linkedin_url": "https://www.linkedin.com/posts/akothari_next-play-a-mindset-i-picked-up-from-activity-7328934302337945608-hfLO", "title": "“Next play!” —A mindset I picked up from Jeff, and I believe he got it from Coach K. Doesn’t matter if you just crushed it or slipped up — keep…", "interaction": "Liked by Jeff Weiner", "image_url": "https://media.licdn.com/dms/image/v2/D5605AQFsD_LNcQzcKA/videocover-high/B56ZbWa0QpH0B4-/0/1747354093631?e=2147483647&v=beta&t=cqAOZlz3UZdpiX7O-HSMwAROHRS_R8KzIbsp7nAUyfE" }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_url": { "$ref": "#/components/schemas/people_linkedin_url" } }, "required": [ "linkedin_url" ] } } } }, "operationId": "people_lookup_linkedin", "summary": "通过 LinkedIn URL 查找人员", "description": "使用 LinkedIn 个人资料 URL 获取人员详细信息。提供实时数据检索。", "tags": [ "LinkedIn" ] } }, "/companies/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文：`is_enrichment_available`（是否执行了实时增强）、回显的 `parameters` 与 `filters`，以及带有 `credit`、`topup_credit` 和 `total_credit_cost` 的 `profile` 区块。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "logo_url": "https://buckets.pubrio.com/company-logo/NzMwNTQzMzkzaWxqOXNzbmoxbmV0ZmxpeC5jb21saW5rZWRpbl8zMzMxMjk0OQ==.jpg", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "estimated_revenue": 38900000000, "publicly_traded_symbol": "NFLX", "publicly_traded_exchange": "nasdaq", "specialties": [ "Entertainment", "Entertainment Providers", "Telecommunications", "Media Production" ], "company_keywords": [ "consumer electronics", "games", "entertainment", "consumer internet", "hardware", "information technology", "internet", "revolutionizing the way people watch tv shows & movies" ], "company_ranking": 232, "title": "Netflix - Watch TV Shows Online, Watch Movies Online", "description": "Netflix is one of the world's leading entertainment services with over 247 million paid memberships in over 190 countries enjoying TV series, films and games across a wide variety of genres and languages. Members can play, pause and resume watching as much as they want, anytime, anywhere, and can change their plans at any time.", "company_address": "100 Winchester Circle, Los Gatos, Ca, Us", "company_name": "Netflix", "founded_year": 1997, "industry": "Entertainment", "domain": "netflix.com", "domain_search_id": "575463e2-474d-4f0a-acc3-fdc2be51e07e", "domain_id": 70635725, "linkedin_company_id": 33312949, "domain_ids": [ 585935484, 730543393, 368242675, 70635725 ], "company_size": 16000, "company_size_printed": "16,000", "youtube_url": null, "crunchbase_url": null, "linkedin_url": "http://www.linkedin.com/company/netflix", "instagram_url": "http://instagram.com/netflix", "facebook_url": "http://facebook.com/netflixus", "twitter_url": "https://twitter.com/netflix", "github_url": null, "x_url": null, "country_code": "US", "location": "United States", "company_url": "http://netflix.com", "company_addresses": [ "100 Winchester Circle Los Gatos, CA, US", "5808 W Sunset Blvd Los Angeles, CA 90028, US", "Alameda Xingu, 350 Barueri, SP 06455-030, BR", "245 W 17th St New York, 10011, US", "Stadhouderskade 55 Amsterdam, North Holland 1072 AB, NL", "9 Straits Vw Marina South, 01, SG", "Av. Paseo De La Reforma 483 Torre Reforma, Floor 37 Mexico City, Cuauhtémoc 06500, MX" ], "saved_lists": null } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" }, "tiktok_url": { "type": "string", "description": "公司的 TikTok 主页 URL。" }, "wantedly_url": { "type": "string", "description": "公司的 Wantedly 主页 URL。" }, "tw104_url": { "type": "string", "description": "公司的 104（台湾）主页 URL。" }, "rocketpunch_url": { "type": "string", "description": "公司的 RocketPunch 主页 URL。" }, "remember_url": { "type": "string", "description": "公司的 Remember 主页 URL。" }, "youtrust_url": { "type": "string", "description": "公司的 YOUTRUST 主页 URL。" }, "is_enrichment_available": { "type": "boolean", "description": "当已存储记录不完整时执行实时增强。会消耗积分。响应会在 `metadata.is_enrichment_available` 中回显是否实际执行。", "example": true } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ] } } } }, "operationId": "companies_lookup", "summary": "按 ID 查找公司", "description": "使用 Pubrio 搜索 ID、域名或 LinkedIn URL 获取特定公司的详细信息。", "tags": [ "Lookup" ] } }, "/companies/linkedin/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "linkedin_name": "stripe", "linkedin_url": "https://www.linkedin.com/company/stripe", "created_at": "2025-06-01T10:13:03.994Z", "image_url": "https://media.licdn.com/dms/image/v2/C561BAQEd_16iHeIr1Q/company-background_10000/company-background_10000/0/1594068230381/stripe_cover?e=2147483647&v=beta&t=o62bVF0Z15cf0OFikrsuge1xW-iQR4Td6cSOXrMip6I", "logo_url": "https://media.licdn.com/dms/image/v2/D4E0BAQFqiwiSMcKk6A/company-logo_200_200/company-logo_200_200/0/1724937022726/stripe_logo?e=2147483647&v=beta&t=--CED0oRQUupcr1Q2MktzOErO8NMpjCjxa4-JiqrGzU", "company_type": "Privately Held", "company_name": "Stripe", "title": "Help increase the GDP of the internet.", "description": "Stripe builds programmable financial services. Millions of companies—from the world’s largest enterprises to the most ambitious startups—use Stripe to accept payments, grow their revenue, and accelerate new business opportunities. Headquartered in San Francisco and Dublin, the company aims to increase the GDP of the internet.", "unformatted_description": "\n Stripe builds programmable financial services. Millions of companies—from the world’s largest enterprises to the most ambitious startups—use Stripe to accept payments, grow their revenue, and accelerate new business opportunities. Headquartered in San Francisco and Dublin, the company aims to increase the GDP of the internet.\n ", "linkedin_uid": "2135371", "founded_year": 2010, "follower_size": 1045523, "company_addresses": [ "515 N State St, Chicago, Illinois 60610, US", "..." ], "unformatted_company_addresses": [ "515 N State St Chicago, Illinois 60610, US", "..." ], "headquarters": "South San Francisco, California", "company_address": "South San Francisco, California", "country_codes": [ "US", "..." ], "company_address_directions": [ { "directions_url": "https://www.bing.com/maps?where=354+Oyster+Point+Blvd+South+San+Francisco+94080+California+US&trk=org-locations_url" }, "..." ], "country_code": "US", "company_size": 11833, "unformatted_company_size": "5,001-10,000 employees", "company_size_printed": "11,900+", "industry": "Technology, Information And Internet", "additional_information": "Additional jobs info: Stripe (2,886 open jobs). Analyst (694,057 open jobs). Engineer (555,845 open jobs). Manager (1,880,925 open jobs). Account Executive (71,457 open jobs). Associate (1,091,945 open jobs). Director (1,220,357 open jobs). Marketing Manager (106,879 open jobs). Scientist (48,969 open jobs). Project Manager (253,048 open jobs). Account Manager (121,519 open jobs). Developer (258,935 open jobs). Software Engineer (300,699 open jobs). Product Manager (199,941 open jobs). Intern (71,196 open jobs). Specialist (768,666 open jobs). Vice President (235,270 open jobs). Executive (690,514 open jobs). Senior Software Engineer (78,145 open jobs). Solutions Architect (100,488 open jobs)", "alumni": null, "alumni_information": null, "company_url": "https://stripe.com/", "domain": "stripe.com", "unique_domain": "stripe.com", "similar_companies": [ { "linkedin_url": "https://www.linkedin.com/company/joinsquare?trk=similar-pages", "company_name": "Square", "industry": "Software Development", "location": "San Francisco, CA" }, "..." ], "affiliated_pages": [ { "linkedin_url": "https://www.linkedin.com/showcase/stripe-partner-ecosystem/?trk=affiliated-pages", "title": "Stripe Partner Ecosystem", "subtitle": "Internet Publishing", "location": "South San Francisco, California" } ], "people": [ { "linkedin_url": "https://www.linkedin.com/in/krishnanrajagopalan?trk=org-employees", "name": "Krishnan Rajagopalan", "logo_url": "https://media.licdn.com/dms/image/v2/C5603AQFZAI0yL2gFMg/profile-displayphoto-shrink_100_100/profile-displayphoto-shrink_100_100/0/1604036687597?e=2147483647&v=beta&t=4XvEQpAzyC6VkTwjEJoipu-RzjVZlghMKRJ9T-bq7gg" }, "..." ], "recent_activities": [ { "likes_count": 229, "text": "For businesses, sending payouts can be slow, costly, and error-prone. One of the hardest parts about sending money is accurately collecting recipient information like bank account details. Global Payouts allows you to send money to third parties with only their email address. Recipients can instantly authenticate their bank details, decreasing failed payouts by 88%: https://lnkd.in/gCfPBKPH .", "time": "5d", "title": "Stacey Wong", "comments_count": 14, "images": [ "https://media.licdn.com/dms/image/sync/v2/D4D27AQG-wcPKYC6OSw/articleshare-shrink_800/B4DZcxj37wGcAM-/0/1748883180077?e=2147483647&v=beta&t=qf6nEEODJRERCfkaegnnDuc0zqIg7NOZX5SXzGsr9Pw" ], "post_url": "https://www.linkedin.com/posts/stripe_activity-7335388680838152194-vzX3", "post_id": "7335388680838152194", "date": "2025-06-03T10:13:03.854Z", "tagged_companies": null, "tagged_people": null, "repost": { "repost_url": null, "repost_id": null, "repost_text": null, "repost_date": null, "tagged_companies": null, "tagged_users": null, "images": null, "videos": null, "external_links": null, "repost_hangtags": null, "repost_followers": null, "repost_title": null } }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" } }, "required": [ "linkedin_url" ] } } } }, "operationId": "companies_lookup_linkedin", "summary": "通过 LinkedIn URL 查找公司", "description": "使用 LinkedIn 公司页面 URL 获取公司详细信息。提供实时数据检索。", "tags": [ "LinkedIn" ] } }, "/companies/similar/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文：`is_enrichment_available`（是否执行了实时增强）、回显的 `parameters` 与 `filters`，以及带有 `credit`、`topup_credit` 和 `total_credit_cost` 的 `profile` 区块。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "logo_url": "https://buckets.pubrio.com/company-logo/NzMwNTQzMzkzaWxqOXNzbmoxbmV0ZmxpeC5jb21saW5rZWRpbl8zMzMxMjk0OQ==.jpg", "emails": [ "..." ], "phones": [ "..." ], "contacts": [ "..." ], "estimated_revenue": 38900000000, "publicly_traded_symbol": "NFLX", "publicly_traded_exchange": "nasdaq", "specialties": [ "Entertainment", "Entertainment Providers", "Telecommunications", "Media Production" ], "company_keywords": [ "consumer electronics", "games", "entertainment", "consumer internet", "hardware", "information technology", "internet", "revolutionizing the way people watch tv shows & movies" ], "company_ranking": 232, "title": "Netflix - Watch TV Shows Online, Watch Movies Online", "description": "Netflix is one of the world's leading entertainment services with over 247 million paid memberships in over 190 countries enjoying TV series, films and games across a wide variety of genres and languages. Members can play, pause and resume watching as much as they want, anytime, anywhere, and can change their plans at any time.", "company_address": "100 Winchester Circle, Los Gatos, Ca, Us", "company_name": "Netflix", "founded_year": 1997, "industry": "Entertainment", "domain": "netflix.com", "domain_search_id": "575463e2-474d-4f0a-acc3-fdc2be51e07e", "domain_id": 70635725, "linkedin_company_id": 33312949, "domain_ids": [ 585935484, 730543393, 368242675, 70635725 ], "company_size": 16000, "company_size_printed": "16,000", "youtube_url": null, "crunchbase_url": null, "linkedin_url": "http://www.linkedin.com/company/netflix", "instagram_url": "http://instagram.com/netflix", "facebook_url": "http://facebook.com/netflixus", "twitter_url": "https://twitter.com/netflix", "github_url": null, "x_url": null, "country_code": "US", "location": "United States", "company_url": "http://netflix.com", "company_addresses": [ "100 Winchester Circle Los Gatos, CA, US", "5808 W Sunset Blvd Los Angeles, CA 90028, US", "Alameda Xingu, 350 Barueri, SP 06455-030, BR", "245 W 17th St New York, 10011, US", "Stadhouderskade 55 Amsterdam, North Holland 1072 AB, NL", "9 Straits Vw Marina South, 01, SG", "Av. Paseo De La Reforma 483 Torre Reforma, Floor 37 Mexico City, Cuauhtémoc 06500, MX" ], "saved_lists": null } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" }, "tiktok_url": { "type": "string", "description": "公司的 TikTok 主页 URL。" }, "wantedly_url": { "type": "string", "description": "公司的 Wantedly 主页 URL。" }, "tw104_url": { "type": "string", "description": "公司的 104（台湾）主页 URL。" }, "rocketpunch_url": { "type": "string", "description": "公司的 RocketPunch 主页 URL。" }, "remember_url": { "type": "string", "description": "公司的 Remember 主页 URL。" }, "youtrust_url": { "type": "string", "description": "公司的 YOUTRUST 主页 URL。" }, "is_enrichment_available": { "type": "boolean", "description": "当已存储记录不完整时执行实时增强。会消耗积分。响应会在 `metadata.is_enrichment_available` 中回显是否实际执行。", "example": true } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ] } } } }, "operationId": "companies_lookup_similar", "summary": "查找相似公司", "description": "使用 Pubrio 搜索 ID、域名或 LinkedIn URL 获取与指定公司相似的公司。", "tags": [ "Lookup" ] } }, "/companies/jobs/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "job_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "job_search_id": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "last_modified": "2025-05-31T20:41:27.894Z", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/OTQxMjYxMTFnb29nbGUuY29tLnBrbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "539e2c34-de6b-4613-8f5b-e3aa18b4ef47", "company_name": "Google", "linkedin_name": "google", "country_code": "US", "domain": "google.com" }, "location": "Seoul, Seoul, South Korea", "job_url": "https://kr.linkedin.com/jobs/view/software-engineer-greach-program-for-people-with-disabilities-%EC%9E%A5%EC%95%A0%EC%9D%B8-%EC%B1%84%EC%9A%A9-at-google-4224659596?position=7&pageNum=0&refId=DwDpGXGftUql%2FkETvFCwXw%3D%3D&trackingId=gAvrIP0yUQuf8fjK67HSbQ%3D%3D", "posting_date": "2025-05-31", "country_code": "KR", "location_id": 491, "title": "Software Engineer, gReach Program for People with Disabilities (장애인 채용)", "country": "South Korea" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "job_search_id": { "$ref": "#/components/schemas/job_search_id" } }, "required": [ "job_search_id" ] } } } }, "operationId": "companies_lookup_jobs", "summary": "查找公司职位发布", "description": "使用职位搜索 ID 获取特定公司的职位发布详情。", "tags": [ "Lookup" ] } }, "/companies/news/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "news_id": "0b0f1c53-7a04-4a46-b5bc-3b17a7c4cfbd", "news_search_id": "4110b929-17cd-42aa-a159-906ead0c9b56", "keywords": [ "AI", "Digital China", "INSEAD", "manajemen perusahaan", "transformasi digital", "studi kasus", "Guo Wei", "proses bisnis", "komputasi awan", "integrasi data" ], "summary_original": "Guo Wei, Chairman Digital China, memaparkan tentang manajemen perusahaan era AI di INSEAD 2025 Asia AI Conference, serta meluncurkan studi kasus tentang perjalanan transformasi AI Digital China.", "title_original": "Digital China membahas manajemen perusahaan era AI di INSEAD", "news_gallery_ids": [ "7c8ec9cc-66c5-4153-82da-9c8f356c6c99" ], "country_codes": [ "CN", "SG" ], "company_country_codes": [ "CN", "FR" ], "amount_normalized": null, "amount": null, "job_title_tags": [ "executive", "leadership" ], "job_title": "Chairman", "headcount": null, "financing_type_tags": null, "financing_type_normalized": null, "financing_type": null, "domains": [ "insead.edu", "digitalchina.com" ], "companies": [ { "logo_url": "https://buckets.pubrio.com/company-logo/MjY5OTY5NDJpbnNlYWQuZWR1bGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "dfbe6797-5311-46f9-9518-bf1a7c3d09bc", "country_code": "FR", "company_name": "Insead", "linkedin_name": "insead", "domain": "insead.edu" }, { "logo_url": "https://buckets.pubrio.com/company-logo/NDA2NTQ5NTFkaWdpdGFsY2hpbmEuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "e13a9e24-a07d-4630-9b47-fceb778df74e", "country_code": "CN", "company_name": "Digital China", "linkedin_name": "digital-china", "domain": "digitalchina.com" } ], "news_galleries": [ { "slug": "banking-financial-service", "news_gallery_id": "7c8ec9cc-66c5-4153-82da-9c8f356c6c99", "name": "Banking/Financial Service" } ], "locations": [ "Singapore", "China" ], "last_modified": "2025-06-01T10:12:25.284Z", "image_url": null, "url": "http://enold.prnasia.com/p/asia-story-125304015-0.shtml", "published_at": "2025-06-01T08:00:00.000Z", "language": "id", "source": "prnasia.com", "category": "launches", "title": "Digital China's AI-driven transformation showcased at INSEAD", "summary": "Guo Wei, Chairman of Digital China, presented on AI-era corporate management at INSEAD 2025 Asia AI Conference, launching a case study on Digital China's AI transformation journey.", "news_category_name": "Launches" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "news_search_id": { "$ref": "#/components/schemas/news_search_id" } }, "required": [ "news_search_id" ] } } } }, "operationId": "companies_lookup_news", "summary": "查找公司新闻", "description": "使用新闻搜索 ID 获取特定公司的新闻文章详情。", "tags": [ "Lookup" ] } }, "/companies/advertisements/search": { "post": { "responses": { "200": { "description": "包含公司广告搜索详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/advertisement_search_metadata" }, "data": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/search_pagination" }, "advertisements": { "type": "array", "items": { "$ref": "#/components/schemas/advertisement_search_result" } } } } } }, "example": { "metadata": { "profile": null, "filters": { "source_types": [ "linkedin" ], "per_page": 25, "language": "en" }, "ignored_fields": [], "applied_source_types": [ "linkedin" ] }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 694356, "total_pages": 27775, "total_display_pages": 250, "is_timeout": false }, "advertisements": [ { "target_country_codes": [ "US", "GB", "SG" ], "advertisement_id": "3af8cb80-9a04-49a8-832d-333961d5f77a", "advertisement_search_id": "3af8cb80-9a04-49a8-832d-333961d5f77a", "created_at": "2026-03-03T01:46:35.909Z", "last_modified": "2026-03-03T12:46:25.289Z", "started_at": "2026-02-25T00:00:00.000Z", "ended_at": "2026-03-02T00:00:00.000Z", "title": "Thuraya-4 Satellite Solutions for Energy", "source_type": "linkedin", "advertisement_format": "Single Image Ad", "video_url": null, "image_url": "https://buckets.pubrio.com/images/public/cL1U5ghYPAy65qc4cu5wtmgzv8P9xJgrofNTwohPWsyT3S5ob2zNp6Jov1nM9aaDRy.jpg", "carousel_images": null, "destination_url": "https://www.thuraya.com/en/thuraya-4-ngs/home/index.html?trk=ad_library_ad_preview_headline_content", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/MjA3NTQ4NjQyM2lsajlzc25qMXNwYWNlNDIuYWlsaW5rZWRpbl82NDIyMjM3NA==.jpg", "domain_search_id": "fe3963dc-87a4-4016-8c95-217ea68cd57a", "company_name": "Space42", "linkedin_name": "space42ai", "country_code": "AE", "domain": "space42.ai" }, "raw_link_url": null, "publisher_platforms": null, "advertisement_format_normalized": "image", "is_company_matched": true, "advertiser": "Thuraya", "advertiser_url": "https://www.linkedin.com/company/thuraya", "advertisement_url": "https://www.linkedin.com/ad-library/detail/1518455034", "total_impressions": "< 1k", "total_impressions_lower": null, "total_impressions_upper": 1000 }, { "target_country_codes": [ "US", "GB", "SG" ], "advertisement_id": "47eb6229-e7aa-427f-bcd3-76e154fd5022", "advertisement_search_id": "47eb6229-e7aa-427f-bcd3-76e154fd5022", "created_at": "2026-06-03T22:00:33.035Z", "last_modified": "2026-06-05T18:15:51.823Z", "started_at": "2026-05-25T07:00:00.000Z", "ended_at": "2026-06-03T07:00:00.000Z", "title": "Dubai Opportunities. One Exclusive Event", "source_type": "facebook", "advertisement_format": "DCO", "video_url": null, "image_url": "https://buckets.pubrio.com/images/public/4snZgJwKCWEYwAUwxrkkK1ooEFEAMF92Xet6Bm16oAyqwUSoqekDjX8S9DmfixutuH.jpg", "carousel_images": null, "destination_url": "https://promotions.damacproperties.com/en/event-in-egypt-social-specific/", "raw_link_url": "http://fb.me/", "publisher_platforms": [ "facebook", "instagram" ], "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/MjYwODA0MjRkYW1hY3Byb3BlcnRpZXMuY29tbGlua2VkaW5fcF9sb2dvMTU=.jpg", "domain_search_id": "9da7386c-5bdc-42b2-8fee-456e91024a3a", "company_name": "Damac Properties", "linkedin_name": "damac-properties", "country_code": "AE", "domain": "damacproperties.com" }, "advertisement_format_normalized": "image", "is_company_matched": true, "advertiser": "Thuraya", "advertiser_url": "https://www.linkedin.com/company/thuraya", "advertisement_url": "https://www.linkedin.com/ad-library/detail/1518455034", "total_impressions": "< 1k", "total_impressions_lower": null, "total_impressions_upper": 1000 }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target_locations": { "$ref": "#/components/schemas/target_locations" }, "exclude_target_locations": { "$ref": "#/components/schemas/exclude_target_locations" }, "search_terms": { "$ref": "#/components/schemas/search_terms" }, "headlines": { "$ref": "#/components/schemas/headlines" }, "filter_conditions": { "$ref": "#/components/schemas/ads_filter_conditions" }, "start_dates": { "$ref": "#/components/schemas/start_dates" }, "end_dates": { "$ref": "#/components/schemas/end_dates" }, "active_dates": { "$ref": "#/components/schemas/advertisement_active_dates_search" }, "created_at": { "$ref": "#/components/schemas/search_created_at" }, "company_locations": { "$ref": "#/components/schemas/company_locations" }, "companies": { "$ref": "#/components/schemas/companies" }, "advertisement_search_id": { "allOf": [ { "$ref": "#/components/schemas/advertisement_search_id" } ], "description": "仅返回这一条记录。适合在不翻页的情况下重新获取你此前存储的某一行。" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "is_realtime_enrichment": { "$ref": "#/components/schemas/is_realtime_enrichment" }, "advertisement_formats": { "$ref": "#/components/schemas/advertisement_formats" }, "reach_tiers": { "$ref": "#/components/schemas/advertisement_reach_tiers" }, "advertisement_active_ads": { "$ref": "#/components/schemas/advertisement_active_ads" }, "advertisement_running_ads": { "$ref": "#/components/schemas/advertisement_running_ads" }, "advertisement_total_ads": { "$ref": "#/components/schemas/advertisement_total_ads" }, "advertisement_platform_count": { "$ref": "#/components/schemas/advertisement_platform_count" }, "advertisement_format_count": { "$ref": "#/components/schemas/advertisement_format_count" }, "advertisement_impressions_estimate": { "$ref": "#/components/schemas/advertisement_impressions_estimate" }, "advertisement_country_activity": { "$ref": "#/components/schemas/advertisement_country_activity" }, "source_types": { "$ref": "#/components/schemas/advertisement_source_types" }, "exclude_source_types": { "$ref": "#/components/schemas/advertisement_exclude_source_types" }, "enrichment_mode": { "$ref": "#/components/schemas/advertisement_enrichment_mode" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "is_ascending_order": { "$ref": "#/components/schemas/is_ascending_order" }, "publisher_platforms": { "$ref": "#/components/schemas/advertisement_publisher_platforms" }, "exclude_publisher_platforms": { "$ref": "#/components/schemas/advertisement_exclude_publisher_platforms" }, "is_include_unlinked_companies": { "$ref": "#/components/schemas/advertisement_is_include_unlinked_companies" } } } } } }, "operationId": "companies_search_advertisements", "summary": "搜索公司广告", "description": "搜索公司投放的广告。参见[广告搜索指南](/cn/developer-guides/search/advertisement-search)。", "tags": [ "Search" ] } }, "/companies/advertisements/lookup": { "post": { "responses": { "200": { "description": "包含公司广告详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "headline": "Thuraya-4 Satellite Solutions for Government", "description": "Thuraya-4 provides secure, always-on connectivity for vehicles, aircraft and command centers, ensuring mission continuity. \n\nLearn more about our satellite-powered government solutions.", "poster": "Space42", "poster_title": "Promoted", "promoted_by": null, "cta": "Learn more", "target_country_codes": [ "MM", "..." ], "target_locations": [ "United Arab Emirates", "..." ], "total_impressions": "10k-20k", "impression_countries": [ { "country": "India", "impressions": "19%" }, "..." ], "advertisement_id": "a92643e8-9033-4029-aa65-ef929327cebb", "advertisement_search_id": "a92643e8-9033-4029-aa65-ef929327cebb", "created_at": "2026-03-03T01:01:31.134Z", "last_modified": "2026-03-03T13:01:22.805Z", "started_at": "2026-02-25T00:00:00.000Z", "ended_at": "2026-03-02T00:00:00.000Z", "title": "Thuraya-4 Satellite Solutions for Government", "source_type": "linkedin", "advertisement_format": "Single Image Ad", "video_url": null, "image_url": "https://buckets.pubrio.com/images/public/qDf8TrjHJw9o8xFoQJv7vhnkLXNYKy1ThNVCWSHPmgHG5j7U4EroKtH4cYJcHCzTSh.jpg", "carousel_images": null, "destination_url": "https://www.thuraya.com/en/thuraya-4-ngs/home/index.html?trk=ad_library_ad_preview_headline_content", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/MjA3NTQ4NjQyM2lsajlzc25qMXNwYWNlNDIuYWlsaW5rZWRpbl82NDIyMjM3NA==.jpg", "domain_search_id": "fe3963dc-87a4-4016-8c95-217ea68cd57a", "company_name": "Space42", "linkedin_name": "space42ai", "country_code": "AE", "domain": "space42.ai" }, "raw_link_url": null, "publisher_platforms": null } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "advertisement_search_id": { "$ref": "#/components/schemas/advertisement_search_id" }, "is_include_unlinked_companies": { "$ref": "#/components/schemas/advertisement_is_include_unlinked_companies" } }, "required": [ "advertisement_search_id" ] } } } }, "operationId": "companies_lookup_advertisements", "summary": "查找公司广告", "description": "使用广告搜索 ID 获取特定公司的广告详情。响应包含解析后的 `destination_url`、原始 `raw_link_url`，以及（针对 Meta 广告的）`publisher_platforms`。", "tags": [ "Lookup" ] } }, "/technologies/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "请求上下文：`is_enrichment_available` 表示本次查询是否执行了实时增强。" }, "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": [ { "category_id": 1, "technologies": [ { "icon": "Google Ads.svg", "name": "Google Ads", "tag_id": 4580, "version": null, "website": "https://ads.google.com/", "location": "pubrio.com", "logo_url": "https://buckets.pubrio.com/technology-logo/NDU4MGIyOXNtYjhheGdvb2dsZS1hZHM=.jpg", "last_detected": null, "first_detected": "2023-01-07T06:40:56.597287" } ], "category_name": "Advertising" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" }, "domain_id": { "$ref": "#/components/schemas/domain_id" }, "tiktok_url": { "type": "string", "description": "公司的 TikTok 主页 URL。" }, "wantedly_url": { "type": "string", "description": "公司的 Wantedly 主页 URL。" }, "tw104_url": { "type": "string", "description": "公司的 104（台湾）主页 URL。" }, "rocketpunch_url": { "type": "string", "description": "公司的 RocketPunch 主页 URL。" }, "remember_url": { "type": "string", "description": "公司的 Remember 主页 URL。" }, "youtrust_url": { "type": "string", "description": "公司的 YOUTRUST 主页 URL。" }, "is_enrichment_available": { "type": "boolean", "description": "当已存储记录不完整时执行实时增强。会消耗积分。响应会在 `metadata.is_enrichment_available` 中回显是否实际执行。", "example": true } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] }, { "title": "Domain ID", "required": [ "domain_id" ] } ] } } } }, "operationId": "technologies_lookup", "summary": "查找技术", "description": "获取公司使用的特定技术的详细信息。", "tags": [ "Lookup" ] } }, "/channels/types/templates": { "get": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "channel_type_id": 1, "slug": "email", "channel_type_identifier": "db3ecea8-b838-4cfa-8aa1-c358223b0060", "logo_url": "https://buckets.pubrio.com/technology-logo/tdurnBxI97MV1hr2L1QaYgt.jpg", "node_type": "action", "channel_nodes": [ { "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c", "channel_node_identifier": "30896b66-7fc7-42bf-b5fe-ce7e1fdb9e30", "channel_type_id": 1, "slug": "send_email", "parameter_properties": [ { "name": "Subject", "slug": "subject", "hints": "My subject line", "field_type": "string", "max_length": 1000, "min_length": 1, "description": "Subject line of the email", "is_required": true, "display_type": "string", "supported_tools": [ "variables" ], "is_template_field": true, "is_verify_required": false, "is_display_as_snippet": true, "is_return_in_plain_text": true }, { "name": "Content", "slug": "content", "hints": "Write your email content", "field_type": "string", "max_length": 250000, "min_length": 0, "description": "HTML text message of email", "is_required": true, "display_type": "email_editor", "supported_tools": [ "formatting_options", "variables", "insert_link", "attachments", "insert_photo", "code_mode", { "slug": "insert_signature", "syntax": "{{insert_signature.signature_html}}" } ], "is_template_field": true, "is_verify_required": false, "is_attachment_allowed": true, "is_display_as_snippet": false, "is_return_in_plain_text": false }, { "name": "Attachments", "slug": "attachments", "hints": null, "field_type": "array", "max_length": 25, "min_length": 0, "description": null, "is_required": false, "display_type": null, "is_template_field": true, "is_verify_required": false, "is_attachment_allowed": true, "is_hide_from_control_panel": true } ], "is_template_available": true, "logo_url": "https://buckets.pubrio.com/technology-logo/tdurnBxI97MV1hr2L1QaYgt.jpg", "node_type": "action", "input_properties": [ { "name": "To email addresses [multiple comma-separated]", "slug": "to_email_addresses", "hints": "to@example.com", "field_type": "array", "max_length": 1000, "min_length": 1, "description": "Email address of the recipient", "is_required": true, "display_type": "email_input", "is_verify_required": false } ], "name": "Send Email", "description": "The Send Email node sends emails using the connected email provider." } ], "name": "Email", "description": "Sends automated emails based on triggers or events." }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "channels_get_template_types", "summary": "列出渠道模板类型", "description": "获取可用于外展模板的渠道类型。", "tags": [ "Channels" ] } }, "/channels/templates/lookup": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": [ { "channel_template_id": 245, "channel_template_identifier": "4f6f40cb-ed6d-4cca-99d8-616feef8de93", "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c", "channel_node_slug": "send_email", "channel_type_id": 1, "channel_type_slug": "email", "owner_email": "example@pubrio.com", "owner_name": "Owner", "name": "email", "description": null, "parameters": { "content": "

hello world

", "subject": "Hello World", "attachments": [] }, "default_values": null, "version_number": 1, "version_name": "version 1", "is_default": true, "is_personal": true, "created_at": "2025-07-29T09:07:11.969Z", "last_modified": "2025-07-29T09:07:11.969Z" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_template_identifier": { "$ref": "#/components/schemas/channel_template_identifier" } }, "required": [ "channel_template_identifier" ] } } } }, "operationId": "channels_lookup_template", "summary": "查找渠道模板", "description": "按 ID 获取特定渠道模板的详细信息。", "tags": [ "Channels" ] } }, "/channels/templates": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" } ], "properties": { "channel_templates": { "type": "array", "description": "模板正文。**其字段取决于渠道类型**，因此解析前请先读取 `channel_type_slug`：`email` → `subject`、`content`、`attachments`；`linkedin`（聊天消息）→ `message`、`attachments`；`linkedin`（邀请）→ `message`；`twilio` → `message`、`from`、`method`。", "items": { "type": "object" } } } } } }, "example": { "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 4, "total_pages": 1, "is_timeout": false }, "channel_templates": [ { "channel_template_id": 1, "channel_template_identifier": "4f6f40cb-ed6d-4cca-99d8-616feef8de93", "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c", "channel_node_slug": "send_email", "channel_type_id": 1, "channel_type_slug": "email", "owner_email": "example@pubrio.com", "owner_name": "Owner", "name": "email", "version_number": 1, "version_name": "version 1", "is_default": true, "is_personal": true, "created_at": "2025-07-29T09:07:11.969Z", "last_modified": "2025-07-29T09:07:11.969Z", "channel_template_versions": [ { "channel_template_id": 1, "channel_template_identifier": "4f6f40cb-ed6d-4cca-99d8-616feef8de93", "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c", "channel_node_slug": "send_email", "channel_type_id": 1, "channel_type_slug": "email", "owner_email": "example@pubrio.com", "owner_name": "Owner", "name": "email", "parameters": { "content": "

hello world

", "subject": "Hello World", "attachments": [] }, "version_number": 1, "version_name": "version 1", "default_values": null, "is_default": true, "is_personal": true, "created_at": "2025-07-29T09:07:11.969581", "last_modified": "2025-07-29T09:07:11.969581" } ] }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_template_name": { "$ref": "#/components/schemas/channel_template_name" }, "channel_nodes": { "$ref": "#/components/schemas/channel_nodes" }, "channel_types": { "$ref": "#/components/schemas/channel_types" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" } } } } } }, "operationId": "channels_list_templates", "summary": "列出渠道模板", "description": "获取工作区中所有渠道外展模板的列表。", "tags": [ "Channels" ] } }, "/channels/templates/create": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "channel_template_id": 248, "channel_template_identifier": "4c717a78-26e9-49eb-ab2e-e1ce0755674a", "created_at": "2025-08-07T17:22:11.344Z", "version_number": 1, "is_default": true, "name": "Email Template", "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c", "parameters": { "content": "

hello world

", "subject": "hello world" }, "version_name": "Default" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_template_name": { "type": "string", "description": "模板的显示名称。" }, "version_name": { "type": "string", "description": "该版本的标签，例如 `v1`。每个版本都是独立记录，拥有各自的 `channel_template_id`。" }, "channel_node_id": { "type": "string", "description": "该模板所对应的渠道节点，格式为 UUID。请通过 [Channel Template Types](/cn/api-reference/endpoint/channels/types_templates) 获取 —— 例如 `email` 渠道类型下的 `send_email` 节点。该节点同时决定了 `parameters` 中哪些字段有效。" }, "parameters": { "type": "object", "description": "模板正文。有效字段由所选的 `channel_node_id` 决定：`send_email` 接受 `subject`、`content` 与 `attachments`；LinkedIn 聊天接受 `message` 与 `attachments`；LinkedIn 邀请接受 `message`；Twilio 接受 `message`、`from` 与 `method`。" } }, "required": [ "channel_template_name", "parameters", "channel_node_id" ] } } } }, "operationId": "channels_create_template", "summary": "创建渠道模板", "description": "使用指定参数创建新的外展渠道模板。", "tags": [ "Channels" ] } }, "/channels/templates/create_version": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "channel_template_id": 249, "channel_template_identifier": "4c717a78-26e9-49eb-ab2e-e1ce0755674a", "created_at": "2025-08-07T17:22:11.344Z", "version_number": 2, "is_default": true, "name": "Email Template", "channel_node_id": "93873c33-2635-4537-928c-6a4f3564164c", "parameters": { "content": "

hello world

", "subject": "hello world" }, "version_name": "Default 2" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_template_identifier": { "$ref": "#/components/schemas/channel_template_identifier" }, "channel_template_id": { "$ref": "#/components/schemas/channel_template_id" }, "version_name": { "$ref": "#/components/schemas/version_name" }, "is_default": { "$ref": "#/components/schemas/is_default" }, "parameters": { "$ref": "#/components/schemas/channel_template_parameters" } }, "required": [ "channel_template_identifier" ] } } } }, "operationId": "channels_create_template_version", "summary": "创建模板版本", "description": "创建现有渠道模板的新版本。", "tags": [ "Channels" ] } }, "/channels/templates/default": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": [ { "channel_template_id": 251, "channel_template_identifier": "4c717a78-26e9-49eb-ab2e-e1ce0755674a", "is_default": true, "last_modified": "2025-08-07T17:58:54.105Z" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_template_id": { "$ref": "#/components/schemas/channel_template_id" } }, "required": [ "channel_template_id" ] } } } }, "operationId": "channels_get_default_template", "summary": "获取默认渠道模板", "description": "获取工作区的默认渠道模板。", "tags": [ "Channels" ] } }, "/channels/templates/update": { "post": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": { "channel_template_id": 251, "last_modified": "2025-08-07T18:00:43.255Z", "name": "Email Template", "...": "..." } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_template_identifier": { "$ref": "#/components/schemas/channel_template_identifier" }, "channel_template_id": { "$ref": "#/components/schemas/channel_template_id" }, "channel_template_name": { "type": "string", "description": "模板的显示名称。" }, "version_name": { "type": "string", "description": "该版本的标签，例如 `v1`。每个版本都是独立记录，拥有各自的 `channel_template_id`。" }, "parameters": { "type": "object", "description": "模板正文。有效字段由所选的 `channel_node_id` 决定：`send_email` 接受 `subject`、`content` 与 `attachments`；LinkedIn 聊天接受 `message` 与 `attachments`；LinkedIn 邀请接受 `message`；Twilio 接受 `message`、`from` 与 `method`。" } }, "required": [ "channel_template_id", "channel_template_identifier" ] } } } }, "operationId": "channels_update_template", "summary": "更新渠道模板", "description": "更新现有渠道模板的配置。", "tags": [ "Channels" ] } }, "/channels/templates/delete": { "delete": { "responses": { "200": { "description": "包含相关详细信息的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data" } } }, "example": { "data": null } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel_templates": { "type": "array", "description": "要删除的数字型 `channel_template_id` 列表 —— 不是 UUID 形式的 `channel_template_identifier`。**每个版本需单独删除。** 通过 `create_version` 创建的模板会有多个 id 共用同一个 identifier；只删除其中一个，其余版本仍会保留，模板也会继续出现在列表中。请从 [Channel Templates](/cn/api-reference/endpoint/channels/templates) 读取每个版本的 `channel_template_id` 并一并传入，才能彻底删除该模板。", "items": { "type": "integer" }, "example": [ 380, 381 ] }, "is_entire_templates": { "$ref": "#/components/schemas/is_entire_templates" } }, "required": [ "channel_templates" ] } } } }, "operationId": "channels_delete_template", "summary": "删除渠道模板", "description": "从工作区中删除渠道模板。", "tags": [ "Channels" ] } }, "/monitors/statistics": { "post": { "responses": { "200": { "description": "成功响应，包含监控统计概览。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total_monitors": { "type": "integer", "description": "工作区中的监控总数。" }, "triggers_today": { "type": "integer", "description": "今日触发次数。" }, "triggers_yesterday": { "type": "integer", "description": "昨日触发次数。" }, "triggers_comparison_rate": { "type": "number", "description": "今日与昨日触发次数的变化率。负值表示下降。" }, "success_today": { "type": "integer", "description": "今日成功触发次数。" }, "success_yesterday": { "type": "integer", "description": "昨日成功触发次数。" }, "success_rate_today": { "type": "number", "nullable": true, "description": "今日触发成功率（0 到 1）。今日没有触发时为 null。" }, "success_rate_yesterday": { "type": "number", "nullable": true, "description": "昨日触发成功率（0 到 1）。昨日没有触发时为 null。" }, "triggers_last_7_days": { "type": "integer", "description": "最近 7 天的监控触发次数。" }, "avg_triggers_per_day": { "type": "number", "description": "最近 7 天平均每日触发次数（向上取整）。" }, "success_rate_last_7_days": { "type": "number", "nullable": true, "description": "最近 7 天的成功率（0 到 1）。窗口内没有触发时为 null。" } } } } }, "example": { "data": { "total_monitors": 8, "triggers_today": 3, "triggers_yesterday": 46, "triggers_comparison_rate": -0.935, "triggers_last_7_days": 112, "avg_triggers_per_day": 16, "success_today": 3, "success_yesterday": 46, "success_rate_today": 1, "success_rate_yesterday": 1, "success_rate_last_7_days": 0.982 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "operationId": "monitors_get_statistics", "summary": "获取监控统计", "description": "获取工作区级的监控触发统计概览。没有 monitor_id 参数——数据为工作区内所有监控的聚合结果（不含关注列表类监控）。", "tags": [ "Monitor" ] } }, "/monitors/statistics/logs": { "post": { "responses": { "200": { "description": "成功响应。响应信封为 `{ metadata: { filters }, data: { pagination, monitor_logs } }`——`metadata.filters` 会回显本次搜索实际应用的过滤条件。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "filters": { "type": "object", "description": "本次搜索所应用过滤条件的回显。" } } }, "data": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer", "description": "当前页码。" }, "per_page": { "type": "integer", "description": "每页结果数。" }, "total_entries": { "type": "integer", "description": "日志条目总数。" }, "total_pages": { "type": "integer", "description": "总页数。" }, "total_display_pages": { "type": "integer", "description": "显示总页数。" }, "is_timeout": { "type": "boolean", "description": "查询是否超时。" } } }, "monitor_logs": { "type": "array", "items": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "此日志条目的唯一标识符。" }, "monitor_id": { "type": "string", "format": "uuid", "description": "生成此日志的监控标识符。" }, "parent_monitor_log_id": { "type": "string", "description": "父日志条目的标识符（如果这是重试）。" }, "detection_mode": { "type": "string", "description": "使用的检测模式。'company_first' 或 'signal_first'。" }, "signal_type": { "type": "array", "items": { "type": "string" }, "description": "监控的信号类型（例如 'jobs'、'news'、'advertisements'）。" }, "destination_type": { "type": "string", "description": "投递目标类型（例如 'email'、'webhook'）。" }, "response_status_code": { "type": "integer", "description": "目标响应的 HTTP 状态码。" }, "status": { "type": "string", "description": "触发执行的状态（例如 'success'、'failed'）。" }, "error_message": { "type": "string", "description": "触发失败时的错误消息。成功时为空字符串。" }, "total_signals": { "type": "integer", "description": "检测到的信号总数。" }, "total_companies": { "type": "integer", "description": "找到的公司总数。" }, "total_people": { "type": "integer", "description": "找到的人员总数。" }, "trigger_credit": { "type": "integer", "description": "触发本身消耗的积分。" }, "total_company_credit": { "type": "integer", "description": "公司信息增强消耗的积分。" }, "total_people_credit": { "type": "integer", "description": "人员信息增强消耗的积分。" }, "redeem_email_credit": { "type": "integer", "description": "邮箱兑换消耗的积分。" }, "redeem_phone_credit": { "type": "integer", "description": "电话兑换消耗的积分。" }, "total_credit": { "type": "integer", "description": "此次触发消耗的总积分。" }, "retry_attempt": { "type": "integer", "description": "重试次数。" }, "processing_time_ms": { "type": "integer", "description": "总处理时间（毫秒）。" }, "created_at": { "type": "string", "format": "date-time", "description": "日志条目创建的时间戳。" }, "retry_logs": { "type": "array", "items": { "type": "object" }, "description": "重试日志条目数组（如有）。" }, "is_retry_succeed": { "type": "boolean", "description": "重试是否成功。" } } } } } } } }, "example": { "metadata": { "filters": { "statuses": [ "failure" ], "language": "en" } }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 45, "total_pages": 2, "total_display_pages": 2, "is_timeout": false }, "monitor_logs": [ { "monitor_log_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "monitor_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "parent_monitor_log_id": "", "detection_mode": "company_first", "signal_type": [ "jobs", "news", "advertisements" ], "destination_type": "email", "response_status_code": 200, "status": "success", "error_message": "", "total_signals": 25, "total_companies": 11, "total_people": 32, "trigger_credit": 15, "total_company_credit": 11, "total_people_credit": 33, "redeem_email_credit": 0, "redeem_phone_credit": 0, "total_credit": 59, "retry_attempt": 0, "processing_time_ms": 97952, "created_at": "2026-04-05T18:28:05.000Z", "retry_logs": [], "is_retry_succeed": false }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "要检索日志的监控唯一标识符。" }, "monitor_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "筛选来自这些监控的日志。" }, "monitor_log_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "筛选到这些特定的日志条目。" }, "search_term": { "type": "string", "description": "搜索词，与 error_message、destination_type 和 detection_mode 匹配（不区分大小写的子串匹配）。" }, "start_date": { "type": "string", "format": "date", "description": "created_at 日期范围的开始（ISO 日期字符串）。与 end_date 一起使用。" }, "end_date": { "type": "string", "format": "date", "description": "created_at 日期范围的结束（ISO 日期字符串）。与 start_date 一起使用。" }, "order_by": { "type": "string", "enum": [ "created_at", "total_credit", "processing_time_ms", "total_signals", "status", "retry_attempt" ], "description": "排序字段。默认为 created_at。", "default": "created_at" }, "is_ascending_order": { "type": "boolean", "description": "按升序排序。默认为 false（降序）。", "default": false }, "statuses": { "type": "array", "items": { "type": "string" }, "description": "按触发状态过滤（例如 'success'、'failure'）。也接受虚拟值 'recovered'——重试后最终成功的失败触发。" }, "signal_types": { "type": "array", "items": { "type": "string" }, "description": "筛选信号类型包含其中任一值的日志。" }, "destination_types": { "type": "array", "items": { "type": "string" }, "description": "按目标类型过滤（例如 ['email', 'webhook']）。" }, "detection_modes": { "type": "array", "items": { "type": "string" }, "description": "按检测模式过滤（例如 ['company_first', 'signal_first']）。" }, "per_page": { "type": "integer", "description": "每页记录数。默认 25，在大多数套餐下这也是上限 —— 该限制即订阅中的 `max_search_per_page`，可通过 [Profile](/cn/api-reference/endpoint/profile/profile) 获取。超出会返回 **HTTP 416** 及错误码 `41676`（公司与人物搜索为 `41613`），而不是自动截断结果。", "default": 25 }, "page": { "type": "integer", "description": "页码，从 1 开始。上限为订阅中的 `max_search_page`（公司搜索为 `max_company_search_page`），可通过 [Profile](/cn/api-reference/endpoint/profile/profile) 获取。超出会返回 **HTTP 416**。", "default": 1 } } } } } }, "operationId": "monitors_list_statistics_logs", "summary": "列出监控统计日志", "description": "获取特定监控的分页检测日志列表。", "tags": [ "Monitor" ] } }, "/monitors/statistics/logs/lookup": { "post": { "responses": { "200": { "description": "成功响应，包含单条监控日志的详细信息，含完整的请求和响应负载。响应信封为 `{ metadata: { monitor_log_id }, data: {...} }`。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "被查询的监控日志标识符。" } } }, "data": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "此日志条目的唯一标识符。" }, "monitor_id": { "type": "string", "format": "uuid", "description": "生成此日志的监控标识符。" }, "parent_monitor_log_id": { "type": "string", "description": "父日志条目的标识符（如果这是重试）。" }, "detection_mode": { "type": "string", "description": "使用的检测模式。'company_first' 或 'signal_first'。" }, "signal_type": { "type": "array", "items": { "type": "string" }, "description": "监控的信号类型。" }, "destination_type": { "type": "string", "description": "投递目标类型。" }, "response_status_code": { "type": "integer", "description": "目标响应的 HTTP 状态码。" }, "status": { "type": "string", "description": "触发执行的状态。" }, "error_message": { "type": "string", "description": "触发失败时的错误消息。" }, "total_signals": { "type": "integer", "description": "检测到的信号总数。" }, "total_companies": { "type": "integer", "description": "找到的公司总数。" }, "total_people": { "type": "integer", "description": "找到的人员总数。" }, "trigger_credit": { "type": "integer", "description": "触发消耗的积分。" }, "total_company_credit": { "type": "integer", "description": "公司信息增强消耗的积分。" }, "total_people_credit": { "type": "integer", "description": "人员信息增强消耗的积分。" }, "redeem_email_credit": { "type": "integer", "description": "邮箱兑换消耗的积分。" }, "redeem_phone_credit": { "type": "integer", "description": "电话兑换消耗的积分。" }, "total_credit": { "type": "integer", "description": "消耗的总积分。" }, "retry_attempt": { "type": "integer", "description": "重试次数。" }, "processing_time_ms": { "type": "integer", "description": "总处理时间（毫秒）。" }, "created_at": { "type": "string", "format": "date-time", "description": "日志条目创建的时间戳。" }, "retry_logs": { "type": "array", "items": { "type": "object" }, "description": "重试日志条目数组。" }, "is_retry_succeed": { "type": "boolean", "description": "重试是否成功。" }, "request_payload": { "type": "object", "description": "此次触发执行发送的完整监控配置和数据。" }, "response_payload": { "type": "object", "description": "从目标接收到的响应负载。" }, "attributes": { "type": "object", "description": "为此次触发捕获的执行属性（目标快照及相关元数据）。Webhook 签名密钥已被抹除。" } } } } }, "example": { "metadata": { "monitor_log_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "data": { "monitor_log_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "monitor_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "parent_monitor_log_id": "", "detection_mode": "company_first", "signal_type": [ "jobs", "news" ], "destination_type": "webhook", "response_status_code": 200, "status": "success", "error_message": "", "total_signals": 10, "total_companies": 5, "total_people": 12, "trigger_credit": 8, "total_company_credit": 5, "total_people_credit": 12, "redeem_email_credit": 0, "redeem_phone_credit": 0, "total_credit": 25, "retry_attempt": 0, "processing_time_ms": 45230, "created_at": "2026-04-05T18:28:05.000Z", "retry_logs": [], "is_retry_succeed": false, "request_payload": {}, "response_payload": {}, "attributes": {} } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "要查找的监控日志条目的唯一标识符。" } }, "required": [ "monitor_log_id" ] } } } }, "operationId": "monitors_lookup_statistics_log", "summary": "查找监控统计日志", "description": "获取特定监控检测日志条目的详细信息。", "tags": [ "Monitor" ] } }, "/monitors/statistics/chart": { "post": { "responses": { "200": { "description": "成功响应，包含监控触发统计数据的时间序列图表数据点。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date_series": { "type": "string", "format": "date", "description": "此数据点的日期。" }, "total_triggers": { "type": "integer", "description": "该日期的触发总数。" }, "total_success": { "type": "integer", "description": "该日期的成功触发总数。" }, "total_failure": { "type": "integer", "description": "该日期的失败触发总数。" }, "total_credit": { "type": "number", "description": "该日期消耗的总积分。" } } } } } }, "example": { "data": [ { "date_series": "2026-04-01", "total_triggers": 12, "total_success": 11, "total_failure": 1, "total_credit": 236 }, { "date_series": "2026-04-02", "total_triggers": 8, "total_success": 8, "total_failure": 0, "total_credit": 154 }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "可选。用于将图表限定到某个监控的唯一标识符。省略时，图表聚合工作区内的所有监控。" }, "start_date": { "type": "string", "format": "date", "description": "图表范围的开始日期（YYYY-MM-DD）。" }, "end_date": { "type": "string", "format": "date", "description": "图表范围的结束日期（YYYY-MM-DD）。" } }, "required": [ "start_date", "end_date" ] } } } }, "operationId": "monitors_get_statistics_chart", "summary": "获取监控统计图表数据", "description": "获取监控的图表时间序列统计数据。", "tags": [ "Monitor" ] } }, "/monitors/process/try": { "post": { "responses": { "200": { "description": "成功响应，包含触发执行结果。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "被触发的监控标识符。" }, "status": { "type": "string", "description": "触发执行的状态。" }, "total_signals": { "type": "integer", "description": "检测到的信号总数。" }, "total_credit": { "type": "integer", "description": "消耗的总积分。" }, "processing_time_ms": { "type": "integer", "description": "总处理时间（毫秒）。" }, "delivery_result": { "type": "object", "properties": { "is_success": { "type": "boolean", "description": "投递是否成功。" }, "error_message": { "type": "string", "nullable": true, "description": "投递失败时的错误消息。" }, "response_status_code": { "type": "integer", "description": "目标返回的 HTTP 状态码。" }, "response_payload": { "type": "string", "description": "目标返回的响应体。" }, "retry_attempt": { "type": "integer", "description": "重试次数。" } }, "description": "投递结果详情。" } } } } }, "example": { "data": { "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "success", "total_signals": 25, "total_credit": 59, "processing_time_ms": 99050, "delivery_result": { "is_success": true, "error_message": null, "response_status_code": 200, "response_payload": "OK", "retry_attempt": 0 } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "可选。要触发的已保存监控的唯一标识符。省略则运行以内联方式传入的未保存临时配置。" }, "tried_at": { "type": "string", "format": "date-time", "description": "用作扫描参考点的时间戳。使用最近的过去日期以确保测试时有可用数据。使用当前时间可能返回 0 条结果。" }, "name": { "type": "string", "description": "本次运行配置的名称。" }, "detection_mode": { "type": "string", "enum": [ "company_first", "signal_first" ], "description": "本次运行的检测模式。" }, "signal_types": { "type": "array", "items": { "type": "string" }, "description": "要扫描的信号类型（jobs、news、advertisements、expansions）。" }, "signal_filters": { "type": "array", "items": { "type": "object" }, "description": "按信号类型的过滤器对象，结构与创建监控相同。" }, "company_filters": { "type": "object", "description": "全局公司过滤器，参数与公司搜索相同。" }, "companies": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "要扫描的公司 domain_search_id UUID 列表。" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "要扫描的公司域名——将被解析为公司。" }, "linkedin_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "要扫描的 LinkedIn 公司网址——将被解析为公司。" }, "is_company_enrichment": { "type": "boolean", "description": "是否在结果中增强公司数据。" }, "is_people_enrichment": { "type": "boolean", "description": "是否在结果中增强人员数据。" }, "people_enrichment_configs": { "type": "array", "items": { "type": "object" }, "description": "人员增强层，结构与创建监控相同。" }, "destination_type": { "type": "string", "enum": [ "webhook", "email", "sequences" ], "description": "本次运行的投递目标类型。" }, "destination_config": { "type": "object", "description": "本次运行的目标配置，结构与创建监控相同。" }, "max_records_per_trigger": { "type": "integer", "description": "本次运行投递的最大记录数。" } } } } } }, "operationId": "monitors_process_try", "summary": "尝试处理监控", "description": "按 id 运行已保存的监控，或以内联方式传入配置来运行未保存的临时配置；提供 monitor_id 时，内联字段会在本次运行中覆盖已保存监控的对应设置。", "tags": [ "Monitor" ] } }, "/monitors/process/retry": { "post": { "responses": { "200": { "description": "成功响应，包含重试执行结果。响应信封为 `{ metadata: { monitor_log_id, status }, data: {...} }`。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "被重试的监控日志条目。" }, "status": { "type": "string", "enum": [ "success", "failure", "skipped" ], "description": "重试结果。'skipped' 表示原触发已经成功。" } } }, "data": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "被重试的监控日志条目。" }, "status": { "type": "string", "enum": [ "success", "failure", "skipped" ], "description": "重试结果。" }, "monitor_id": { "type": "string", "format": "uuid", "description": "监控的标识符。" }, "delivery_result": { "type": "object", "properties": { "is_success": { "type": "boolean", "description": "投递是否成功。" }, "error_message": { "type": "string", "nullable": true, "description": "投递失败时的错误消息。" }, "response_status_code": { "type": "integer", "description": "目标返回的 HTTP 状态码。" }, "response_payload": { "type": "string", "description": "目标返回的响应正文。" }, "retry_attempt": { "type": "integer", "description": "重试次数。" } }, "description": "投递结果详情。" }, "total_credit": { "type": "integer", "description": "消耗的总积分。" }, "processing_time_ms": { "type": "integer", "description": "总处理时间（毫秒）。" } } } } }, "example": { "metadata": { "monitor_log_id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "status": "success" }, "data": { "monitor_log_id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "status": "success", "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_result": { "is_success": true, "error_message": null, "response_status_code": 200, "response_payload": "...", "retry_attempt": 0 }, "total_credit": 59, "processing_time_ms": 7541 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_log_id": { "type": "string", "format": "uuid", "description": "要重试的监控日志条目的唯一标识符。" }, "is_use_original_destination": { "type": "boolean", "description": "设为 true 时，使用原始日志条目中的目标配置快照，而非当前监控配置。" } }, "required": [ "monitor_log_id" ] } } } }, "operationId": "monitors_process_retry", "summary": "重试处理监控", "description": "重试失败的监控处理运行。", "tags": [ "Monitor" ] } }, "/monitors": { "post": { "responses": { "200": { "description": "成功响应，包含分页的监控列表。此列表不含关注列表类监控。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer", "description": "当前页码。" }, "per_page": { "type": "integer", "description": "每页结果数。" }, "total_entries": { "type": "integer", "description": "监控总数。" }, "total_pages": { "type": "integer", "description": "总页数。" }, "total_display_pages": { "type": "integer", "description": "显示总页数。" }, "is_timeout": { "type": "boolean", "description": "查询是否超时。" } } }, "monitors": { "type": "array", "items": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "监控的唯一标识符。" }, "name": { "type": "string", "description": "监控名称。" }, "description": { "type": "string", "description": "监控描述。" }, "detection_mode": { "type": "string", "description": "检测模式：'company_first' 或 'signal_first'。" }, "signal_types": { "type": "array", "items": { "type": "string" }, "description": "要监控的信号类型（例如 'jobs'、'news'、'advertisements'）。" }, "signal_filters": { "type": "object", "description": "应用于信号的过滤器。使用与搜索端点相同的过滤器结构。" }, "company_filters": { "type": "object", "description": "应用于公司的过滤器。使用与搜索端点相同的过滤器结构。" }, "companies": { "type": "array", "items": { "type": "string" }, "description": "要监控的公司标识符数组。" }, "is_company_enrichment": { "type": "boolean", "description": "是否在结果中增强公司数据。" }, "is_people_enrichment": { "type": "boolean", "description": "是否在结果中增强人员数据。" }, "people_enrichment_configs": { "type": "object", "description": "人员增强配置，包括过滤器和限制。", "properties": { "max_people_to_return": { "type": "integer", "description": "每家公司返回的最大人员数。最小值：1，最大值：25。" } } }, "destination_type": { "type": "string", "description": "投递目标类型（例如 'email'、'webhook'）。" }, "destination_config": { "type": "object", "description": "投递目标的配置（例如 webhook URL、邮箱地址）。" }, "frequency_minute": { "type": "integer", "description": "触发频率（分钟）。最小值：0，最大值：1440，默认值：0。" }, "max_retry_per_trigger": { "type": "integer", "description": "每次触发的最大重试次数。最小值：0，最大值：3，默认值：1。" }, "max_records_per_trigger": { "type": "integer", "description": "每次触发的最大记录数。最小值：1，最大值：100，默认值：25。" }, "retry_delay_second": { "type": "integer", "description": "重试间隔（秒）。最小值：1，最大值：5，默认值：1。" }, "max_daily_trigger": { "type": "integer", "description": "每日最大触发次数。最小值：0，最大值：86400，默认值：500。" }, "max_failure_trigger": { "type": "integer", "description": "暂停前的最大连续失败次数。最小值：1，最大值：10，默认值：5。" }, "masked_signature": { "type": "string", "description": "用于显示的已遮罩 webhook 签名。" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "监控的生命周期状态。" }, "notification_email": { "type": "string", "description": "监控通知邮箱地址。" }, "repeated_failure_count": { "type": "integer", "description": "当前连续失败次数。" }, "last_trigger_at": { "type": "string", "format": "date-time", "nullable": true, "description": "最后一次触发的时间戳。" }, "last_processed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "最后一次处理完成的时间戳。" }, "created_at": { "type": "string", "format": "date-time", "description": "监控创建的时间戳。" }, "last_modified": { "type": "string", "format": "date-time", "description": "监控最后修改的时间戳。" }, "user": { "type": "object", "properties": { "user_id": { "type": "string", "description": "创建监控的用户标识符。" }, "nickname": { "type": "string", "description": "用户显示名称。" }, "email": { "type": "string", "description": "用户邮箱。" } }, "description": "创建监控的用户。" }, "total_trigger_today": { "type": "integer", "description": "今日已执行的触发次数。" }, "success_rate": { "type": "string", "nullable": true, "description": "总体成功率（0 到 1），十进制字符串形式，例如 \"0.983\"。监控从未触发时为 null。" } } } } } } } }, "example": { "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 8, "total_pages": 1, "total_display_pages": 1, "is_timeout": false }, "monitors": [ { "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Company First Monitor", "description": null, "detection_mode": "company_first", "signal_types": [ "jobs", "news", "advertisements" ], "signal_filters": [ { "filters": { "locations": [ "US" ] }, "signal_type": "jobs" }, { "filters": { "locations": [ "US" ] }, "signal_type": "news" }, { "filters": { "target_locations": [ "US" ] }, "signal_type": "advertisements" } ], "company_filters": { "locations": [ "US" ] }, "companies": [ "67c4696b-b7b0-46b5-b2af-9f434543661e" ], "is_company_enrichment": true, "is_people_enrichment": true, "people_enrichment_configs": [ { "filters": { "people_locations": [ "US" ] }, "max_people_to_return": 3, "people_contact_types": [ "email-work" ] } ], "destination_type": "webhook", "destination_config": { "webhook_url": "https://usewebhook.com/example", "headers": { "X-Custom-Auth": "your-token" }, "body": { "source": "pubrio" } }, "notification_email": "team@example.com", "max_retry_per_trigger": 1, "retry_delay_second": 1, "max_records_per_trigger": 25, "max_daily_trigger": 500, "frequency_minute": 0, "status": "active", "max_failure_trigger": 5, "repeated_failure_count": 0, "last_trigger_at": "2026-04-05T22:29:36.349Z", "last_processed_at": "2026-04-05T18:28:05.715Z", "masked_signature": "9••••••••••••••••f09", "created_at": "2026-04-03T18:49:20.048Z", "last_modified": "2026-04-05T22:29:36.349Z", "user": { "user_id": "a1b2c3d4-0000-0000-0000-000000000000", "nickname": "Jane Smith", "email": "jane@example.com" }, "total_trigger_today": 4, "success_rate": "1.000" }, "..." ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "destination_types": { "type": "array", "items": { "type": "string" }, "description": "按目标类型过滤（例如 ['email', 'webhook']）。空数组返回全部。" }, "detection_modes": { "type": "array", "items": { "type": "string" }, "description": "按检测模式过滤（例如 ['company_first', 'signal_first']）。空数组返回全部。" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "按监控状态过滤。" }, "is_ascending_order": { "type": "boolean", "description": "按升序排序。默认为 false（降序）。", "default": false }, "order_by": { "type": "string", "enum": [ "name", "last_trigger_at", "last_modified" ], "description": "排序字段。可接受的值：'name'、'last_trigger_at'、'last_modified'。省略时，列表按 created_at 降序排列。" }, "search_term": { "type": "string", "nullable": true, "description": "搜索词，仅与监控名称匹配（正则表达式，不区分大小写）。" }, "per_page": { "type": "integer", "description": "每页记录数。默认 25，在大多数套餐下这也是上限 —— 该限制即订阅中的 `max_search_per_page`，可通过 [Profile](/cn/api-reference/endpoint/profile/profile) 获取。超出会返回 **HTTP 416** 及错误码 `41676`（公司与人物搜索为 `41613`），而不是自动截断结果。", "default": 25 }, "page": { "type": "integer", "description": "页码，从 1 开始。上限为订阅中的 `max_search_page`（公司搜索为 `max_company_search_page`），可通过 [Profile](/cn/api-reference/endpoint/profile/profile) 获取。超出会返回 **HTTP 416**。", "default": 1 } } } } } }, "operationId": "monitors_list", "summary": "列出监控", "description": "获取工作区中所有监控的列表。", "tags": [ "Monitor" ] } }, "/monitors/create": { "post": { "responses": { "200": { "description": "成功响应，包含新创建的监控详情。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "新创建监控的唯一标识符。" }, "name": { "type": "string", "description": "监控名称。" }, "description": { "type": "string", "description": "监控描述。" }, "detection_mode": { "type": "string", "description": "检测模式：'company_first' 或 'signal_first'。" }, "signal_types": { "type": "array", "items": { "type": "string" }, "description": "该监控关注的信号类型。" }, "signal_filters": { "type": "array", "items": { "type": "object" }, "description": "按信号类型存储的筛选条件。使用 `query` 创建时，这里就是你的语句被解析成的结果——请核对以确认监控的内容符合预期。" }, "company_filters": { "type": "object", "description": "应用于每条匹配信号的公司资料筛选条件。" }, "companies": { "type": "array", "items": { "type": "string" }, "description": "被监控的公司（company_first）。" }, "is_company_enrichment": { "type": "boolean", "description": "是否为匹配结果补充公司详情。" }, "is_people_enrichment": { "type": "boolean", "description": "是否为匹配结果补充人物与联系方式。" }, "people_enrichment_configs": { "type": "array", "items": { "type": "object" }, "description": "已存储的人物增强设置。" }, "destination_type": { "type": "string", "description": "投递目标类型。" }, "destination_config": { "type": "object", "description": "投递目标详情（邮箱或 webhook 地址）。" }, "frequency_minute": { "type": "integer", "description": "监控的运行频率（分钟）。" }, "notification_email": { "type": "string", "nullable": true, "description": "接收该监控自身通知的邮箱。" }, "max_retry_per_trigger": { "type": "integer", "description": "每次触发允许的重试次数。" }, "retry_delay_second": { "type": "integer", "description": "重试间隔（秒）。" }, "max_records_per_trigger": { "type": "integer", "description": "每次触发投递的最大记录数。" }, "max_daily_trigger": { "type": "integer", "description": "每日最大触发次数。" }, "max_failure_trigger": { "type": "integer", "description": "连续失败多少次后停止监控。" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "创建监控时的生命周期状态。" }, "masked_signature": { "type": "string", "description": "用于显示的已遮罩 webhook 签名。" }, "created_at": { "type": "string", "format": "date-time", "description": "监控创建的时间戳。" }, "signature": { "type": "string", "format": "uuid", "description": "用于验证负载的 webhook 签名。仅在创建时返回。" } } } } }, "example": { "data": { "monitor_id": "c9cd5421-b327-4243-9cd7-8b341b3da8bd", "name": "Expansion signals → JP", "description": null, "detection_mode": "signal_first", "signal_types": [ "expansions" ], "signal_filters": [ { "signal_type": "expansions", "filters": { "tos": [ "JP" ] } } ], "company_filters": {}, "companies": [], "is_company_enrichment": false, "is_people_enrichment": true, "people_enrichment_configs": [ { "max_people_to_return": 5, "filters": { "management_levels": [ "c_suite" ] }, "people_contact_types": [ "email-work" ] } ], "destination_type": "email", "destination_config": { "emails": [ "me@company.com" ] }, "frequency_minute": 5, "notification_email": null, "max_retry_per_trigger": 3, "retry_delay_second": 60, "max_records_per_trigger": 100, "max_daily_trigger": 24, "max_failure_trigger": 5, "status": "active", "masked_signature": "5••••••••••••••8b8", "created_at": "2026-07-16T10:27:40.469Z", "signature": "52209a0d-f1c8-4111-a685-ac86edc678b8" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "监控名称。" }, "description": { "type": "string", "description": "监控描述。" }, "status": { "type": "string", "description": "创建监控时的生命周期状态。默认为 `active`。使用 `draft` 可保存尚未完成的监控：仅需 `name`，校验会推迟到启用时，草稿不会运行。", "enum": [ "draft", "active", "paused", "inactive" ], "default": "active" }, "detection_mode": { "type": "string", "description": "信号的侦测方式。`signal_first` 面向市场广泛扫描；`company_first` 跟踪指定的客户名单，且至少需要一个公司、域名或 LinkedIn URL。**创建后不可修改** —— 对已有监控修改该字段会返回 `40021`，请改为新建监控。", "enum": [ "company_first", "signal_first" ] }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "jobs", "news", "advertisements", "expansions" ] }, "description": "要监控的信号类型。" }, "signal_filters": { "type": "array", "items": { "type": "object", "required": [ "signal_type" ], "properties": { "signal_type": { "type": "string", "enum": [ "jobs", "news", "advertisements", "expansions" ], "description": "该条目筛选的信号流。" }, "filters": { "type": "object", "description": "该信号流的筛选条件。`jobs`、`news` 与 `advertisements` 使用 [Job Search](/cn/api-reference/endpoint/companies/job_search)、[News Search](/cn/api-reference/endpoint/companies/news_search) 与 [Advertisement Search](/cn/api-reference/endpoint/companies/advertisements_search) 的参数。`expansions` 使用 [Expansion Search](/cn/api-reference/endpoint/expansions/market_lookup) 的词汇：`froms` / `tos`、`window_days`、`stages`、`scopes`、`momentum`、`freshness`、`signal_types`、`signal_subtypes`、`signal_strengths`、`source_types`。slug 取值见 [Expansion Reference](/cn/api-reference/endpoint/expansions/types)。" } } }, "description": "监控所观察的每个信号流对应一条。", "example": [ { "signal_type": "jobs", "filters": { "locations": [ "US" ] } }, { "signal_type": "news", "filters": { "locations": [ "US" ] } }, { "signal_type": "advertisements", "filters": { "target_locations": [ "US" ] } }, { "signal_type": "expansions", "filters": { "tos": [ "US" ], "stages": [ "expanding", "scaling" ], "signal_types": [ "HIRE", "EXEC" ], "signal_strengths": [ "high", "very_high" ] } } ] }, "company_filters": { "type": "object", "description": "全局公司过滤器，作为第二层应用。接受与[Company Search](/cn/api-reference/endpoint/companies/search)端点相同的参数 — locations、employees、technologies、verticals 等。", "example": { "locations": [ "US" ], "employees": [ [ 501, 1000 ], [ 1001, 5000 ] ] } }, "companies": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "要监控的公司 domain_search_id UUID 列表。主要在 company_first 模式下用于指定目标公司。也可使用 `domains` 或 `linkedin_urls` 作为替代方式 — 三者填写其一即可。" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "公司域名列表（如 [\"openai.com\", \"google.com\"]）。可作为 `companies` 的替代方式 — Pubrio 会自动解析对应的公司。`companies`、`domains`、`linkedin_urls` 三者填写其一即可。" }, "linkedin_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "LinkedIn 公司主页 URL 列表（如 [\"https://linkedin.com/company/pubrio\"]）。可作为 `companies` 的替代方式。三者填写其一即可。" }, "is_company_enrichment": { "type": "boolean", "description": "是否在结果中增强公司数据。" }, "is_people_enrichment": { "type": "boolean", "description": "是否在结果中增强人员数据。" }, "people_enrichment_configs": { "type": "array", "items": { "type": "object" }, "description": "人员增强层数组。每层执行独立的人员搜索。包含 `max_people_to_return`（1-25）、`people_contact_types`（联系类型数组，参见 [Redeem](/cn/api-reference/endpoint/redeem/people) 端点：email-work、email-personal、phone）和 `filters`（与[People Search](/cn/api-reference/endpoint/people/search)端点相同的参数）。详见人员搜索端点了解可用过滤器，Redeem 端点了解联系类型。", "example": [ { "filters": { "people_locations": [ "US" ] }, "max_people_to_return": 3, "people_contact_types": [ "email-work" ] } ] }, "destination_type": { "type": "string", "description": "投递目标类型。", "enum": [ "webhook", "email", "sequences" ] }, "destination_config": { "type": "object", "description": "目标配置。Webhook：需要 `webhook_url`（字符串），可选 `headers`（对象）和 `body`（对象）。Email：接受 `email`（字符串）或 `emails`（字符串数组）。sequences 类型需要 `sequence_identifier`（字符串），并且 `is_people_search_enrolled` / `is_company_contact_enrolled` 至少有一个设为 true。" }, "frequency_minute": { "type": "integer", "description": "触发频率（分钟）。最小值：0，最大值：10080，默认值：0。", "minimum": 0, "maximum": 10080, "default": 0 }, "max_failure_trigger": { "type": "integer", "description": "暂停监控前的最大连续失败次数。最小值：1，最大值：10，默认值：5。", "minimum": 1, "maximum": 10, "default": 5 }, "max_daily_trigger": { "type": "integer", "description": "每日最大触发次数。最小值：0，最大值：86400，默认值：500。", "minimum": 0, "maximum": 86400, "default": 500 }, "max_records_per_trigger": { "type": "integer", "description": "控制每次触发最多推送的记录数量。较低的值可减少每次推送的数据量，适用于结果集较大或下游系统有速率限制的场景。最小值：1，最大值：100，默认值：25。详情请参阅 [配置 Webhooks](/cn/developer-guides/setting-up-webhooks)。", "minimum": 1, "maximum": 100, "default": 25 }, "notification_email": { "type": "string", "format": "email", "description": "监控失败通知的邮箱地址。" }, "max_retry_per_trigger": { "type": "integer", "description": "每次触发的最大重试次数。最小值：0，最大值：3，默认值：1。", "minimum": 0, "maximum": 3, "default": 1 }, "retry_delay_second": { "type": "integer", "description": "重试间隔（秒）。最小值：1，最大值：5，默认值：1。", "minimum": 1, "maximum": 5, "default": 1 }, "query": { "type": "string", "maxLength": 2000, "description": "监控的自然语言描述（任意语言），例如“监控进入日本市场的公司，获取 C 级高管的工作邮箱，并实时发送提醒到 me@company.com”。它会在同一请求中被解析为下方字段（detection_mode、signal_types、signal_filters、people_enrichment_configs、destination_type/destination_config、frequency_minute）。你显式传入的任何字段都会覆盖解析出的值。若文本并非监控请求，将返回 400。最长 2000 个字符。" }, "deep": { "type": "boolean", "description": "可选，仅与 `query` 一起使用。运行反思校验以提高解析准确度（默认 true；解析延迟约翻倍）。设为 false 可获得更快的单次解析。" } }, "anyOf": [ { "title": "自然语言", "required": [ "query" ] }, { "title": "结构化字段", "required": [ "name", "detection_mode", "signal_types", "destination_type", "destination_config" ] }, { "title": "草稿", "required": [ "name", "status" ] } ] } } } }, "operationId": "monitors_create", "summary": "创建监控", "description": "创建数据监控：一个持续运行的监视器，从你定义的公司和筛选条件中实时发现你关注的业务信号（新的招聘信息、新闻、广告或市场扩张动向），为每条匹配结果补充公司与联系人数据，并按你设定的频率发送到你的目的地（邮箱或 Webhook）。你可以逐字段配置，也可以传入 `query` 用一句自然语言描述整个监控，它会在同一请求中被解析为完整配置。", "tags": [ "Monitor" ] } }, "/monitors/interpret": { "post": { "operationId": "interpretMonitor", "summary": "通过自然语言解析监控", "description": "在正式创建之前预览监控——将自然语言请求（可用任意语言）转换为经过校验的**草稿**监控配置，供你查看、调整后再提交到 [创建监控](/cn/api-reference/endpoint/monitors/create)。可以随意多次调用：它只生成草稿，绝不会保存监控、发送提醒或消耗额度。通过 `intent` 指定操作；若省略，将使用英文关键词启发式判断，无法识别时默认为 `create_monitor`。", "tags": [ "Monitor" ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "query" ], "properties": { "query": { "type": "string", "maxLength": 2000, "description": "自然语言请求（任意语言），例如“监控进入日本市场的公司，获取 C 级高管的工作邮箱，并实时发送提醒到 me@company.com”。最长 2000 个字符。" }, "intent": { "type": "string", "enum": [ "create_monitor", "dry_test", "execute", "analyze" ], "description": "要执行的操作（与语言无关）。`create_monitor`（默认）：返回草稿配置。`dry_test`：草稿加上当前匹配信号数量的只读统计。`execute`：草稿加预览，并标记为需确认（绝不自动启用）。`analyze`（例如“新加坡还是日本？”）：由扩张分析代理回答，而非创建监控。若省略，将使用英文关键词启发式；无法识别时默认为 `create_monitor`。" }, "deep": { "type": "boolean", "description": "运行反思校验以提高准确度（默认 true；延迟约翻倍）。设为 false 可获得更快的单次解析。" } } }, "example": { "query": "monitor companies expanding into Japan, get C-level people with their work email, and email alerts to me@company.com in real time" } } } }, "responses": { "200": { "description": "解析得到的草稿。不会保存任何内容。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "intent": { "type": "string", "enum": [ "create_monitor", "dry_test", "execute", "analyze" ], "description": "解析出的操作（create_monitor / dry_test / execute / analyze）。" }, "no_intent": { "type": "boolean", "description": "当请求并非监控设置（问候、离题、无意义）时为 true；此时 `config` 为 null。" }, "config": { "type": "object", "nullable": true, "description": "草稿监控配置，其结构与 [创建监控](/cn/api-reference/endpoint/monitors/create) 的请求体完全一致（detection_mode、signal_types、signal_filters、people_enrichment_configs、destination_type/destination_config、frequency_minute、status 为 \"draft\" 等）。提交到创建监控即可启用。可能包含 `domains`/`linkedin_urls`/`company_names`，创建监控会将其解析为公司。当 `no_intent` 为 true 时为 null。" }, "missing_fields": { "type": "array", "items": { "type": "string" }, "description": "在监控启用前仍需补齐的字段（例如 \"destination\"、\"signal_types\"、\"companies\"）。请在界面中收集后再提交到创建监控。" }, "requires_confirmation": { "type": "boolean", "description": "当 intent 为 `execute` 时为 true——配置已就绪，但需用户确认后你才可启用。" }, "preview": { "type": "object", "nullable": true, "description": "在 `dry_test` 与 `execute` 时出现：对过去 30 天内当前匹配信号数量的只读估算（按信号类型，采样）。不消耗额度。" }, "interpretation": { "type": "object", "description": "从查询中提取的原始字段回显，用于展示或调试。" } } } } }, "example": { "data": { "intent": "create_monitor", "no_intent": false, "config": { "detection_mode": "signal_first", "signal_types": [ "expansions" ], "signal_filters": [ { "signal_type": "expansions", "filters": { "tos": [ "JP" ], "stages": [ "exploring", "committing" ] } } ], "company_filters": {}, "companies": [], "is_company_enrichment": false, "is_people_enrichment": true, "people_enrichment_configs": [ { "max_people_to_return": 5, "filters": { "management_levels": [ "c_suite" ] }, "people_contact_types": [ "email-work" ] } ], "name": "Expansion signals → JP", "destination_type": "email", "destination_config": { "emails": [ "me@company.com" ] }, "frequency_minute": 5, "status": "draft" }, "missing_fields": [], "requires_confirmation": false, "preview": null, "interpretation": { "signal_types": [ "expansions" ], "tos": [ "JP" ], "management_levels": [ "c_suite" ], "people_contact_types": [ "email-work" ], "destination_email": "me@company.com", "is_realtime": true } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/monitors/update": { "post": { "responses": { "200": { "description": "成功响应，包含更新后的监控。响应始终包含 monitor_id、name、detection_mode、destination_type、status、masked_signature 和 last_modified，以及本次更新涉及的其他列。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "监控的唯一标识符。" }, "name": { "type": "string", "description": "监控名称。" }, "detection_mode": { "type": "string", "description": "检测模式。" }, "destination_type": { "type": "string", "description": "投递目标类型。" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "监控的生命周期状态。" }, "masked_signature": { "type": "string", "description": "已遮罩的 webhook 签名。" }, "last_modified": { "type": "string", "format": "date-time", "description": "监控最后修改的时间戳。" } }, "description": "The updated monitor. Any other columns included in the update are also returned." } } }, "example": { "data": { "monitor_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Updated Monitor Name", "detection_mode": "company_first", "destination_type": "webhook", "status": "active", "masked_signature": "9••••••••••••••••f09", "last_modified": "2026-04-05T21:00:00.000Z" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "要更新的监控唯一标识符。" }, "name": { "type": "string", "description": "监控名称。" }, "description": { "type": "string", "description": "监控描述。" }, "detection_mode": { "type": "string", "description": "信号的侦测方式。`signal_first` 面向市场广泛扫描；`company_first` 跟踪指定的客户名单，且至少需要一个公司、域名或 LinkedIn URL。**创建后不可修改** —— 对已有监控修改该字段会返回 `40021`，请改为新建监控。", "enum": [ "company_first", "signal_first" ] }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "jobs", "news", "advertisements", "expansions" ] }, "description": "要监控的信号类型。" }, "signal_filters": { "type": "array", "items": { "type": "object", "required": [ "signal_type" ], "properties": { "signal_type": { "type": "string", "enum": [ "jobs", "news", "advertisements", "expansions" ], "description": "该条目筛选的信号流。" }, "filters": { "type": "object", "description": "该信号流的筛选条件。`jobs`、`news` 与 `advertisements` 使用 [Job Search](/cn/api-reference/endpoint/companies/job_search)、[News Search](/cn/api-reference/endpoint/companies/news_search) 与 [Advertisement Search](/cn/api-reference/endpoint/companies/advertisements_search) 的参数。`expansions` 使用 [Expansion Search](/cn/api-reference/endpoint/expansions/market_lookup) 的词汇：`froms` / `tos`、`window_days`、`stages`、`scopes`、`momentum`、`freshness`、`signal_types`、`signal_subtypes`、`signal_strengths`、`source_types`。slug 取值见 [Expansion Reference](/cn/api-reference/endpoint/expansions/types)。" } } }, "description": "监控所观察的每个信号流对应一条。", "example": [ { "signal_type": "jobs", "filters": { "locations": [ "US" ] } }, { "signal_type": "news", "filters": { "locations": [ "US" ] } }, { "signal_type": "advertisements", "filters": { "target_locations": [ "US" ] } }, { "signal_type": "expansions", "filters": { "tos": [ "US" ], "stages": [ "expanding", "scaling" ], "signal_types": [ "HIRE", "EXEC" ], "signal_strengths": [ "high", "very_high" ] } } ] }, "company_filters": { "type": "object", "description": "全局公司过滤器，作为第二层应用。接受与[Company Search](/cn/api-reference/endpoint/companies/search)端点相同的参数 — locations、employees、technologies、verticals 等。", "example": { "locations": [ "US" ], "employees": [ [ 501, 1000 ], [ 1001, 5000 ] ] } }, "companies": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "公司 domain_search_id UUID 列表。也可使用 `domains` 或 `linkedin_urls` 作为替代方式。" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "公司域名列表。可作为 `companies` 的替代方式。" }, "linkedin_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "LinkedIn 公司主页 URL 列表。可作为 `companies` 的替代方式。" }, "is_company_enrichment": { "type": "boolean", "description": "是否增强公司数据。" }, "is_people_enrichment": { "type": "boolean", "description": "是否增强人员数据。" }, "people_enrichment_configs": { "type": "array", "items": { "type": "object" }, "description": "人员增强层数组。每层执行独立的人员搜索。包含 `max_people_to_return`（1-25）、`people_contact_types`（联系类型数组，参见 [Redeem](/cn/api-reference/endpoint/redeem/people) 端点：email-work、email-personal、phone）和 `filters`（与[People Search](/cn/api-reference/endpoint/people/search)端点相同的参数）。详见人员搜索端点了解可用过滤器，Redeem 端点了解联系类型。", "example": [ { "filters": { "people_locations": [ "US" ] }, "max_people_to_return": 3, "people_contact_types": [ "email-work" ] } ] }, "destination_type": { "type": "string", "description": "投递目标类型。", "enum": [ "webhook", "email", "sequences" ] }, "destination_config": { "type": "object", "description": "目标配置。Webhook：需要 `webhook_url`（字符串），可选 `headers`（对象）和 `body`（对象）。Email：接受 `email`（字符串）或 `emails`（字符串数组）。sequences 类型需要 `sequence_identifier`（字符串），并且 `is_people_search_enrolled` / `is_company_contact_enrolled` 至少有一个设为 true。", "example": { "webhook_url": "https://your-webhook.com/endpoint", "headers": { "Authorization": "Bearer token" }, "body": { "pipeline": "my-webhook" } } }, "frequency_minute": { "type": "integer", "description": "触发频率（分钟）。最小值：0，最大值：10080，默认值：0。", "minimum": 0, "maximum": 10080 }, "max_failure_trigger": { "type": "integer", "description": "暂停前的最大连续失败次数。最小值：1，最大值：10，默认值：5。", "minimum": 1, "maximum": 10 }, "max_daily_trigger": { "type": "integer", "description": "每日最大触发次数。最小值：0，最大值：86400，默认值：500。", "minimum": 0, "maximum": 86400 }, "max_records_per_trigger": { "type": "integer", "description": "控制每次触发最多推送的记录数量。较低的值可减少每次推送的数据量，适用于结果集较大或下游系统有速率限制的场景。最小值：1，最大值：100，默认值：25。详情请参阅 [配置 Webhooks](/cn/developer-guides/setting-up-webhooks)。", "minimum": 1, "maximum": 100 }, "notification_email": { "type": "string", "format": "email", "description": "失败通知邮箱。" }, "max_retry_per_trigger": { "type": "integer", "description": "每次触发的最大重试次数。最小值：0，最大值：3，默认值：1。", "minimum": 0, "maximum": 3 }, "retry_delay_second": { "type": "integer", "description": "重试间隔（秒）。最小值：1，最大值：5，默认值：1。", "minimum": 1, "maximum": 5 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "要设置的生命周期状态。变更状态会重置失败计数器。" } }, "required": [ "monitor_id" ] } } } }, "operationId": "monitors_update", "summary": "更新监控", "description": "更新现有监控的配置和检测规则。", "tags": [ "Monitor" ] } }, "/monitors/duplicate": { "post": { "responses": { "200": { "description": "成功响应，包含复制后的监控。返回完整的监控配置（signal_types、signal_filters、company_filters、companies、增强设置、投递目标、触发限制），以及为副本新生成的 `signature`。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "复制后监控的唯一标识符。" }, "name": { "type": "string", "description": "复制后监控的名称。" }, "description": { "type": "string", "description": "复制后监控的描述。" }, "detection_mode": { "type": "string", "description": "检测模式。" }, "destination_type": { "type": "string", "description": "投递目标类型。" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "复制后监控的生命周期状态。" }, "masked_signature": { "type": "string", "description": "已遮罩的 webhook 签名。" }, "created_at": { "type": "string", "format": "date-time", "description": "副本创建的时间戳。" }, "signature": { "type": "string", "format": "uuid", "description": "复制后监控的 webhook 签名。" } }, "description": "The duplicated monitor. The full configuration (signal_types, signal_filters, company_filters, companies, enrichment settings, destination_config, trigger limits) is also returned." } } }, "example": { "data": { "monitor_id": "e5f6a7b8-c9d0-1234-efab-345678901234", "name": "My Monitor (Copy)", "description": "Monitors news and job signals for target companies", "detection_mode": "signal_first", "destination_type": "webhook", "status": "active", "masked_signature": "7••••••••••••••••8df", "created_at": "2026-04-05T21:15:00.000Z", "signature": "f6a7b8c9-d0e1-2345-fabc-456789012345" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "要复制的监控唯一标识符。" }, "name": { "type": "string", "description": "复制后监控的名称。省略时，副本命名为 \"<原名称> <副本后缀>\"——即在原名称后追加默认的副本后缀。" } }, "required": [ "monitor_id" ] } } } }, "operationId": "monitors_duplicate", "summary": "复制监控", "description": "创建具有相同配置的现有监控的副本。", "tags": [ "Monitor" ] } }, "/monitors/delete": { "delete": { "responses": { "200": { "description": "成功响应。监控已被删除。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "description": "删除成功时返回 null。" } } }, "example": { "data": null } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "要删除的监控唯一标识符。" } }, "required": [ "monitor_id" ] } } } }, "operationId": "monitors_delete", "summary": "删除监控", "description": "从工作区中删除监控。", "tags": [ "Monitor" ] } }, "/monitors/lookup": { "post": { "responses": { "200": { "description": "成功响应，包含完整的监控详情，包括配置和目标设置。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "监控的唯一标识符。" }, "profile_id": { "type": "integer", "description": "配置文件标识符。" }, "user_id": { "type": "string", "description": "用户标识符。" }, "name": { "type": "string", "description": "监控名称。" }, "description": { "type": "string", "description": "监控描述。" }, "detection_mode": { "type": "string", "description": "检测模式。" }, "signal_types": { "type": "array", "items": { "type": "string" }, "description": "监控的信号类型。" }, "signal_filters": { "type": "array", "items": { "type": "object" }, "description": "信号过滤器配置。" }, "company_filters": { "type": "object", "description": "公司过滤器配置。" }, "companies": { "type": "array", "items": { "type": "string" }, "description": "公司标识符。" }, "is_company_enrichment": { "type": "boolean", "description": "公司增强是否已启用。" }, "is_people_enrichment": { "type": "boolean", "description": "人员增强是否已启用。" }, "people_enrichment_configs": { "type": "array", "items": { "type": "object" }, "description": "人员增强配置。" }, "destination_type": { "type": "string", "description": "投递目标类型。" }, "destination_config": { "type": "object", "description": "完整的目标配置详情。" }, "frequency_minute": { "type": "integer", "description": "触发频率（分钟）。" }, "max_retry_per_trigger": { "type": "integer", "description": "每次触发的最大重试次数。" }, "max_records_per_trigger": { "type": "integer", "description": "每次触发的最大记录数。" }, "retry_delay_second": { "type": "integer", "description": "重试间隔（秒）。" }, "max_daily_trigger": { "type": "integer", "description": "每日最大触发次数。" }, "max_failure_trigger": { "type": "integer", "description": "暂停前的最大连续失败次数。" }, "masked_signature": { "type": "string", "description": "已遮罩的 webhook 签名。" }, "signature": { "type": "string", "format": "uuid", "description": "完整的 webhook 签名。仅在 is_signature_reveal 为 true 时包含。" }, "repeated_failure_count": { "type": "integer", "description": "当前连续失败次数。" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "inactive" ], "description": "监控的生命周期状态。" }, "language_code": { "type": "string", "nullable": true, "description": "渲染此监控投递内容所用的语言代码。" }, "notification_email": { "type": "string", "description": "通知邮箱地址。" }, "last_trigger_at": { "type": "string", "format": "date-time", "nullable": true, "description": "最后一次触发的时间戳。" }, "last_processed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "最后一次处理完成的时间戳。" }, "created_at": { "type": "string", "format": "date-time", "description": "监控创建的时间戳。" }, "last_modified": { "type": "string", "format": "date-time", "description": "监控最后修改的时间戳。" }, "last_processed": { "type": "string", "format": "date-time", "nullable": true, "description": "最后一次处理事件的时间戳。" }, "user": { "type": "object", "properties": { "user_id": { "type": "string", "description": "创建监控的用户标识符。" }, "nickname": { "type": "string", "description": "用户显示名称。" }, "email": { "type": "string", "description": "用户邮箱。" } }, "description": "创建监控的用户。" } } } } }, "example": { "data": { "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "profile_id": 1, "user_id": "a1b2c3d4-0000-0000-0000-000000000000", "name": "Signal First Monitor", "description": "Tracking AI job postings", "detection_mode": "signal_first", "signal_types": [ "jobs", "news", "advertisements" ], "signal_filters": [ { "filters": { "locations": [ "US" ], "titles": [ "AI Engineer" ] }, "signal_type": "jobs" }, "..." ], "company_filters": { "locations": [ "US" ], "employees": [ [ 501, 1000 ] ], "...": "..." }, "companies": [ "67c4696b-b7b0-46b5-b2af-9f434543661e" ], "is_company_enrichment": true, "is_people_enrichment": true, "people_enrichment_configs": [ { "filters": { "management_levels": [ "founder", "vp" ], "...": "..." }, "max_people_to_return": 25, "people_contact_types": [ "email-work", "email-personal", "phone" ] } ], "destination_type": "webhook", "destination_config": { "webhook_url": "https://usewebhook.com/example", "headers": { "X-Custom-Auth": "your-token" }, "body": { "source": "pubrio" } }, "frequency_minute": 0, "notification_email": "team@example.com", "max_retry_per_trigger": 2, "max_records_per_trigger": 10, "retry_delay_second": 5, "max_daily_trigger": 500, "masked_signature": "7••••••••••••••••8df", "signature": "710a69f6-aaaf-449d-b3f6-78ba66d648df", "repeated_failure_count": 0, "status": "active", "language_code": "en", "max_failure_trigger": 5, "last_processed_at": null, "last_trigger_at": null, "created_at": "2026-04-05T20:30:17.792Z", "last_modified": "2026-04-05T20:30:17.792Z", "last_processed": null, "user": { "user_id": "a1b2c3d4-0000-0000-0000-000000000000", "nickname": "Jane Smith", "email": "jane@example.com" } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "要查找的监控唯一标识符。" }, "is_signature_reveal": { "type": "boolean", "description": "设为 true 时，响应中将包含完整的 webhook 签名。默认为 false。", "default": false } }, "required": [ "monitor_id" ] } } } }, "operationId": "monitors_lookup", "summary": "查找监控", "description": "获取特定监控的详细信息。", "tags": [ "Monitor" ] } }, "/monitors/signature/reveal": { "post": { "responses": { "200": { "description": "成功响应，包含监控的完整 webhook 签名。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "监控的唯一标识符。" }, "signature": { "type": "string", "format": "uuid", "description": "用于验证负载的完整 webhook 签名。" } } } } }, "example": { "data": { "monitor_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "signature": "d4e5f6a7-b8c9-0123-defa-234567890123" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "监控的唯一标识符。" } }, "required": [ "monitor_id" ] } } } }, "operationId": "monitors_reveal_signature", "summary": "显示监控 Webhook 签名", "description": "获取监控的 Webhook 签名密钥。", "tags": [ "Monitor" ] } }, "/monitors/webhook/validate": { "post": { "responses": { "200": { "description": "成功响应，包含 webhook 验证结果——目标配置以及测试请求/响应负载。webhook 失败时端点返回 400（MONITOR_WEBHOOK_URL_INVALID），错误详情中附带 webhook 的响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "destination_config": { "type": "object", "description": "被测试的目标配置。" }, "request_payload": { "type": "object", "description": "验证期间发送到 webhook 的请求负载。" }, "response_payload": { "type": "object", "description": "从 webhook 接收到的响应负载。" } } } } }, "example": { "data": { "destination_config": { "webhook_url": "https://usewebhook.com/example", "headers": { "X-Custom-Auth": "your-token" }, "body": { "source": "pubrio" } }, "request_payload": { "monitor": { "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "My Monitor", "detection_mode": "signal_first", "signal_types": [ "jobs", "news", "advertisements" ], "signal_filters": [ "..." ], "company_filters": { "...": "..." }, "is_company_enrichment": true, "is_people_enrichment": true, "people_enrichment_configs": [ "..." ] }, "metadata": { "total_signals": 3, "total_companies": 1, "total_people": 0 }, "triggered_at": "2026-04-05T22:43:06.973Z", "signals": [ { "signal_type": "jobs", "signal": { "signal_type": "jobs", "job_search_id": "...", "companies": [ "..." ] }, "companies": [ "..." ] }, "..." ], "source": "pubrio" }, "response_payload": "OK" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitor_id": { "type": "string", "format": "uuid", "description": "现有监控的唯一标识符（用于测试）。测试新配置时为可选。" }, "name": { "type": "string", "description": "监控名称。" }, "description": { "type": "string", "description": "监控描述。" }, "detection_mode": { "type": "string", "description": "信号的侦测方式。`signal_first` 面向市场广泛扫描；`company_first` 跟踪指定的客户名单，且至少需要一个公司、域名或 LinkedIn URL。**创建后不可修改** —— 对已有监控修改该字段会返回 `40021`，请改为新建监控。", "enum": [ "company_first", "signal_first" ] }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "jobs", "news", "advertisements", "expansions" ] }, "description": "要监控的信号类型。" }, "signal_filters": { "type": "array", "items": { "type": "object", "required": [ "signal_type" ], "properties": { "signal_type": { "type": "string", "enum": [ "jobs", "news", "advertisements", "expansions" ], "description": "该条目筛选的信号流。" }, "filters": { "type": "object", "description": "该信号流的筛选条件。`jobs`、`news` 与 `advertisements` 使用 [Job Search](/cn/api-reference/endpoint/companies/job_search)、[News Search](/cn/api-reference/endpoint/companies/news_search) 与 [Advertisement Search](/cn/api-reference/endpoint/companies/advertisements_search) 的参数。`expansions` 使用 [Expansion Search](/cn/api-reference/endpoint/expansions/market_lookup) 的词汇：`froms` / `tos`、`window_days`、`stages`、`scopes`、`momentum`、`freshness`、`signal_types`、`signal_subtypes`、`signal_strengths`、`source_types`。slug 取值见 [Expansion Reference](/cn/api-reference/endpoint/expansions/types)。" } } }, "description": "监控所观察的每个信号流对应一条。", "example": [ { "signal_type": "jobs", "filters": { "locations": [ "US" ] } }, { "signal_type": "news", "filters": { "locations": [ "US" ] } }, { "signal_type": "advertisements", "filters": { "target_locations": [ "US" ] } }, { "signal_type": "expansions", "filters": { "tos": [ "US" ], "stages": [ "expanding", "scaling" ], "signal_types": [ "HIRE", "EXEC" ], "signal_strengths": [ "high", "very_high" ] } } ] }, "company_filters": { "type": "object", "description": "全局公司过滤器。接受与[Company Search](/cn/api-reference/endpoint/companies/search)端点相同的参数。", "example": { "locations": [ "US" ], "employees": [ [ 501, 1000 ], [ 1001, 5000 ] ] } }, "companies": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "要监控的公司 domain_search_id UUID 列表。也可使用 `domains` 或 `linkedin_urls` 作为替代方式。" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "公司域名列表。`companies` 的替代方式。" }, "linkedin_urls": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "LinkedIn 公司网址列表。`companies` 的替代方式。" }, "is_company_enrichment": { "type": "boolean", "description": "是否增强公司数据。" }, "is_people_enrichment": { "type": "boolean", "description": "是否增强人员数据。" }, "people_enrichment_configs": { "type": "array", "items": { "type": "object" }, "description": "人员增强层数组。包含 `max_people_to_return`（1-25）、`people_contact_types`（参见 [Redeem](/cn/api-reference/endpoint/redeem/people)）和 `filters`（参见 [People Search](/cn/api-reference/endpoint/people/search)）。", "example": [ { "filters": { "people_locations": [ "US" ] }, "max_people_to_return": 3, "people_contact_types": [ "email-work" ] } ] }, "destination_type": { "type": "string", "description": "投递目标类型。", "enum": [ "webhook", "email", "sequences" ] }, "destination_config": { "type": "object", "description": "目标配置。Webhook：需要 `webhook_url`（字符串），可选 `headers`（对象）和 `body`（对象）。Email：接受 `email`（字符串）或 `emails`（字符串数组）。sequences 类型需要 `sequence_identifier`（字符串），并且 `is_people_search_enrolled` / `is_company_contact_enrolled` 至少有一个设为 true。", "example": { "webhook_url": "https://your-webhook.com/endpoint", "headers": { "Authorization": "Bearer token" }, "body": { "pipeline": "my-webhook" } } }, "frequency_minute": { "type": "integer", "description": "触发频率（分钟）。最小值：0，最大值：10080。", "minimum": 0, "maximum": 10080 }, "max_failure_trigger": { "type": "integer", "description": "暂停前的最大连续失败次数。最小值：1，最大值：10。", "minimum": 1, "maximum": 10 }, "max_daily_trigger": { "type": "integer", "description": "每日最大触发次数。最小值：0，最大值：86400。", "minimum": 0, "maximum": 86400 }, "max_records_per_trigger": { "type": "integer", "description": "控制每次触发最多推送的记录数量。较低的值可减少每次推送的数据量，适用于结果集较大或下游系统有速率限制的场景。最小值：1，最大值：100，默认值：25。详情请参阅 [配置 Webhooks](/cn/developer-guides/setting-up-webhooks)。", "minimum": 1, "maximum": 100 }, "notification_email": { "type": "string", "format": "email", "description": "失败通知邮箱。" }, "max_retry_per_trigger": { "type": "integer", "description": "每次触发的最大重试次数。最小值：0，最大值：3。", "minimum": 0, "maximum": 3 }, "retry_delay_second": { "type": "integer", "description": "重试间隔（秒）。最小值：1，最大值：5。", "minimum": 1, "maximum": 5 } }, "required": [ "destination_config" ] } } } }, "operationId": "monitors_validate_webhook", "summary": "验证监控 Webhook", "description": "向 Webhook URL 发送一个带签名的测试负载，并返回其是否被接受。\n\n**这是一次真实的 HTTP 投递**，而非 URL 格式校验。接收端必须接受 `POST` 并正确响应 —— 仅在 `GET` 时能返回页面的 URL 仍会失败。失败时会返回 `40023`（URL 无效或无法访问）或 `40022`（测试投递失败），且 `details` 会携带上游的原始响应体，可能是数 KB 的 HTML。传入 `monitor_id` 可使用该监控的真实签名进行签名；不传则使用占位签名。", "tags": [ "Monitor" ] } }, "/companies/news/languages": { "get": { "responses": { "200": { "description": "包含新闻语言详情的成功响应。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/data_array" } } }, "example": { "data": [ { "news_language_id": "77bb2cd2-fbea-4cd1-b860-78786c6b2343", "slug": "ar", "locale_code": "ar", "name": "Arabic", "name_en": "Arabic" }, "..." ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "parameters": [], "operationId": "filters_list_news_languages", "summary": "列出新闻语言", "description": "获取可用于新闻筛选的语言列表。", "tags": [ "Filters" ] } }, "/api_keys/logs": { "post": { "tags": [ "API Keys" ], "summary": "获取 API 请求日志列表", "description": "获取当前工作区的 API 请求日志分页列表。每条记录对应一次使用 `pubrio-api-key` 调用的请求，包含路径、方法、状态码、耗时、响应大小和消耗的积分。如需查看某条日志的完整请求和响应内容，请使用 [日志详情查询](/cn/api-reference/endpoint/api-keys/logs_lookup) 接口。", "operationId": "api_keys_get_logs", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/page" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "order_by": { "type": "string", "enum": [ "created_at", "duration_ms", "status_code" ], "default": "created_at", "description": "日志列表的排序字段。" }, "is_ascending_order": { "type": "boolean", "default": false, "description": "排序方向。`true` 为升序，`false`（默认）为降序。" }, "search_term": { "type": "string", "description": "全文搜索，匹配请求路径、日志类型 slug 以及原始请求体内容。" }, "log_types": { "type": "array", "items": { "type": "integer" }, "description": "按日志类型 ID 筛选。" }, "log_type_slugs": { "type": "array", "items": { "type": "string" }, "description": "按日志类型 slug 筛选（如 `people_search`、`company_search`）。" }, "status_codes": { "type": "array", "items": { "type": "integer" }, "description": "按 HTTP 状态码筛选（如 `[200, 400, 500]`）。" }, "methods": { "type": "array", "items": { "type": "string" }, "description": "按 HTTP 方法筛选（如 `[\"POST\", \"GET\"]`）。" } } } } } }, "responses": { "200": { "description": "成功响应，返回分页的 API 请求日志。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "filters": { "type": "object", "description": "本次响应所使用请求过滤条件的回显，已剔除空值。", "additionalProperties": true } } }, "data": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer", "description": "当前页码。" }, "per_page": { "type": "integer", "description": "每页结果数。" }, "total_entries": { "type": "integer", "description": "日志条目总数。" }, "total_pages": { "type": "integer", "description": "总页数。" }, "total_display_pages": { "type": "integer", "description": "当前订阅可显示的最大页数。" }, "is_timeout": { "type": "boolean", "description": "总数查询是否超时。" } } }, "query_logs": { "type": "array", "items": { "type": "object", "properties": { "query_log_id": { "type": "string", "format": "uuid", "description": "日志条目唯一标识符，传入 `/api_keys/logs/lookup` 可获取完整内容。" }, "created_at": { "type": "string", "description": "请求接收时间（UTC）。" }, "profile_id": { "type": "integer", "description": "请求关联的工作区配置 ID。" }, "user_id": { "type": "string", "format": "uuid", "description": "API 密钥所属用户的 ID。" }, "method": { "type": "string", "description": "请求的 HTTP 方法。" }, "path": { "type": "string", "description": "请求路径。" }, "status_code": { "type": "integer", "description": "返回的 HTTP 状态码。" }, "duration_ms": { "type": "integer", "description": "请求处理耗时（毫秒）。" }, "log_type_id": { "type": "integer", "description": "内部日志类型 ID。如果请求未对应到计费日志类型则为 `0`。" }, "log_type_slug": { "type": "string", "nullable": true, "description": "日志类型 slug（如 `people_search`），未计费请求为 `null`。" }, "log_type_name": { "type": "string", "nullable": true, "description": "可读的日志类型名称。" }, "authentication_type": { "type": "string", "description": "使用的认证方式。API 密钥请求始终为 `pubrio-api-key`。" }, "authentication_type_name": { "type": "string", "description": "可读的认证方式名称。" }, "masked_authentication": { "type": "string", "description": "本次请求所用 API 密钥的掩码表示。" }, "response_size": { "type": "integer", "description": "响应体大小（字节）。" }, "credits": { "type": "number", "description": "本次请求扣除的总积分。" }, "ip": { "type": "string", "description": "调用方的客户端 IP 地址。" }, "email": { "type": "string", "description": "API 密钥所属用户的邮箱。" }, "nickname": { "type": "string", "description": "API 密钥所属用户的昵称。" }, "user": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "nickname": { "type": "string" }, "email": { "type": "string" } } } } } } } } } }, "example": { "metadata": { "filters": { "page": 1, "per_page": 3, "status_codes": [ 200 ] } }, "data": { "pagination": { "page": 1, "per_page": 3, "total_entries": 1109, "total_pages": 370, "total_display_pages": 250, "is_timeout": false }, "query_logs": [ { "query_log_id": "fc1ce3dd-39f7-4fbd-9d22-569a17115c11", "created_at": "2026-05-14 12:04:32.243", "profile_id": 1, "user_id": "2981d4b3-f8b1-44d8-9759-889f3bfa2faf", "method": "POST", "path": "/api_keys/usage/daily", "status_code": 200, "duration_ms": 1821, "log_type_id": 0, "authentication_type": "pubrio-api-key", "masked_authentication": "0••••••••••••••••f39", "response_size": 2180, "ip": "127.0.0.1", "email": "you@example.com", "nickname": "Example User", "user": { "user_id": "2981d4b3-f8b1-44d8-9759-889f3bfa2faf", "nickname": "Example User", "email": "you@example.com" }, "log_type_slug": null, "credits": 0, "log_type_name": null, "authentication_type_name": "API Key" } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/api_keys/logs/lookup": { "post": { "tags": [ "API Keys" ], "summary": "查询 API 请求日志详情", "description": "查询某条 API 请求日志的完整请求体、请求头、响应体和响应大小。可在请求列表中获取 `query_log_id` 后通过此接口查看具体内容。", "operationId": "api_keys_lookup_log", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "query_log_id" ], "properties": { "query_log_id": { "type": "string", "format": "uuid", "description": "要查询的日志条目唯一标识符，可通过 `/api_keys/logs` 获取。" } } } } } }, "responses": { "200": { "description": "成功响应，返回完整的请求和响应内容。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "query_log_id": { "type": "string", "format": "uuid", "description": "本次查询的日志条目标识符。" } } }, "data": { "type": "object", "nullable": true, "properties": { "query_log_id": { "type": "string", "format": "uuid", "description": "日志条目的标识符。" }, "request_body": { "type": "string", "nullable": true, "description": "原始请求体的 JSON 字符串。" }, "request_headers": { "type": "string", "nullable": true, "description": "原始请求头的 JSON 字符串，API 密钥等敏感请求头会进行掩码处理。" }, "response_body": { "type": "string", "nullable": true, "description": "返回给调用方的响应体 JSON 字符串。" }, "response_size": { "type": "integer", "description": "响应体大小（字节）。" } } } } }, "example": { "metadata": { "query_log_id": "fc1ce3dd-39f7-4fbd-9d22-569a17115c11" }, "data": { "query_log_id": "fc1ce3dd-39f7-4fbd-9d22-569a17115c11", "request_body": "{\"start_date\":\"2026-05-01\",\"end_date\":\"2026-05-14\"}", "request_headers": "{\"host\":\"api.pubrio.com\",\"user-agent\":\"curl/8.7.1\",\"accept\":\"*/*\",\"pubrio-api-key\":\"***\",\"content-type\":\"application/json\",\"content-length\":\"51\"}", "response_body": "{\"metadata\":{\"filters\":{\"start_date\":\"2026-05-01\",\"end_date\":\"2026-05-14\"}},\"data\":{\"series\":[...],\"by_log_type\":[...],\"totals\":{\"credits\":41892,\"requests\":4896}}}", "response_size": 2346 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/api_keys/usage/daily": { "post": { "tags": [ "API Keys" ], "summary": "获取每日 API 使用情况", "description": "按日期范围获取当前工作区每日的 API 请求数与积分消耗，返回数据包含每日汇总时间序列以及按端点拆分的堆叠序列，便于绘制使用情况图表。", "operationId": "api_keys_get_usage_daily", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "start_date", "end_date" ], "properties": { "start_date": { "type": "string", "example": "2026-05-01", "description": "日期范围起始日，格式为 `YYYY-MM-DD`，使用工作区时区。" }, "end_date": { "type": "string", "example": "2026-05-14", "description": "日期范围结束日，格式为 `YYYY-MM-DD`，使用工作区时区。" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "可选。按掩码 API 密钥标识符（如 `0••••••••••••••••f39`）筛选结果，可使用 `/api_keys` 接口或日志条目中 `masked_authentication` 字段的值。" }, "log_type_slugs": { "type": "array", "items": { "type": "string" }, "description": "可选。按日志类型 slug（如 `people_search`、`company_search`、`people_redeem`）筛选结果，将范围限定为指定的端点。" } } } } } }, "responses": { "200": { "description": "成功响应，返回每日使用量时间序列。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "filters": { "type": "object", "description": "本次响应所使用请求过滤条件的回显，已剔除空值。", "additionalProperties": true } } }, "data": { "type": "object", "properties": { "series": { "type": "array", "description": "所有端点的每日汇总，按日期升序排列。", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "日期，格式为 `YYYY-MM-DD`。" }, "credits": { "type": "number", "description": "当天消耗的积分。" }, "requests": { "type": "integer", "description": "当天的 API 请求数。" } } } }, "by_log_type": { "type": "array", "description": "按端点拆分的堆叠序列，按积分及请求数降序排列。", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "日志类型 slug。`__unknown__` 表示未对应到计费日志类型的请求。" }, "name": { "type": "string", "description": "可读的日志类型名称。" }, "totals": { "type": "object", "properties": { "credits": { "type": "number" }, "requests": { "type": "integer" } } }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "credits": { "type": "number" }, "requests": { "type": "integer" } } } } } } }, "totals": { "type": "object", "properties": { "credits": { "type": "number" }, "requests": { "type": "integer" } } } } } } }, "example": { "metadata": { "filters": { "start_date": "2026-05-01", "end_date": "2026-05-14" } }, "data": { "series": [ { "date": "2026-05-01", "credits": 26352, "requests": 2827 }, { "date": "2026-05-05", "credits": 798, "requests": 402 }, { "date": "2026-05-11", "credits": 187, "requests": 187 } ], "by_log_type": [ { "slug": "people_redeem", "name": "Redeem People", "totals": { "credits": 40835, "requests": 4083 }, "series": [ { "date": "2026-05-01", "credits": 26140, "requests": 2614 }, { "date": "2026-05-11", "credits": 185, "requests": 15 } ] }, { "slug": "people_search", "name": "People Search", "totals": { "credits": 633, "requests": 212 }, "series": [ { "date": "2026-05-05", "credits": 594, "requests": 199 } ] } ], "totals": { "credits": 41892, "requests": 4896 } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/api_keys/usage/breakdown": { "post": { "tags": [ "API Keys" ], "summary": "按密钥和端点获取 API 使用情况明细", "description": "按时间范围获取 API 请求数与积分消耗的拆分明细，分别按 API 密钥（`by_key`）和端点（`by_endpoint`）分组，便于识别使用最频繁的密钥与消耗最多积分的端点。", "operationId": "api_keys_get_usage_breakdown", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "start_date", "end_date" ], "properties": { "start_date": { "type": "string", "example": "2026-05-01", "description": "日期范围起始日，格式为 `YYYY-MM-DD`，使用工作区时区。" }, "end_date": { "type": "string", "example": "2026-05-14", "description": "日期范围结束日，格式为 `YYYY-MM-DD`，使用工作区时区。" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "可选。按掩码 API 密钥标识符（如 `0••••••••••••••••f39`）筛选结果，可使用 `/api_keys` 接口或日志条目中 `masked_authentication` 字段的值。" }, "log_type_slugs": { "type": "array", "items": { "type": "string" }, "description": "可选。按日志类型 slug（如 `people_search`、`company_search`、`people_redeem`）筛选结果，将范围限定为指定的端点。" } } } } } }, "responses": { "200": { "description": "成功响应，返回 API 使用情况明细。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "filters": { "type": "object", "description": "本次响应所使用请求过滤条件的回显，已剔除空值。", "additionalProperties": true } } }, "data": { "type": "object", "properties": { "by_key": { "type": "array", "description": "按 API 密钥分组的使用情况（最多 100 条，按积分及请求数降序排列）。", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "掩码后的 API 密钥标识符。" }, "requests": { "type": "integer", "description": "该密钥发起的请求数。" }, "credits": { "type": "number", "description": "该密钥消耗的积分。" }, "last_used": { "type": "string", "nullable": true, "description": "该密钥的最近一次请求时间，若在该范围内未使用则为 `null`。" }, "percent_of_requests": { "type": "number", "description": "占总请求数的百分比。" }, "percent_of_credits": { "type": "number", "description": "占总积分消耗的百分比。" } } } }, "by_endpoint": { "type": "array", "description": "按端点分组的使用情况（最多 100 条，按积分及请求数降序排列）。", "items": { "type": "object", "properties": { "slug": { "type": "string", "nullable": true, "description": "日志类型 slug。未对应到计费日志类型的请求为 `null`。" }, "name": { "type": "string", "description": "可读的日志类型名称。" }, "requests": { "type": "integer" }, "credits": { "type": "number" }, "cost_per_call": { "type": "number", "description": "该端点每次请求的平均积分消耗。" }, "percent_of_requests": { "type": "number", "description": "占总请求数的百分比。" }, "percent_of_credits": { "type": "number", "description": "占总积分消耗的百分比。" } } } }, "totals": { "type": "object", "properties": { "credits": { "type": "number" }, "requests": { "type": "integer" } } } } } } }, "example": { "metadata": { "filters": { "start_date": "2026-04-01", "end_date": "2026-05-14" } }, "data": { "by_key": [ { "name": "2••••••••••••••••a37", "requests": 929, "credits": 42766, "last_used": "2026-05-05 11:09:42.508", "percent_of_requests": 17.892, "percent_of_credits": 99.425 }, { "name": "0••••••••••••••••f39", "requests": 175, "credits": 187, "last_used": "2026-05-14 12:04:21.651", "percent_of_requests": 3.37, "percent_of_credits": 0.434 } ], "by_endpoint": [ { "slug": "people_redeem", "name": "Redeem People", "requests": 4088, "credits": 41215, "cost_per_call": 10.08, "percent_of_requests": 78.73, "percent_of_credits": 95.82 }, { "slug": "people_search", "name": "People Search", "requests": 368, "credits": 1101, "cost_per_call": 2.99, "percent_of_requests": 7.08, "percent_of_credits": 2.55 } ], "totals": { "credits": 43013, "requests": 5192 } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/companies/jobs/insights": { "post": { "tags": [ "Insights" ], "summary": "职位发布洞察", "description": "在某个日期窗口内，针对一家公司聚合的招聘信号洞察：发布量、资历分布、热门职能/部门/地点，以及按周的时间序列。", "operationId": "companies_jobs_insights", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "date_from": { "$ref": "#/components/schemas/date_from" }, "date_to": { "$ref": "#/components/schemas/date_to" } } } } } }, "responses": { "200": { "description": "该公司在指定时间窗口内的招聘洞察分组。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "所请求公司在指定时间窗口内的洞察分组。" } } }, "example": { "data": { "totals": { "open": 124, "new_in_window": 31, "functions": 6, "locations": 4 }, "seniority": { "classified": 28, "leadership": 5, "tiers": [ { "key": "leadership", "rank": 5, "count": 5 }, { "key": "senior", "rank": 3, "count": 12 } ] }, "postings": [ { "title": "Country Manager", "country_code": "GB", "posted_at": "2026-02-14" } ], "weekly_series": [ { "week_start": "2026-02-09", "count": 8 } ], "breakdown_function": [ { "key": "sales", "count": 11 }, { "key": "engineering", "count": 7 } ], "breakdown_department": [ { "key": "go_to_market", "count": 9 } ], "breakdown_location": [ { "key": "GB", "count": 14 } ], "window_days": 90 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/companies/news/insights": { "post": { "tags": [ "Insights" ], "summary": "新闻洞察", "description": "在某个日期窗口内，针对一家公司聚合的新闻信号洞察：提及量、热门话题与来源、类别与市场细分，以及按周的时间序列。", "operationId": "companies_news_insights", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "date_from": { "$ref": "#/components/schemas/date_from" }, "date_to": { "$ref": "#/components/schemas/date_to" } } } } } }, "responses": { "200": { "description": "该公司在指定时间窗口内的新闻洞察分组。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "所请求公司在指定时间窗口内的洞察分组。", "properties": { "totals": { "type": "object", "description": "该时间窗口内的核心计数。`mentions` 为文章数量；`topics` 与 `sources` 分别是*去重后*的分类数与发布方数量（为整数，而非列表）；`top_source` 是提及次数最多的发布方域名。按分类与按市场的明细分别位于 `category_breakdown` 与 `market_breakdown`。" } } } } }, "example": { "data": { "totals": { "mentions": 1785, "topics": 27, "sources": 140, "top_source": "shazoo.ru" }, "weekly_series": [ { "week_start": "2026-05-18", "count": 31 } ], "category_breakdown": [ { "key": "launches", "count": 681 } ], "market_breakdown": [ { "key": "US", "count": 297 } ], "window_days": 90 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/companies/advertisements/insights": { "post": { "tags": [ "Insights" ], "summary": "广告洞察", "description": "在某个日期窗口内，针对一家公司聚合的广告信号洞察：活跃及已投放的广告数量、渠道与版位组合、创意样本、以分层分布形式呈现的受众触达，以及按周的时间序列。触达以跨层级的分布形式报告，绝不会以单一汇总数字呈现。", "operationId": "companies_advertisements_insights", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "date_from": { "$ref": "#/components/schemas/date_from" }, "date_to": { "$ref": "#/components/schemas/date_to" }, "is_include_unlinked_companies": { "type": "boolean", "example": false, "description": "包含尚未关联到已验证公司资料的广告。" } } } } } }, "responses": { "200": { "description": "该公司在指定时间窗口内的广告洞察分组。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "所请求公司在指定时间窗口内的洞察分组。", "properties": { "postings": { "type": "array", "description": "广告投放量汇总，按覆盖层级、市场、渠道与格式分组。为压缩负载，字段名使用缩写：`r` = 覆盖层级标识（与 `reach_tiers[].slug` 对应，平台未报告覆盖量时为 `null`），`m` = 广告投放所在市场的 ISO 3166-1 alpha-2 代码，`ch` = 来源渠道，`fo` = 广告格式，`n` = 该分组内的广告数量。", "items": { "type": "object" } }, "reach_tiers": { "type": "array", "description": "覆盖层级的标签目录，按从小到大排序。这是一张查找表，而非分布数据 —— 其中不包含任何计数。请用 `postings[].r` 关联 `slug` 以获取可读标签，并从 `postings[].n` 读取各层级的数量。广告覆盖量在数据源中是文本区间，因此绝不可将各层级相加得出单一覆盖数值。", "items": { "type": "object" } }, "creatives": { "type": "array", "description": "近期广告创意，以图片优先：有实际图片的创意排在前面，其后是近期的文字或视频广告，以便没有图片的广告主仍能出现。`headline`、`body` 与 `cta` 均可能为 `null`。渲染创意画廊所需的全部字段均在此处，无需再调用广告搜索。", "items": { "type": "object" } } } } } }, "example": { "data": { "totals": { "total": 14, "launched": 4, "active": 4, "markets": 46, "channels": 2 }, "weekly_series": [ { "week_start": "2026-05-25", "count": 4 } ], "postings": [ { "r": "10k_50k", "m": [ "PE", "KR", "VE", "AR" ], "ch": "facebook", "fo": "video", "n": 1 } ], "placement_mix": [ { "key": "INSTAGRAM", "count": 10 } ], "creatives": [ { "advertisement_search_id": "29fbc4ec-d9f2-40dc-be00-c96856271f8c", "image_url": "https://buckets.pubrio.com/images/public/fHaGeJ1EMBzgz2o4TMwgsRptA17BMn8U.jpg", "headline": null, "cta": "Learn more", "advertisement_url": "https://www.facebook.com/ads/library?id=1234567890", "destination_url": "https://www.instagram.com/youtube", "advertiser": "YouTube", "body": "this video lives rent free in our minds", "format": "image", "has_video": false } ], "reach_tiers": [ { "slug": "lt_1k", "label": "< 1K" }, { "slug": "1k_10k", "label": "1K–10K" }, { "slug": "10k_50k", "label": "10K–50K" }, { "slug": "50k_100k", "label": "50K–100K" }, { "slug": "100k_500k", "label": "100K–500K" } ], "window_days": 90 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/dashboard": { "post": { "tags": [ "Expansion" ], "summary": "扩张概览", "description": "市场层面的扩张关键指标——各市场的阶段分布计数和主要跨境流向。已聚合，不分页。", "operationId": "expansions_dashboard", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "froms": { "$ref": "#/components/schemas/expansion_froms" }, "tos": { "$ref": "#/components/schemas/expansion_tos" }, "exclude_froms": { "$ref": "#/components/schemas/expansion_exclude_froms" }, "exclude_tos": { "$ref": "#/components/schemas/expansion_exclude_tos" }, "stages": { "allOf": [ { "$ref": "#/components/schemas/expansion_stages" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "momentum": { "allOf": [ { "$ref": "#/components/schemas/expansion_momentum" } ], "description": "公司在该市场中的走势。`advancing` 表示正在推进，`steady` 表示保持稳定，`pulling_back` 涵盖收缩与撤退。\n\n请**不要**在此处使用 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 中 `directions` 的取值。那些取值（`advancing`、`steady`、`retreating`、`new`）是你在 `stage.direction` 中收到的*响应*值；作为*筛选条件*仅接受上面列出的三个。传入 `retreating` 或 `new` 会静默禁用该筛选条件并返回未经筛选的结果。" }, "freshness": { "allOf": [ { "$ref": "#/components/schemas/expansion_freshness" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "scopes": { "$ref": "#/components/schemas/expansion_scopes" }, "ahead_of_pace": { "type": "boolean", "example": false, "description": "仅限扩张速度快于该市场典型速度的公司/市场组合。" }, "signal_types": { "allOf": [ { "$ref": "#/components/schemas/expansion_signal_type_slugs" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "signal_strengths": { "allOf": [ { "$ref": "#/components/schemas/signal_strengths" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "min_signal_count": { "type": "integer", "example": 3, "description": "公司在该时间窗口内所需的最少扩张信号数量——用于筛选“非常活跃 / 足迹密集”的公司。" }, "only_contraction": { "$ref": "#/components/schemas/only_contraction" }, "verticals": { "$ref": "#/components/schemas/verticals" }, "vertical_categories": { "$ref": "#/components/schemas/vertical_categories" }, "vertical_sub_categories": { "$ref": "#/components/schemas/vertical_sub_categories" }, "technologies": { "$ref": "#/components/schemas/technologies" }, "employees": { "$ref": "#/components/schemas/employees" }, "revenues": { "$ref": "#/components/schemas/revenues" }, "founded_dates": { "$ref": "#/components/schemas/founded_dates" }, "keywords": { "$ref": "#/components/schemas/keywords" }, "companies": { "$ref": "#/components/schemas/expansion_companies" }, "job_locations": { "$ref": "#/components/schemas/locations" }, "job_exclude_locations": { "$ref": "#/components/schemas/job_exclude_locations" }, "job_posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "job_titles": { "$ref": "#/components/schemas/people_titles" }, "advertisement_target_locations": { "$ref": "#/components/schemas/advertisement_target_locations" }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/advertisement_exclude_target_locations" }, "advertisement_search_terms": { "$ref": "#/components/schemas/advertisement_search_terms" }, "advertisement_start_dates": { "$ref": "#/components/schemas/advertisement_start_dates" }, "advertisement_end_dates": { "$ref": "#/components/schemas/advertisement_end_dates" }, "news_categories": { "$ref": "#/components/schemas/news_categories" }, "news_published_dates": { "$ref": "#/components/schemas/published_dates" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-06-01", "2026-06-29" ], "description": "显示窗口（地图、流向和关注列表时间线）的 ISO 日期范围 [start, end]。默认为最近 90 天。`new_transitions_30d` 这一 KPI 始终使用其固定的 30 天窗口，不受此范围影响。" }, "window_days": { "$ref": "#/components/schemas/window_days" }, "min_markets": { "type": "integer", "example": 3, "description": "公司在该时间窗口内必须进入的新市场最少数量（用于筛选广泛扩张者）。" }, "home_country_code": { "type": "array", "items": { "type": "string" }, "example": [ "SG" ], "description": "按公司总部所在国家筛选（ISO 3166-1 alpha-2）。与 `froms` 同时提供时取交集。" }, "industries": { "$ref": "#/components/schemas/industries" }, "exclude_industries": { "$ref": "#/components/schemas/exclude_industries" }, "select_size": { "type": "integer", "example": 250, "description": "最多返回的市场数量(受套餐上限约束)。" }, "flows_size": { "type": "integer", "example": 50, "description": "最多返回的跨境流向数量(受套餐上限约束)。" }, "is_include_metadata": { "allOf": [ { "$ref": "#/components/schemas/expansion_is_include_metadata" } ], "description": "返回完整的详细信息负载。API 密钥请求默认返回精简结果：除非此项为 `true`，否则将省略 `model` 区块、置信度数值（公司扩张详情中的 `stage.confidence`，以及 `other_markets[]` 和排名 `markers[]` 中的 `confidence_score`），以及 `established_min` / `share_of_detected` / `has_known_office` 字段。" }, "is_enable_similarity_search": { "type": "boolean", "description": "为 `verticals`、`vertical_categories`、`vertical_sub_categories` 与 `technologies` 启用自由文本匹配；未设为 `true` 时这些筛选条件会被丢弃。", "example": true } } } } } }, "responses": { "200": { "description": "市场仪表板聚合数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object" }, "data": { "type": "object", "description": "仪表板数据容器:经排名的市场,以及热门跨境走廊流向。已弃用的遗留镜像。为兼容旧客户端，`data` 内的每个容器同时也会在顶层输出（`countries`、`top_flows`、`picks_aggregate`、`watchlist_markets`、`watchlist_timeline`）。请从 `data` 中读取 —— 顶层副本将被移除。", "properties": { "countries": { "type": "array", "description": "经排名的市场,附带各市场的信号数量。", "items": { "type": "object" } }, "top_flows": { "type": "array", "items": { "type": "object" }, "description": "最主要的跨境扩张流向，按规模排序。" }, "picks_aggregate": { "type": "array", "description": "当前过滤条件所匹配市场的汇总统计。", "items": { "type": "object" } }, "watchlist_markets": { "type": "array", "description": "仅限工作区已保存公司的各市场阶段计数。", "items": { "type": "object" } }, "watchlist_timeline": { "type": "array", "description": "工作区已保存公司的阶段转换事件，按时间由新到旧排列。", "items": { "type": "object" } } } } }, "x-legacy-root-keys": [ "countries", "top_flows", "picks_aggregate", "watchlist_markets", "watchlist_timeline" ] }, "example": { "metadata": { "filters": { "froms": [ "CN" ], "tos": [ "GB" ] }, "select_size": 250, "flows_size": 50, "transitioned_dates": [ "2026-06-01", "2026-06-29" ] }, "data": { "countries": [ { "country_code": "US", "inbound_count": 18, "outbound_count": 5, "total_companies_with_signals": 23, "exploring_count": 8, "committing_count": 10, "expanding_count": 4, "scaling_count": 1, "new_transitions_30d": 3, "pairs_ahead_of_pace_30d": 1, "freshest_transition_at": "2026-06-27T14:32:10.000Z" } ], "top_flows": [ { "home_country_code": "SG", "country_code": "US", "company_count": 5, "new_transitions_30d": 1 } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/search": { "post": { "tags": [ "Expansion" ], "summary": "扩张搜索", "description": "查找正在向一个或多个市场扩张的公司，可使用企业和信号筛选条件或自然语言查询，并可选择生成基于该公司真实信号的 AI 匹配说明。", "operationId": "expansions_search", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "froms": { "$ref": "#/components/schemas/expansion_froms" }, "tos": { "$ref": "#/components/schemas/expansion_tos" }, "exclude_froms": { "$ref": "#/components/schemas/expansion_exclude_froms" }, "exclude_tos": { "$ref": "#/components/schemas/expansion_exclude_tos" }, "stages": { "allOf": [ { "$ref": "#/components/schemas/expansion_stages" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "momentum": { "allOf": [ { "$ref": "#/components/schemas/expansion_momentum" } ], "description": "公司在该市场中的走势。`advancing` 表示正在推进，`steady` 表示保持稳定，`pulling_back` 涵盖收缩与撤退。\n\n请**不要**在此处使用 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 中 `directions` 的取值。那些取值（`advancing`、`steady`、`retreating`、`new`）是你在 `stage.direction` 中收到的*响应*值；作为*筛选条件*仅接受上面列出的三个。传入 `retreating` 或 `new` 会静默禁用该筛选条件并返回未经筛选的结果。" }, "freshness": { "allOf": [ { "$ref": "#/components/schemas/expansion_freshness" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "scopes": { "$ref": "#/components/schemas/expansion_scopes" }, "ahead_of_pace": { "type": "boolean", "example": false, "description": "仅限扩张速度快于该市场典型速度的组合。" }, "signal_types": { "allOf": [ { "$ref": "#/components/schemas/expansion_signal_type_slugs" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "signal_strengths": { "allOf": [ { "$ref": "#/components/schemas/signal_strengths" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "min_signal_count": { "type": "integer", "example": 3, "description": "公司在该时间窗口内所需的最少扩张信号数量——用于筛选“非常活跃 / 足迹密集”的公司。" }, "only_contraction": { "$ref": "#/components/schemas/only_contraction" }, "min_markets": { "type": "integer", "example": 3, "description": "公司在该时间窗口内必须进入的新市场最少数量。" }, "home_country_code": { "type": "array", "items": { "type": "string" }, "example": [ "SG" ], "description": "按公司总部所在国家筛选（ISO 3166-1 alpha-2）。与 `froms` 同时提供时取交集。" }, "industries": { "$ref": "#/components/schemas/industries" }, "exclude_industries": { "$ref": "#/components/schemas/exclude_industries" }, "verticals": { "$ref": "#/components/schemas/verticals" }, "vertical_categories": { "$ref": "#/components/schemas/vertical_categories" }, "vertical_sub_categories": { "$ref": "#/components/schemas/vertical_sub_categories" }, "technologies": { "$ref": "#/components/schemas/technologies" }, "employees": { "$ref": "#/components/schemas/employees" }, "revenues": { "$ref": "#/components/schemas/revenues" }, "founded_dates": { "$ref": "#/components/schemas/founded_dates" }, "keywords": { "$ref": "#/components/schemas/keywords" }, "companies": { "$ref": "#/components/schemas/expansion_companies" }, "job_locations": { "$ref": "#/components/schemas/locations" }, "job_exclude_locations": { "$ref": "#/components/schemas/job_exclude_locations" }, "job_posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "job_titles": { "$ref": "#/components/schemas/people_titles" }, "advertisement_target_locations": { "$ref": "#/components/schemas/advertisement_target_locations" }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/advertisement_exclude_target_locations" }, "advertisement_search_terms": { "$ref": "#/components/schemas/advertisement_search_terms" }, "advertisement_start_dates": { "$ref": "#/components/schemas/advertisement_start_dates" }, "advertisement_end_dates": { "$ref": "#/components/schemas/advertisement_end_dates" }, "news_categories": { "$ref": "#/components/schemas/news_categories" }, "news_published_dates": { "$ref": "#/components/schemas/published_dates" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "时间线窗口的 ISO 日期范围。默认为最近 90 天。. A natural-language `query` may also set this from calendar phrases (\"this year\", \"last year\", \"Q2 2026\")." }, "window_days": { "$ref": "#/components/schemas/window_days" }, "query": { "type": "string", "example": "fintech companies expanding into the UK", "description": "Pubrio 将其解析为扩张与公司筛选条件的自然语言查询。" }, "is_explain_match": { "type": "boolean", "example": true, "description": "为每家公司附上其匹配搜索条件原因的 AI 生成说明（基于公司的真实信号）。建议配合自然语言查询使用。引用的信号数量及批处理规模均随 `per_page` 变化；高频来源（招聘信息、广告投放）会以窗口期内的数量形式汇总（例如\"12 个职位发布\"），而非逐条列出。" }, "sort_by": { "$ref": "#/components/schemas/expansion_sort_by" }, "is_include_metadata": { "allOf": [ { "$ref": "#/components/schemas/expansion_is_include_metadata" } ], "description": "返回完整的详细信息负载。API 密钥请求默认返回精简结果：除非此项为 `true`，否则将省略 `model` 区块、置信度数值（公司扩张详情中的 `stage.confidence`，以及 `other_markets[]` 和排名 `markers[]` 中的 `confidence_score`），以及 `established_min` / `share_of_detected` / `has_known_office` 字段。" }, "page": { "$ref": "#/components/schemas/page" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "is_enable_similarity_search": { "type": "boolean", "description": "为 `verticals`、`vertical_categories`、`vertical_sub_categories` 与 `technologies` 启用自由文本匹配；未设为 `true` 时这些筛选条件会被丢弃。", "example": true } }, "anyOf": [ { "title": "来源市场", "required": [ "froms" ] }, { "title": "目标市场", "required": [ "tos" ] }, { "title": "自然语言查询", "required": [ "query" ] }, { "title": "指定公司", "required": [ "companies" ] } ] } } } }, "responses": { "200": { "description": "在目标市场扩张的公司分页列表。`filters` 会回显已应用（或自然语言解析）的条件；当 `is_explain_match` 为 true 时，每家公司都会包含 `match_summary`。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "搜索元数据：实际应用的筛选器，以及市场汇总（aggregate、地理范围、top origins/destinations/industries、timeline）。API 密钥响应仅在 `is_include_metadata` 为 true 时包含该汇总。", "properties": { "filters": { "type": "object", "description": "实际应用的筛选器（当使用 `query` 时，回显解释后的自然语言查询）。" }, "relaxed_filters": { "type": "array", "description": "当自然语言查询无匹配时被自动放宽的软筛选器；否则为 null。", "items": { "type": "string" } }, "nl_note": { "type": "string", "description": "当自然语言查询未表达任何可识别条件时的人类可读提示；此时列表为空。" }, "nl_note_code": { "type": "string", "description": "nl_note 的机器可读代码（例如 expansion.search.no_criteria）。" }, "aggregate": { "type": "object", "description": "市场级汇总。请求元数据时提供。" }, "country_code": { "type": "string" }, "country_codes": { "type": "array", "items": { "type": "string" } }, "direction": { "type": "string" }, "is_global": { "type": "boolean" }, "is_multi": { "type": "boolean" }, "transitioned_dates": { "type": "array", "items": { "type": "string" } }, "top_origins": { "type": "array", "items": { "type": "object" } }, "top_destinations": { "type": "array", "items": { "type": "object" } }, "top_industries": { "type": "array", "items": { "type": "object" } }, "timeline": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "description": "结果容器（标准搜索信封）：公司列表加分页。", "properties": { "pagination": { "type": "object", "description": "页码、每页数量、总条目数与总页数。" }, "companies": { "type": "array", "description": "公司列表。每一项都带有嵌套的 `stage`；当 `is_explain_match` 为 true 时包含 `match_summary`。API 密钥响应还包含 `presence`（`level`：established | emerging | none | no_data；`matched_rule`：office | headcount | share）和一个 `read` 对象，其 `code` 为 scaling | deepening | active | establishing（无本地布局可判读时为 null）。", "items": { "type": "object" } } } } } }, "example": { "metadata": { "filters": { "tos": [ "GB" ], "verticals": [ "Financial Services" ] } }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 87, "total_pages": 4, "total_display_pages": 4, "is_timeout": false }, "companies": [ { "expansion_id": "6845525", "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "country_code": "GB", "target_country_code": "GB", "domain": "example.com", "company_name": "Example Corp", "home_country_code": "CN", "industry": "Consumer Electronics", "founded_year": 2015, "employees_count": 320, "stage": { "slug": "expanding", "expansion_score": 0.72, "scope": "entering_new_market", "direction": "advancing", "freshness": "fresh", "signal_count": 27, "distinct_type_count": 3, "last_transition_at": "2026-06-27T14:32:10.000Z" }, "presence": { "level": "established", "local_people_count": 12, "matched_rule": "headcount", "has_known_office": true, "established_min": 10, "share_of_detected": 0.54 }, "read": { "code": "establishing" } } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/companies/compare": { "post": { "tags": [ "Expansion" ], "summary": "对比公司扩张", "description": "并排比较多家公司的扩张布局，并可选择为目标公司引入可比同类公司。", "operationId": "expansions_company_compare", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "companies": { "$ref": "#/components/schemas/expansion_companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "信号/转换窗口的 ISO `[from, to]` 日期范围。如果同时提供了 `window_days`,则此参数优先。" }, "window_days": { "$ref": "#/components/schemas/window_days" }, "seed_target": { "type": "string", "example": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "description": "将 `companies` 中的哪家公司作为基准对象。其余公司按信号量与置信度排序，最匹配的同行返回在 `metadata.seeded_peers` 中。它只在你传入的列表中挑选，不会发现新公司。" }, "is_include_established": { "$ref": "#/components/schemas/expansion_is_include_established" }, "is_include_metadata": { "type": "boolean", "description": "返回完整的详细信息负载。API 密钥请求默认返回精简结果：除非此项为 `true`，否则将省略 `model` 区块、置信度数值（公司扩张详情中的 `stage.confidence`，以及 `other_markets[]` 和排名 `markers[]` 中的 `confidence_score`），以及 `established_min` / `share_of_detected` / `has_known_office` 字段。", "example": true } } } } } }, "responses": { "200": { "description": "按 domain_search_id 分组的单公司对比数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "seeded_peers": { "type": "array", "items": { "type": "string" }, "description": "为 `seed_target` 选出的同行，最匹配的在前。未提供 `seed_target` 时为空。" }, "peer_cap": { "type": "integer", "nullable": true, "description": "你的套餐可对比的同行上限；无限制时为 `null`。" }, "peers_available": { "type": "integer", "description": "在时间窗口内有信号的同行数量（应用 `peer_cap` 之前）。" } } }, "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object" }, "description": "参与比较的每家公司一条，按请求顺序排列。" } } } } }, "example": { "metadata": { "seeded_peers": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ] }, "data": { "companies": [ { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "home_country_code": "SG", "firmographics": { "company_name": "Example Corp", "country_code": "SG", "company_size": 350, "founded_year": 2015, "industry": "Software Development", "publicly_traded_symbol": null, "estimated_revenue": 25000000 }, "markets_summary": [ { "country_code": "US", "stage_slug": "committing", "signal_count": 12, "distinct_type_count": 4, "first_signal_at": "2026-04-02T08:00:00.000Z", "latest_signal_at": "2026-06-28T10:15:22.000Z", "last_transition_at": "2026-06-25T14:30:00.000Z", "expansion_score": 0.685, "signals": [ { "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager", "event_date": "2026-06-20T14:00:00.000Z", "display_label": "Hired Regional VP for North America" } ] } ] } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/companies/summaries": { "post": { "tags": [ "Expansion" ], "summary": "批量获取公司扩张摘要", "description": "为一组公司提供可直接渲染的扩张摘要，便于直接进行横向对比，无需在客户端二次聚合。", "operationId": "expansions_company_summaries", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "companies": { "$ref": "#/components/schemas/expansion_companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "信号/转换窗口的 ISO `[from, to]` 日期范围。如果同时提供了 `window_days`，则此参数优先。" }, "window_days": { "$ref": "#/components/schemas/window_days" }, "is_include_established": { "$ref": "#/components/schemas/expansion_is_include_established" }, "is_include_metadata": { "type": "boolean", "description": "返回完整的详细信息负载。API 密钥请求默认返回精简结果：除非此项为 `true`，否则将省略 `model` 区块、置信度数值（公司扩张详情中的 `stage.confidence`，以及 `other_markets[]` 和排名 `markers[]` 中的 `confidence_score`），以及 `established_min` / `share_of_detected` / `has_known_office` 字段。", "example": true } }, "description": "使用单个 `companies` 数组来限定公司范围，可混合传入 `domain_search_id`、公司域名或 LinkedIn URL，匹配结果为并集（而非交集）。为向后兼容，仍支持旧的 `domain_search_ids`、`domains`、`linkedin_urls` 字段。每次请求最多解析 25 家公司。" } } } }, "responses": { "200": { "description": "公司扩张摘要数组，每个元素对应一家公司。包含两个分数：顶层 `expansion_score` 为跨所有市场的整体当前态势（稳定值）；`summary.window_expansion_score` 为按所选时间窗口计算的同一指标。二者在此均为 0-100 范围（不同于搜索结果中 0-1 的 `stage.expansion_score`）。当您的套餐不含员工数时，`firmographics` 中的 `company_size`、`employees_count` 和 `company_size_printed` 返回 null，并置 `is_employees_locked: true`。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object" }, "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object" }, "description": "请求的每家公司一份可直接渲染的摘要。" } } } } }, "example": { "metadata": {}, "data": { "companies": [ { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "home_country_code": "SG", "expansion_score": 82, "firmographics": { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "company_name": "Example Corp", "domain": "example.com", "logo_url": "https://logo.pubrio.com/example.com.png", "country_code": "SG", "company_size": null, "employees_count": 350, "company_size_printed": "351+", "is_employees_locked": false, "founded_year": 2015, "industry": "Software Development", "publicly_traded_symbol": null, "estimated_revenue": 25000000 }, "markets_summary": [ { "country_code": "US", "stage_slug": "committing", "signal_count": 12, "distinct_type_count": 4, "first_signal_at": "2026-04-02T08:00:00.000Z", "latest_signal_at": "2026-06-28T10:15:22.000Z", "last_transition_at": "2026-06-25T14:30:00.000Z", "expansion_score": 0.685, "signals": [ { "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager", "event_date": "2026-06-20T14:00:00.000Z", "display_label": "Hired Regional VP for North America" } ] } ], "signal_weekly_totals": [ { "week_start": "2026-06-22", "signal_type_slug": "HIRE", "count": 5 } ], "summary": { "active_markets": 1, "total_markets": 1, "new_markets": 1, "momentum_pct": 22, "signal_count": 12, "window_expansion_score": 69, "scaling": 0, "pipeline": 1, "top_market": { "country_code": "US", "country": null, "stage": "committing" }, "newest_market": { "country_code": "US", "country": null, "stage": "committing" }, "activity_weekly": [ 3, 5, 4 ] } } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/companies/lookup": { "post": { "tags": [ "Expansion" ], "summary": "公司扩张详情", "description": "单家公司的深度扩张画像——当前阶段、信号、市场存在及阶段转换历史——可针对单一市场，或汇总所有市场。", "operationId": "expansions_company_lookup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "country_code": { "$ref": "#/components/schemas/expansion_country_code" }, "is_all_markets": { "$ref": "#/components/schemas/expansion_is_all_markets" }, "signal_type": { "type": "string", "enum": [ "AD", "AUDIENCE", "DNS", "ENTITY", "EVENT", "EVENT_PLUS", "EXEC", "HIRE", "INFRA", "IP", "NEWS", "OFFICE", "PARTNER", "PRODUCT", "REG", "SCALE", "TECH" ], "example": "EXEC", "description": "将返回的信号筛选至单一类型。" }, "query": { "type": "string", "example": "We sell Employer-of-Record and local payroll; best-fit buyers hire in a new market before setting up a legal entity.", "description": "用纯文本描述你所销售的产品，或你正在评估这家公司是否契合的目标买家画像。仅用于为 AI `summary` 提供依据（见 `is_explain_match`）；与公司搜索不同，此处不会将其解析为筛选条件。" }, "is_explain_match": { "type": "boolean", "example": true, "description": "为 true 且提供了 `query` 时,`summary` 返回针对当前范围(所选市场,或当 `is_all_markets` 为 true 时的所有海外市场)内该公司扩张活动的单条 AI 摘要,依据你的 `query` 解读,并基于公司的真实信号给出 `[n]` 引用。" }, "window_days": { "type": "integer", "example": 90, "default": 90, "description": "可选。限定 AI `summary` 所依据信号流的滚动时间窗口(天)。当本参数与 `transitioned_dates` 均未提供时默认为 **90**。不影响分页的 `signals` 列表(完整历史)。" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "信号/转换窗口的 ISO `[from, to]` 日期范围。如果同时提供了 `window_days`,则此参数优先。" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" }, "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "is_include_established": { "$ref": "#/components/schemas/expansion_is_include_established" }, "page": { "$ref": "#/components/schemas/page" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "is_include_metadata": { "type": "boolean", "description": "返回完整的详细信息负载。API 密钥请求默认返回精简结果：除非此项为 `true`，否则将省略 `model` 区块、置信度数值（公司扩张详情中的 `stage.confidence`，以及 `other_markets[]` 和排名 `markers[]` 中的 `confidence_score`），以及 `established_min` / `share_of_detected` / `has_known_office` 字段。", "example": true }, "summary_only": { "type": "boolean", "description": "仅返回阶段摘要区块（`data`、`company`、`markets_summary`、`signal_weekly_totals`、`recent_signals`、`expansion_score`、`summary`），跳过信号列表及其聚合。适用于头部概览视图，开销更低。", "example": true }, "markets_summary_full": { "type": "boolean", "description": "在受限的 `other_markets` 列表之外，额外返回完整的市场排名集合 `markets_summary`。", "example": true } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ] } } } }, "responses": { "200": { "description": "公司在某市场的详情。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object" }, "data": { "type": "object", "description": "结果容器。", "properties": { "domain_search_id": { "type": "string", "description": "Pubrio 公司标识符。" }, "country_code": { "type": "string", "description": "目标市场，ISO 3166-1 alpha-2。" }, "country_name": { "type": "string", "description": "目标市场名称。" }, "stage_rank": { "type": "integer", "description": "阶段的数值排序，越大表示越靠后。" }, "stage_name": { "type": "string", "description": "阶段的显示名称。" }, "stage": { "type": "object", "description": "阶段详情——分数、范围、方向、时效与信号计数。" }, "local_people_count": { "type": "integer", "description": "位于目标市场的员工数。" }, "local_people_coverage": { "type": "boolean", "description": "员工覆盖度是否足以采信该计数。" }, "presence": { "type": "object", "description": "市场内布局：独立于扩张阶段，反映公司已有的落地程度。", "properties": { "level": { "type": "string", "enum": [ "established", "emerging", "none", "no_data" ], "description": "该公司在此市场的落地程度：`established`、`emerging`、`none` 或 `no_data`。这描述的是既有布局，而非扩张阶段。" }, "local_people_count": { "type": "integer", "description": "位于目标市场的员工数。" }, "matched_rule": { "type": "string", "nullable": true, "description": "判定该等级所依据的信号，例如 `office`、`headcount` 或 `share`。未命中任何规则时为 `null`。" } } }, "read": { "type": "object", "description": "该记录的读取状态。" } } }, "signals": { "type": "array", "description": "该公司/市场组合背后的分页信号行，即证据列表。分页大小与总数见 `metadata.pagination`。", "items": { "type": "object" } }, "summary": { "type": "object", "description": "该组合的单行阶段摘要。仅在第一页返回。" }, "company": { "type": "object", "description": "公司基础信息——名称、域名、Logo 及社交链接。仅在第一页返回。" }, "signal_group_totals": { "type": "array", "description": "按类型统计的信号数量，按你所在时区的日期分桶。仅在第一页返回。", "items": { "type": "object" } }, "signal_type_totals": { "type": "array", "description": "各信号类型的历史累计数量。仅在第一页返回。", "items": { "type": "object" } }, "signal_type_recent_totals": { "type": "array", "description": "最近 12 周内各信号类型的数量。仅在第一页返回。", "items": { "type": "object" } }, "signal_weekly_totals": { "type": "array", "description": "用于热力图的每周信号数量，时间窗口与 `signal_type_recent_totals` 一致。仅在第一页返回。", "items": { "type": "object" } }, "evidence_breakdown": { "type": "object", "description": "按来源类型汇总的证据统计，基于返回的（已脱敏）信号计算。仅在第一页返回。" }, "presence": { "type": "object", "description": "该公司在此市场中观察到的实体与数字化存在。仅在第一页返回。" }, "suppressions": { "type": "array", "description": "在阶段计算中被抑制的信号及其原因。仅在第一页返回。", "items": { "type": "object" } }, "timeline": { "type": "array", "description": "该公司/市场组合的阶段转换历史。仅在第一页返回。", "items": { "type": "object" } }, "other_markets": { "type": "array", "description": "该公司的其他活跃市场。受套餐限制时会截断，详见 `other_markets_locked_count`。仅在第一页返回。", "items": { "type": "object" } }, "other_markets_locked_count": { "type": "integer", "description": "由于套餐限制而未在 `other_markets` 中返回的市场数量。未被截断时为 `0`。" }, "markets_summary": { "type": "array", "description": "该公司完整的市场排名集合。仅当 `markets_summary_full` 为 `true` 且在第一页时返回。", "items": { "type": "object" } } } }, "example": { "metadata": { "filters": { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "country_code": "US" }, "country_code_auto_picked": false, "pagination": { "page": 1, "per_page": 25, "total_entries": 12, "total_pages": 1, "total_display_pages": 1, "is_timeout": false } }, "data": { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "country_code": "US", "country_name": "United States", "stage_rank": 3, "stage_name": "Expanding", "stage": { "slug": "expanding", "expansion_score": 0.721, "scope": "entering_new_market", "direction": "advancing", "freshness": "fresh", "contraction_flag": null, "mode_change_flag": false, "signal_count": 5, "distinct_type_count": 3, "has_known_presence": false, "first_signal_at": "2026-05-30T09:00:00.000Z", "latest_signal_at": "2026-06-20T14:00:00.000Z", "last_transition_at": "2026-06-15T09:30:00.000Z" } }, "signals": [ { "signal_type_slug": "EXEC", "signal_subtype_slug": "country_manager", "signal_strength_slug": "high", "polarity": "expansion", "event_date": "2026-06-20T14:00:00.000Z", "source_type": "linkedin", "display_label": "Hired Regional VP for North America", "evidence_url": "https://linkedin.com/company/example-corp", "source_published_at": "2026-06-20T14:00:00.000Z", "lead_time_days": 0 } ], "presence": [ { "presence_type": "office", "presence_strength": "high", "address": "123 Market St, San Francisco, CA", "known_since": "2026-03-15T00:00:00.000Z" } ], "timeline": [ { "stage_slug": "expanding", "transitioned_at": "2026-06-15T09:30:00.000Z", "transition_kind": "advance" } ], "other_markets": [ { "country_code": "CA", "stage_slug": "committing", "signal_count": 8, "first_signal_at": "2026-04-10T00:00:00.000Z", "latest_signal_at": "2026-06-22T16:45:00.000Z", "last_transition_at": "2026-06-18T00:00:00.000Z" } ] } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/companies/pulse_events": { "post": { "tags": [ "Expansion" ], "summary": "公司信号事件", "description": "针对单家公司，深入钻取驱动其扩张的信号事件，结果经过丰富并分页。", "operationId": "expansions_company_pulse_events", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signal_types": { "$ref": "#/components/schemas/expansion_signal_type_slugs" }, "country_codes": { "type": "array", "items": { "type": "string" }, "example": [ "JP", "SG" ], "description": "可选。将信号流限定到一个或多个海外市场(ISO 3166-1 alpha-2,例如 `[\"JP\",\"SG\"]`)。未提供时返回所有海外市场(始终排除本土市场)。" }, "transitioned_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-04-01", "2026-06-29" ], "description": "信号/转换窗口的 ISO `[from, to]` 日期范围。如果同时提供了 `window_days`,则此参数优先。" }, "window_days": { "type": "integer", "example": 90, "default": 90, "description": "可选。事件滚动时间窗口的天数。当本参数与 `transitioned_dates` 均未提供时,默认使用 **90** 天(标准展示窗口)。两者同时提供时以 `transitioned_dates` 为准。" }, "query": { "type": "string", "example": "We sell Employer-of-Record and local payroll; best-fit buyers hire in a new market before setting up a legal entity.", "description": "用纯文本描述你所销售的产品，或你正在评估这家公司是否契合的目标买家画像。仅用于为 AI `summary` 提供依据（见 `is_explain_match`）；与公司搜索不同，此处不会将其解析为筛选条件。" }, "is_explain_match": { "type": "boolean", "example": true, "description": "当为 true 且提供了 `query` 时，`data.summary` 会返回一段针对该公司扩张活动、结合你的 `query` 生成的 AI 摘要，基于公司的真实信号并带有 `[n]` 引用标注。与公司搜索中逐公司的 `match_summary` 不同，此摘要基于该公司在时间窗口内的完整信号集（所有市场、全部信号）生成，因此不受 `page` / `per_page` 影响，结果保持稳定。" }, "domain": { "$ref": "#/components/schemas/domain" }, "linkedin_url": { "$ref": "#/components/schemas/company_linkedin_url" }, "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "page": { "$ref": "#/components/schemas/page" }, "per_page": { "$ref": "#/components/schemas/per_page" } }, "anyOf": [ { "title": "Domain Search ID", "required": [ "domain_search_id" ] }, { "title": "域名", "required": [ "domain" ] }, { "title": "LinkedIn URL", "required": [ "linkedin_url" ] } ] } } } }, "responses": { "200": { "description": "分页的信号事件。当 `is_explain_match` 为 true 且提供了 `query` 时，`data.summary` 包含一段针对公司完整信号集、结合查询生成的 AI 摘要（`{ text, citations }`）；否则为 `null`。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object" }, "data": { "type": "object", "description": "结果容器。", "properties": { "pagination": { "type": "object", "description": "页码、每页数量、总条目数与总页数。" }, "events": { "type": "array", "description": "该公司的信号事件，最新在前。", "items": { "type": "object" } }, "summary": { "type": "object", "description": "本页事件的可选汇总；未计算时为 `null`。", "nullable": true } } } } }, "example": { "metadata": { "filters": { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" } }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 42, "total_pages": 2, "total_display_pages": 2, "is_timeout": false }, "events": [ { "signal_type_slug": "EXEC", "stage_slug": "expanding", "country_code": "US", "signal_subtype_slug": "country_manager", "source_type": "linkedin", "polarity": "expansion", "display_label": "Hired Country Manager", "evidence_url": "https://linkedin.com/company/example-corp", "event_date": "2026-06-20T14:00:00.000Z" } ], "summary": { "text": "Example Corp is hiring across Tokyo[1] and just added a Japan Country Manager[2], yet has no legal entity on file — it is staffing the market before incorporating, which is exactly your window.", "citations": [ { "n": 1, "type": "HIRE", "label": "Tokyo software & field-ops roles", "country": "JP", "date": "2026-06", "url": null }, { "n": 2, "type": "EXEC", "label": "Country Manager, Japan", "country": "JP", "date": "2026-06", "url": "https://linkedin.com/in/example" } ] } } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/companies/rankings": { "post": { "tags": [ "Expansion" ], "summary": "扩张排名", "description": "按扩张评分排列的公司/市场对轻量榜单——适合地图或热力图渲染。", "operationId": "expansions_company_rankings", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "froms": { "$ref": "#/components/schemas/expansion_froms" }, "tos": { "$ref": "#/components/schemas/expansion_tos" }, "exclude_froms": { "$ref": "#/components/schemas/expansion_exclude_froms" }, "exclude_tos": { "$ref": "#/components/schemas/expansion_exclude_tos" }, "stages": { "allOf": [ { "$ref": "#/components/schemas/expansion_stages" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "signal_types": { "allOf": [ { "$ref": "#/components/schemas/expansion_signal_type_slugs" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "signal_strengths": { "allOf": [ { "$ref": "#/components/schemas/signal_strengths" } ], "description": "取值区分大小写，且**不会被校验**。无法识别的取值会被静默丢弃而非报错：在 `stages`、`freshness`、`scopes` 和 `momentum` 上，整个筛选条件会被丢弃，你将得到*未经筛选*的结果；而在 `signal_types` 和 `signal_strengths` 上，筛选条件会被应用但*不匹配任何内容*。两种情况下响应看起来都很正常。请通过 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 获取有效的标识值；若结果集看起来异常，请将 `data.pagination.total_entries` 与未加筛选的调用进行对比。" }, "min_signal_count": { "type": "integer", "example": 3, "description": "公司在该时间窗口内所需的最少扩张信号数量——用于筛选“非常活跃 / 足迹密集”的公司。" }, "only_contraction": { "$ref": "#/components/schemas/only_contraction" }, "domain_search_ids": { "allOf": [ { "$ref": "#/components/schemas/expansion_domain_search_ids" } ], "description": "要限定的公司，按 `domain_search_id`。" }, "verticals": { "$ref": "#/components/schemas/verticals" }, "vertical_categories": { "$ref": "#/components/schemas/vertical_categories" }, "vertical_sub_categories": { "$ref": "#/components/schemas/vertical_sub_categories" }, "technologies": { "$ref": "#/components/schemas/technologies" }, "employees": { "$ref": "#/components/schemas/employees" }, "revenues": { "$ref": "#/components/schemas/revenues" }, "founded_dates": { "$ref": "#/components/schemas/founded_dates" }, "keywords": { "$ref": "#/components/schemas/keywords" }, "companies": { "$ref": "#/components/schemas/expansion_companies" }, "job_locations": { "$ref": "#/components/schemas/locations" }, "job_exclude_locations": { "$ref": "#/components/schemas/job_exclude_locations" }, "job_posted_dates": { "$ref": "#/components/schemas/posted_dates" }, "job_titles": { "$ref": "#/components/schemas/people_titles" }, "advertisement_target_locations": { "$ref": "#/components/schemas/advertisement_target_locations" }, "advertisement_exclude_target_locations": { "$ref": "#/components/schemas/advertisement_exclude_target_locations" }, "advertisement_search_terms": { "$ref": "#/components/schemas/advertisement_search_terms" }, "advertisement_start_dates": { "$ref": "#/components/schemas/advertisement_start_dates" }, "advertisement_end_dates": { "$ref": "#/components/schemas/advertisement_end_dates" }, "news_categories": { "$ref": "#/components/schemas/news_categories" }, "news_published_dates": { "$ref": "#/components/schemas/published_dates" }, "is_include_established": { "$ref": "#/components/schemas/expansion_is_include_established" }, "select_size": { "$ref": "#/components/schemas/expansion_select_size" }, "is_include_metadata": { "type": "boolean", "description": "返回完整的详细信息负载。API 密钥请求默认返回精简结果：除非此项为 `true`，否则将省略 `model` 区块、置信度数值（公司扩张详情中的 `stage.confidence`，以及 `other_markets[]` 和排名 `markers[]` 中的 `confidence_score`），以及 `established_min` / `share_of_detected` / `has_known_office` 字段。", "example": true }, "is_enable_similarity_search": { "type": "boolean", "description": "为 `verticals`、`vertical_categories`、`vertical_sub_categories` 与 `technologies` 启用自由文本匹配；未设为 `true` 时这些筛选条件会被丢弃。", "example": true } } } } } }, "responses": { "200": { "description": "经排名的公司/市场标记点。", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object" }, "data": { "type": "object", "description": "结果容器。", "properties": { "markers": { "type": "array", "description": "每个公司/市场组合一行，按扩张分数排序。", "items": { "type": "object", "properties": { "domain_search_id": { "type": "string", "description": "Pubrio 公司标识符。" }, "country_code": { "type": "string", "description": "目标市场，ISO 3166-1 alpha-2。" }, "stage_slug": { "type": "string", "description": "当前扩张阶段。" }, "expansion_score": { "type": "integer", "description": "该公司/市场组合的扩张分数。" }, "freshness": { "type": "string", "description": "底层信号的新鲜程度。" }, "direction": { "type": "string", "description": "阶段的走势方向。" } } } } } } } }, "example": { "metadata": { "filters": { "froms": [ "CN" ], "tos": [ "GB" ] }, "select_size": 250, "count": 1 }, "data": { "markers": [ { "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "country_code": "US", "stage_slug": "expanding", "expansion_score": 0.721, "freshness": "fresh", "direction": "advancing" } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/types": { "post": { "tags": [ "Expansion" ], "summary": "扩张筛选器", "description": "扩张分类法参考目录——阶段、信号类型、强度、极性、动量和新鲜度——用于解析其他扩张接口返回的取值。", "operationId": "expansions_types", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "扩张分类体系。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "结果容器。", "properties": { "stages": { "type": "array", "description": "扩张阶段，按排序排列。", "items": { "type": "object" } }, "signal_types": { "type": "array", "description": "信号类型，含层级与可用性。", "items": { "type": "object" } }, "signal_subtypes": { "type": "array", "description": "信号子类型，各自关联其父类型。", "items": { "type": "object" } }, "signal_subtypes_by_type": { "type": "object", "description": "按父信号类型分组的子类型。" }, "signal_strengths": { "type": "array", "description": "信号强度等级。", "items": { "type": "object" } }, "dimensions": { "type": "array", "description": "扩张分数背后的评分维度。", "items": { "type": "object" } }, "polarities": { "type": "array", "description": "可用的极性取值。", "items": { "type": "string" } }, "directions": { "type": "array", "description": "`stage.direction` 返回的方向取值。", "items": { "type": "string" } }, "freshness": { "type": "array", "description": "底层信号的新鲜程度。", "items": { "type": "string" } }, "event_date_precisions": { "type": "array", "description": "事件日期的精度等级。", "items": { "type": "string" } }, "presence_types": { "type": "array", "description": "存在感分类。", "items": { "type": "string" } }, "max_record_upload_size": { "type": "integer", "description": "每次批量上传接受的最大记录数。" } } } } }, "example": { "data": { "stages": [ { "slug": "exploring", "rank_order": 1, "name": { "en": "Exploring" } }, { "slug": "scaling", "rank_order": 4, "name": { "en": "Scaling" } } ], "signal_types": [ { "slug": "HIRE", "name": { "en": "Hiring" }, "tier": "standard", "is_available": true }, { "slug": "INFRA", "name": { "en": "Infrastructure" }, "tier": "premier", "is_available": true } ], "signal_strengths": [ { "slug": "low", "name": { "en": "Low" } }, { "slug": "very_high", "name": { "en": "Very High" } } ], "polarities": [ "expansion", "contraction_leading", "contraction_confirming", "contraction_lagging" ], "directions": [ "advancing", "steady", "retreating", "new" ], "freshness": [ "fresh", "cooling", "stale", "cold" ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/expansions/signals/search": { "post": { "tags": [ "Expansion" ], "summary": "扩张信号搜索", "operationId": "expansions_signals_search", "description": "原始的分页扩张信号记录——支撑各公司阶段判定的带日期证据，含来源与证据链接。", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_search_ids": { "type": "array", "description": "要限定的公司，按 `domain_search_id`。", "items": { "type": "string" }, "example": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ] }, "is_active": { "type": "boolean", "description": "仅返回有效信号（`true`）或仅返回已撤回信号（`false`）。省略则两者都返回。", "example": true }, "country_codes": { "type": "array", "description": "要限定的目标市场，使用 ISO 3166-1 alpha-2 代码。", "items": { "type": "string" }, "example": [ "US", "GB" ] }, "signal_types": { "allOf": [ { "$ref": "#/components/schemas/expansion_signal_type_slugs" } ], "description": "要限定的信号类型。无法识别的取值匹配不到结果。" }, "signal_subtypes": { "allOf": [ { "$ref": "#/components/schemas/expansion_signal_subtype_slugs" } ], "description": "要限定的信号子类型。无法识别的取值匹配不到结果。" }, "signal_strengths": { "allOf": [ { "$ref": "#/components/schemas/signal_strengths" } ], "description": "要限定的信号强度。无法识别的取值匹配不到结果。" }, "source_types": { "type": "array", "items": { "type": "string" }, "description": "要限定的来源类型：`jobs`、`ads`、`linkedin`、`news`、`pubrio`。", "example": [ "jobs", "ads" ] }, "polarities": { "type": "array", "items": { "type": "string", "enum": [ "expansion", "contraction_leading", "contraction_confirming", "contraction_lagging" ] }, "description": "要包含的信号方向。`expansion` 表示进入与增长；`contraction_*` 系列表示收缩。", "example": [ "expansion" ] }, "event_dates": { "$ref": "#/components/schemas/event_dates" }, "page": { "$ref": "#/components/schemas/page" }, "per_page": { "$ref": "#/components/schemas/per_page" } } } } } }, "responses": { "200": { "description": "扩张信号搜索", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "description": "本次请求所应用筛选条件的回显。" }, "data": { "type": "object", "description": "结果容器。", "properties": { "pagination": { "type": "object", "description": "页码、每页数量、条目总数与总页数。" }, "signals": { "type": "array", "description": "匹配的信号记录，按时间由新到旧排列。", "items": { "type": "object", "properties": { "expansion_signal_id": { "type": "integer", "description": "该信号记录的唯一标识符。" }, "domain_search_id": { "type": "string", "format": "uuid", "description": "该信号所属的公司。可配合 [Company Expansion Detail](/cn/api-reference/endpoint/expansions/company_lookup) 使用。" }, "country_code": { "type": "string", "description": "观测到该信号的目标市场，采用 ISO 3166-1 alpha-2 代码。" }, "signal_type_slug": { "type": "string", "description": "信号类型。为 [Expansion Reference](/cn/api-reference/endpoint/expansions/types) 返回的 17 个 slug 之一。" }, "signal_subtype_slug": { "type": "string", "nullable": true, "description": "更细粒度的子类型；当该类型没有子类型时为 `null`。约 44% 的记录为 `null`。" }, "signal_strength_slug": { "type": "string", "description": "信号强度：`low`、`medium`、`high` 或 `very_high`。" }, "polarity": { "type": "string", "description": "信号方向：`expansion`，或三个 `contraction_*` 值之一。" }, "event_date": { "type": "string", "format": "date-time", "description": "底层事件的发生时间。需结合 `event_date_precision` 一起理解。" }, "event_date_precision": { "type": "string", "description": "`event_date` 的精度：`day`、`month`、`quarter`、`year` 或 `unknown`。" }, "source_type": { "type": "string", "description": "信号的来源。已观测到的取值：`jobs`、`ads`、`linkedin`、`news`、`pubrio`。" }, "source_record_id": { "type": "string", "nullable": true, "description": "该信号所源自的源记录标识符（若存在）。" }, "display_label": { "type": "string", "description": "该信号的一行可读摘要。" }, "evidence_url": { "type": "string", "nullable": true, "description": "指向佐证材料的链接。经常为 `null`——多数记录源自结构化数据源，而非可引用的页面。" }, "metadata": { "type": "object", "description": "与来源相关的详细信息。其键随 `source_type` 变化——职位类记录包含 `departments`、`seniority`、`top_titles`、`active_postings`；广告类记录包含 `advertisement_format`、`headline`、`share_pct`。" }, "extraction_confidence": { "type": "number", "nullable": true, "description": "由模型抽取的信号的置信度；其他情况下为 `null`。" }, "extraction_model": { "type": "string", "nullable": true, "description": "执行抽取的模型名称（若使用了模型）。" }, "is_active": { "type": "boolean", "description": "有效信号为 `true`；信号被撤回后为 `false`。" }, "notes": { "type": "string", "nullable": true, "description": "自由文本备注。通常为 `null`。" }, "created_at": { "type": "string", "format": "date-time", "description": "该信号记录的创建时间。" }, "last_modified": { "type": "string", "format": "date-time", "description": "该信号记录的最后更新时间。" }, "source_published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "源文档的发布时间（若已知）。" }, "lead_time_days": { "type": "integer", "nullable": true, "description": "源发布时间与事件日期之间的天数（两者均已知时）。" }, "occurs_at": { "type": "string", "format": "date-time", "nullable": true, "description": "对于跨越一段时间的信号，表示该信号覆盖窗口的开始时间。" }, "occurs_until": { "type": "string", "format": "date-time", "nullable": true, "description": "对于跨越一段时间的信号，表示该信号覆盖窗口的结束时间。" }, "audit": { "type": "object", "description": "该记录的来源信息：用户导入的信号会带有 `profile_id` 与 `user_id`，`import_id` 用于归组一次批量导入，`is_backfill` 标记由历史回填添加的记录。", "properties": { "profile_id": { "type": "integer", "nullable": true }, "user_id": { "type": "string", "format": "uuid", "nullable": true }, "import_id": { "type": "string", "nullable": true }, "is_backfill": { "type": "boolean" } } } } } } } } } }, "example": { "metadata": { "filters": { "domain_search_ids": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ], "country_codes": [ "US" ], "signal_types": [ "HIRE", "AD" ] } }, "data": { "pagination": { "page": 1, "per_page": 25, "total_entries": 2990, "total_pages": 120 }, "signals": [ { "expansion_signal_id": 580965556, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "country_code": "US", "signal_type_slug": "HIRE", "signal_subtype_slug": "country_manager", "signal_strength_slug": "very_high", "polarity": "expansion", "event_date": "2026-06-20T14:00:00.000Z", "event_date_precision": "day", "source_type": "jobs", "source_record_id": "4224659596", "display_label": "Hired Country Manager", "evidence_url": "https://www.linkedin.com/jobs/view/4224659596", "metadata": { "city": "Austin", "country_code": "US", "departments": [ "sales" ], "seniority": [ "director" ], "top_titles": [ "Country Manager, US" ], "active_postings": 3, "window_days": 90 }, "extraction_confidence": 0.91, "extraction_model": null, "is_active": true, "notes": null, "created_at": "2026-06-20T15:02:11.004Z", "last_modified": "2026-06-20T15:02:11.004Z", "source_published_at": "2026-06-19T08:00:00.000Z", "lead_time_days": 1, "occurs_at": null, "occurs_until": null, "audit": { "profile_id": null, "user_id": null, "import_id": null, "is_backfill": false } }, { "expansion_signal_id": 580965557, "domain_search_id": "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c", "country_code": "US", "signal_type_slug": "AD", "signal_subtype_slug": null, "signal_strength_slug": "low", "polarity": "expansion", "event_date": "2026-06-18T08:12:25.866Z", "event_date_precision": "day", "source_type": "ads", "source_record_id": "3569a83d-6e96-4bc9-b1a7-abbfa8f4b1ad", "display_label": "Full-Stack Observability: 7 Tools Engineers Are Switching To in 2026", "evidence_url": null, "metadata": { "headline": "Full-Stack Observability: 7 Tools Engineers Are Switching To in 2026", "advertisement_format": "Single Image Ad", "source_type": "linkedin", "share_basis": "declared", "share_pct": null, "started_at": null, "ended_at": null }, "extraction_confidence": null, "extraction_model": null, "is_active": true, "notes": null, "created_at": "2026-06-18T08:12:25.883Z", "last_modified": "2026-06-18T08:12:25.883Z", "source_published_at": null, "lead_time_days": null, "occurs_at": null, "occurs_until": null, "audit": { "profile_id": null, "user_id": null, "import_id": null, "is_backfill": false } } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } }, "x-mint": { "content": "\n每次调用都需限定范围——传入 `domain_search_ids`，或 `country_codes` 搭配 `event_dates`。不限定范围或仅按日期筛选的请求会在网关处被丢弃并返回 **HTTP 524**。\n" } } }, "/companies/cloud_footprints/search": { "post": { "tags": [ "Search" ], "summary": "搜索公司云足迹", "description": "搜索公司公开的云与托管足迹：使用了哪些服务商、部署在哪些国家与区域。每条记录代表一家公司在一个服务商、一个国家的部署。参见 [云足迹搜索指南](/cn/developer-guides/search/cloud-footprint-search)。", "operationId": "companies_search_cloud_footprints", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "providers": { "$ref": "#/components/schemas/providers" }, "exclude_providers": { "$ref": "#/components/schemas/exclude_providers" }, "target_locations": { "$ref": "#/components/schemas/target_locations" }, "exclude_target_locations": { "$ref": "#/components/schemas/exclude_target_locations" }, "cloud_regions": { "$ref": "#/components/schemas/cloud_regions" }, "exclude_cloud_regions": { "$ref": "#/components/schemas/exclude_cloud_regions" }, "cities": { "$ref": "#/components/schemas/cities" }, "exclude_cities": { "$ref": "#/components/schemas/exclude_cities" }, "first_seen_dates": { "$ref": "#/components/schemas/first_seen_dates" }, "last_seen_dates": { "$ref": "#/components/schemas/last_seen_dates" }, "is_cross_border_only": { "$ref": "#/components/schemas/is_cross_border_only" }, "host_count": { "$ref": "#/components/schemas/host_count" }, "server_count": { "$ref": "#/components/schemas/server_count" }, "shared_server_count": { "$ref": "#/components/schemas/shared_server_count" }, "region_count": { "$ref": "#/components/schemas/region_count" }, "city_count": { "$ref": "#/components/schemas/city_count" }, "cloud_footprint_host_count": { "$ref": "#/components/schemas/cloud_footprint_host_count" }, "cloud_footprint_server_count": { "$ref": "#/components/schemas/cloud_footprint_server_count" }, "cloud_footprint_shared_server_count": { "$ref": "#/components/schemas/cloud_footprint_shared_server_count" }, "cloud_footprint_provider_count": { "$ref": "#/components/schemas/cloud_footprint_provider_count" }, "cloud_footprint_country_count": { "$ref": "#/components/schemas/cloud_footprint_country_count" }, "cloud_footprint_cross_border_country_count": { "$ref": "#/components/schemas/cloud_footprint_cross_border_country_count" }, "cloud_footprint_region_count": { "$ref": "#/components/schemas/cloud_footprint_region_count" }, "cloud_footprint_city_count": { "$ref": "#/components/schemas/cloud_footprint_city_count" }, "company_locations": { "$ref": "#/components/schemas/company_locations" }, "cloud_footprint_id": { "$ref": "#/components/schemas/cloud_footprint_id" }, "cloud_footprint_ids": { "$ref": "#/components/schemas/cloud_footprint_ids" }, "companies": { "$ref": "#/components/schemas/companies" }, "domains": { "$ref": "#/components/schemas/domains" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "page": { "$ref": "#/components/schemas/page" }, "is_ascending_order": { "$ref": "#/components/schemas/is_ascending_order" }, "cloud_footprint_providers": { "$ref": "#/components/schemas/cloud_footprint_providers" }, "cloud_footprint_target_locations": { "$ref": "#/components/schemas/cloud_footprint_target_locations" }, "cloud_footprint_primary_provider": { "$ref": "#/components/schemas/cloud_footprint_primary_provider" }, "domain": { "$ref": "#/components/schemas/domain" }, "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "linkedin_urls": { "$ref": "#/components/schemas/company_linkedin_urls" }, "filter_conditions": { "$ref": "#/components/schemas/cloud_footprint_filter_conditions" } } } } } }, "responses": { "200": { "description": "分页的云足迹记录。", "content": { "application/json": { "schema": { "type": "object" }, "example": { "metadata": { "profile": null, "filters": { "page": 1, "per_page": 1, "is_cross_border_only": true, "language": "en" }, "ignored_fields": [] }, "data": { "pagination": { "page": 1, "per_page": 1, "total_entries": 48700, "total_pages": 48700, "total_display_pages": 250, "is_timeout": false }, "cloud_footprints": [ { "cloud_footprint_id": "042fee02-5121-4f23-a166-69bc48e9dfe8", "domain_search_id": "2ebd09b1-3bdf-4bf0-9732-c2ed6a734f77", "provider": "AWS", "country_code": "US", "company_country_code": "CL", "is_home_market": false, "host_count": 232, "server_count": 3, "shared_server_count": 0, "region_count": 1, "city_count": 0, "cloud_regions": [ "us-east-1" ], "cities": null, "first_seen_at": "2026-07-26T16:57:20.362Z", "last_seen_at": "2026-09-04T10:07:09.799Z", "last_modified": "2026-09-04T10:26:52.183Z", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/MTc4ODM0MDY5Nmlsajlzc25qMXJ0aWFwLmNvbWxpbmtlZGluXzQ3Njc2Nzkw.jpg", "domain_search_id": "2ebd09b1-3bdf-4bf0-9732-c2ed6a734f77", "company_name": "RTIAP Soluciones Tecnológicas SpA", "linkedin_name": "rtiap", "country_code": "CL", "company_url": "http://www.rtiap.com", "domain": "rtiap.com" }, "evidence_url": "https://www.pubrio.com/evidence/84c941ea04a8fa9ed1bbeabc8ff496a7" } ] } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/companies/cloud_footprints/lookup": { "post": { "tags": [ "Lookup" ], "summary": "查询公司云足迹", "description": "按标识符返回单条云足迹记录，包含其云区域、城市，以及近期基础设施样本。参见 [云足迹搜索指南](/cn/developer-guides/search/cloud-footprint-search)。", "operationId": "companies_lookup_cloud_footprint", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "cloud_footprint_id" ], "properties": { "cloud_footprint_id": { "$ref": "#/components/schemas/cloud_footprint_id" } } } } } }, "responses": { "200": { "description": "单条云足迹记录，含区域、城市与主机样本。", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": { "country_name": "United States", "hosts": [ { "city": "Chicago", "cloud_region": null, "last_seen_at": "2026-09-03T23:09:52.811787", "first_seen_at": "2026-09-03T23:09:52.811787" }, { "city": "Chicago", "cloud_region": null, "last_seen_at": "2026-07-28T16:23:24.323615", "first_seen_at": "2026-07-28T16:23:24.323615" } ], "regions": [], "cloud_footprint_id": "e82b2bd0-9971-41da-809b-ee4f2cf3305e", "domain_search_id": "01604baf-ab2d-4930-a867-2fced349f4f4", "provider": "Linode", "country_code": "US", "company_country_code": "IN", "is_home_market": false, "host_count": 2, "server_count": 3, "shared_server_count": 3, "region_count": 0, "city_count": 1, "cloud_regions": null, "cities": [ "Chicago" ], "first_seen_at": "2026-07-28T16:23:24.323Z", "last_seen_at": "2026-09-03T23:09:52.811Z", "last_modified": "2026-09-04T09:30:52.103Z", "companies": { "logo_url": "https://buckets.pubrio.com/company-logo/OTg2Mzk1MjVpbGo5c3NuajFiaG9wYWxzZXJ2aWNlY2VudHJlLmNvbQ==.jpg", "domain_search_id": "01604baf-ab2d-4930-a867-2fced349f4f4", "company_name": "bhopalservicecentre.com", "linkedin_name": null, "country_code": "IN", "company_url": "http://www.bhopalservicecentre.com", "domain": "bhopalservicecentre.com" }, "evidence_url": "https://www.pubrio.com/evidence/9c6ae876b7bf39f0a5beed66a7ad689e" } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } }, "/companies/cloud_footprints/insights": { "post": { "tags": [ "Insights" ], "summary": "云足迹洞察", "description": "单家公司的云足迹汇总：总量、主要服务商、国家与区域、每周新增基础设施序列，以及最新新增项。参见 [云足迹搜索指南](/cn/developer-guides/search/cloud-footprint-search)。", "operationId": "companies_cloud_footprint_insights", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_search_id" ], "properties": { "domain_search_id": { "$ref": "#/components/schemas/domain_search_id" }, "date_from": { "$ref": "#/components/schemas/date_from" }, "date_to": { "$ref": "#/components/schemas/date_to" } } } } } }, "responses": { "200": { "description": "该公司的云足迹汇总。", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": { "totals": { "hosts": 12713, "servers": 20403, "providers": 15, "countries": 18, "cross_border_countries": 17, "regions": 47, "new_hosts": 12713 }, "providers": [ { "key": "DigitalOcean", "hosts": 6085, "servers": 11404, "countries": 6 }, { "key": "AWS", "hosts": 4077, "servers": 6242, "countries": 9 }, { "key": "Vultr", "hosts": 958, "servers": 1075, "countries": 4 } ], "countries": [ { "key": "US", "name": "United States", "hosts": 12542, "servers": 20152, "providers": 14, "is_cross_border": false, "evidence_url": null }, { "key": "CA", "name": "Canada", "hosts": 81, "servers": 116, "providers": 6, "is_cross_border": true, "evidence_url": "https://www.pubrio.com/evidence/a773e15a61cdaad85009a0d1cc6e93d2" }, { "key": "DE", "name": "Germany", "hosts": 24, "servers": 36, "providers": 4, "is_cross_border": true, "evidence_url": "https://www.pubrio.com/evidence/e6b59784382beb482a6d932c99403b99" } ], "regions": [ { "provider": "AWS", "region_code": "us-east-1", "region_name": "N. Virginia", "city": "Ashburn", "country_code": "US", "hosts": 1953, "servers": 2989 }, { "provider": "AWS", "region_code": "us-east-2", "region_name": "Ohio", "city": "Columbus", "country_code": "US", "hosts": 1426, "servers": 2173 }, { "provider": "AWS", "region_code": "us-west-2", "region_name": "Oregon", "city": "Portland", "country_code": "US", "hosts": 587, "servers": 944 } ], "weekly_series": [ { "week_start": "2026-07-20", "count": 40 }, { "week_start": "2026-07-27", "count": 2547 }, { "week_start": "2026-08-03", "count": 2621 }, { "week_start": "2026-08-10", "count": 2781 } ], "recent_hosts": [ { "provider": "AWS", "country_code": "US", "cloud_region": "us-east-1", "city": null, "first_seen_at": "2026-09-04T05:53:40.173866", "last_seen_at": "2026-09-04T05:53:40.173866", "is_cross_border": false }, { "provider": "DigitalOcean", "country_code": "US", "cloud_region": null, "city": "Clifton", "first_seen_at": "2026-09-04T05:45:51.263133", "last_seen_at": "2026-09-04T05:45:51.263133", "is_cross_border": false }, { "provider": "DigitalOcean", "country_code": "US", "cloud_region": null, "city": "Clifton", "first_seen_at": "2026-09-04T05:45:51.263133", "last_seen_at": "2026-09-04T05:45:51.263133", "is_cross_border": false } ], "window_days": 90 } } } } }, "400": { "$ref": "#/components/responses/general_error" }, "429": { "$ref": "#/components/responses/rate_limit_error" }, "500": { "$ref": "#/components/responses/server_error" } } } } }, "externalDocs": { "description": "Pubrio API 用于搜索、预览和增强联系人及账户信息。Pubrio 数据库提供丰富的 B2B 联系人和销售情报数据。", "url": "https://docs.pubrio.com" }, "components": { "schemas": { "is_default": { "type": "boolean", "description": "启用后，执行将把当前记录设置为 true，并将所有其他受影响的链接记录组设置为 false。" }, "channel_template_id": { "type": "string", "format": "uuid", "description": "渠道模板操作的唯一标识符。" }, "channel_template_parameters": { "type": "object", "description": "参数信息取决于渠道节点要求。" }, "version_name": { "type": "string", "example": "default", "description": "版本名称提供了一种识别变更历史的方法。" }, "channel_node_id": { "type": "string", "format": "uuid", "description": "渠道节点操作的唯一标识符。" }, "is_entire_templates": { "type": "boolean", "description": "启用后，执行将应用于渠道模板内的整个版本。" }, "channel_templates": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2 ], "description": "用于搜索特定渠道模板的 `channel_template_id `列表。" }, "channel_nodes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "用于搜索特定渠道节点的 `channel_node_id` 列表。" }, "channel_template_name": { "type": "string", "example": "channel template", "description": "过滤搜索结果以包含特定的渠道模板名称。" }, "channel_types": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2 ], "description": "用于搜索特定渠道类型的 `channel_type_id` 列表。" }, "channel_template_identifier": { "type": "string", "format": "uuid", "description": "渠道模板版本组的标识符。" }, "domain_search_id": { "type": "string", "format": "uuid", "description": "用于公司检索操作的唯一标识符。" }, "domain_id": { "type": "integer", "description": "用于域名检索操作的唯一标识符。" }, "job_search_id": { "type": "string", "format": "uuid", "example": "371d0c44-4c56-4c9c-98e2-ef6dd986b848", "description": "用于公司职位检索操作的唯一标识符。" }, "news_search_id": { "type": "string", "format": "uuid", "example": "4110b929-17cd-42aa-a159-906ead0c9b56", "description": "用于公司新闻检索操作的唯一标识符。" }, "people_search_id": { "type": "string", "format": "uuid", "description": "用于人员检索操作的唯一标识符。" }, "redeem_query_id": { "type": "string", "format": "uuid", "description": "当发起批量兑换请求时，会返回一个 `redeem_query_id`，可在此用于获取结果。" }, "peoples": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "用于用戶检索操作的一组唯一标识符（people_search_id）列表。" }, "companies": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "用于公司和人员检索操作的一组唯一标识符（domain_search_id）列表。" }, "domain": { "type": "string", "example": "pubrio.com", "description": "用于公司检索操作的公司域名。如果收到的地址为 `www.pubrio.com` 或 `https://docs.pubrio.com/`，系统会自动转换为 `pubrio.com` 进行处理。" }, "domains": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio.com" ], "description": "用于公司和人员检索操作的公司域名列表。如果收到的地址为 `www.pubrio.com` 或 `https://docs.pubrio.com/`，系统会自动转换为 `pubrio.com` 进行处理。" }, "people_contact_types": { "type": "array", "items": { "type": "string", "enum": [ "email-work", "email-personal", "phone" ] }, "example": [ "email-work", "email-personal", "phone" ], "description": "要兑换的联系方式类型。请严格使用 `email-work`、`email-personal` 和/或 `phone` —— 可通过 Filters 标签下的 `people contact type` 端点获取实时列表。\n\n**无法识别的取值不会被拒绝。** 例如误写为 `work_email` 会返回 HTTP 200，且 `emails: null`、`phones: null`、`total_credit_cost: 0` —— 与该联系人确实没有联系方式的结果完全相同。若兑换结果普遍为空，请先检查这些标识拼写。" }, "contact_lookup_email": { "type": "string", "format": "email", "example": "person@example.com", "description": "要查找的工作或个人电子邮箱地址。系统会在匹配前规范化大小写和空白字符。" }, "contact_lookup_phone": { "type": "string", "example": "+15551234567", "description": "要查找的电话号码。建议使用国际格式（E.164）。" }, "contact_lookup_first_name": { "type": "string", "example": "King", "description": "名字。当 `is_enable_similarity_search` 为 `true` 时，与 `last_name` 以及 `domain` 或 `company` 配合使用。" }, "contact_lookup_last_name": { "type": "string", "example": "Lai", "description": "姓氏。当 `is_enable_similarity_search` 为 `true` 时，与 `first_name` 以及 `domain` 或 `company` 配合使用。" }, "contact_lookup_company": { "type": "string", "example": "Pubrio", "description": "公司名称。当 `is_enable_similarity_search` 为 `true` 且未提供 `domain` 时，与 `first_name` + `last_name` 一起作为相似度搜索的锚点。" }, "contact_lookup_domain": { "type": "string", "example": "pubrio.com", "description": "公司域名。当 `is_enable_similarity_search` 为 `true` 时，与 `first_name` + `last_name` 一起作为相似度搜索的锚点。" }, "contact_lookup_is_enable_similarity_search": { "type": "boolean", "default": false, "example": true, "description": "设为 `true` 时，若未找到精确匹配的邮箱/电话，将回退到基于姓名的相似度匹配。需要提供 `first_name`、`last_name` 以及 `domain` 或 `company`。" }, "contact_lookup_peoples": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": "string" }, "domain": { "type": "string" } } }, "example": [ { "email": "king.lai@pubrio.com" }, { "first_name": "John", "last_name": "Smith", "domain": "example.com" } ], "description": "查询规格数组。每个条目接受与单条查询请求体相同的标识符（`email`、`phone`，或在启用相似度搜索时使用 `first_name` + `last_name` + `domain`/`company`）。受订阅计划的批量上限约束。" }, "advertisement_source_types": { "type": "array", "items": { "type": "string", "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ] }, "example": [ "linkedin", "facebook" ], "description": "要包含的来源：`linkedin`、`facebook`（接受 `meta`）、`google`、`tiktok`、`apple`。未知值不匹配任何结果，并回显在 `metadata.unsupported_source_types` 中。" }, "advertisement_enrichment_mode": { "type": "string", "enum": [ "default", "latest" ], "default": "default", "example": "latest", "description": "控制实时数据增强行为。`default` 返回数据库中已有的数据，仅当结果为空且设置了 `is_realtime_enrichment` 时才触发增强。`latest` 会绕过缓存，并在每次调用时针对最新的源记录强制执行重新增强——即使未设置其他任何标志，它本身也会触发增强。" }, "is_realtime_enrichment": { "type": "boolean", "default": false, "example": true, "description": "为单一公司范围的查询（通过 `domain_search_id`、`domains` 或 `linkedin_urls` 过滤）启用实时数据增强。当初次搜索返回 0 条结果时，系统会抓取来源数据、写入记录后重新执行搜索再返回。受每条路由的超时限制约束。" }, "people_titles": { "type": "array", "items": { "type": "string" }, "example": [ "sales manager", "marketing manager" ], "description": "与目标人员相关的职位名称。\n\n结果还将包含包含类似术语的职位，即使不完全匹配。例如，搜索 `software engineer` 也可能返回职位为 `senior software engineer` 的人员。" }, "management_levels": { "type": "array", "items": { "type": "string", "enum": [ "c_suite", "director", "entry", "founder", "head", "intern", "manager", "owner", "partner", "senior", "vp" ] }, "example": [ "c_suite", "vp" ], "description": "人员的汇报层级。高管层的 slug 是 `c_suite` 而非 `c_level`。存在其他人员筛选器时，未知 slug 会被丢弃；当它是唯一筛选器时返回 `40037`。完整列表见 Filters 下的 `management level` 端点。" }, "departments": { "type": "array", "items": { "type": "string" }, "example": [ "master_human_resources" ], "description": "部门字段可用于搜索特定专业领域的人员。\n\n更多信息请参见筛选器标签下的 `department` 端点。" }, "functions": { "type": "array", "items": { "type": "string" }, "example": [ "human_resources" ], "description": "职位职能筛选字段可在搜索人员时指定特定岗位或专业领域。\n\n更多信息请参见筛选器标签下的 `department functions` 端点。" }, "locations": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "ISO 3166-1 alpha-2（cca2）用于筛选地区。更多信息请参见筛选器标签下的 `location` 端点。" }, "exclude_locations": { "type": "array", "items": { "type": "string" }, "example": [ "CN", "US", "RU", "CA" ], "description": "ISO 3166-1 alpha-2（cca2）用于筛选不需要返回的地区。更多信息请参见筛选器标签下的 `location` 端点。" }, "founded_dates": { "type": "array", "items": { "type": "integer" }, "example": [ 2018, 2024 ], "description": "公司成立年份范围。最大值为当前年份。" }, "posted_dates": { "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "发布日期的时间范围。最大值为当天。日期边界遵循你的工作区时区。" }, "published_dates": { "type": "array", "items": { "type": "string" }, "example": [ "2025-01-01", "2025-01-10" ], "description": "发布时间的时间范围。最大值为当天。日期边界遵循你的工作区时区。" }, "employees": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ 1, 10 ], [ 11, 20 ], [ 10001 ] ], "description": "公司员工人数范围。可根据员工总数筛选公司，并可添加多个范围以扩展搜索结果。\n\n更多信息请参见筛选器标签下的 `company size` 端点。" }, "revenues": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 100000 ], "description": "公司收入的最小值和最大值范围。" }, "company_locations": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "公司总部所在地。更多信息请参见筛选器标签下的 `location` 端点。" }, "people_locations": { "type": "array", "items": { "type": "string" }, "example": [ "US", "SG", "CN" ], "description": "用戶地点。更多信息请参见筛选器标签下的 `location` 端点。" }, "keyword": { "type": "string", "description": "通过关键词搜索条目。如果仅需获取前几个（而非全部）条目，可留空。" }, "technologies": { "type": "array", "items": { "type": "integer" }, "description": "`tag_id` 列表，用于搜索公司所用的特定技术。要获取ID，请调用筛选器标签下的 `technology` 端点。\n\n该筛选器支持 `is_enable_similarity_search`，启用后可输入任意自由文本，例如 `[\"Shopify\"]`。" }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "`category_id` 列表，用于搜索公司所用的特定技术类别。要获取ID，请调用筛选器标签下的 `category` 端点。\n\n该筛选器支持 `is_enable_similarity_search`，启用后可输入任意自由文本，例如 `[\"CDN\"]`。" }, "news_gallery_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "`news_gallery_id` 列表，用于搜索特定新闻库。要获取ID，请调用筛选器标签下的 `news galleries` 端点。" }, "news_categories": { "type": "array", "items": { "type": "string" }, "example": [ "launches" ], "description": "`category slugs` 列表，用于搜索特定新闻类别。要获取 slug，请调用筛选器标签下的 `news categories` 端点。" }, "verticals": { "type": "array", "items": { "type": "integer" }, "description": "`vertical_id` 列表，用于搜索特定垂直行业或领域的公司。要获取ID，请调用筛选器标签下的 `vertical` 端点。\n\n该筛选器支持 `is_enable_similarity_search`，启用后可输入任意自由文本，例如 `[\"AI\"]`。" }, "vertical_categories": { "type": "array", "items": { "type": "integer" }, "description": "`vertical_category_id` 列表，用于搜索特定垂直行业类别的公司。要获取ID，请调用筛选器标签下的 `vertical category` 端点。\n\n该筛选器支持 `is_enable_similarity_search`，启用后可输入任意自由文本，例如 `[\"Information Technology\"]`。" }, "vertical_sub_categories": { "type": "array", "items": { "type": "integer" }, "description": "`vertical_sub_category_id` 列表，用于搜索特定垂直行业子类别的公司。要获取ID，请调用筛选器标签下的 `vertical sub category` 端点。\n\n该筛选器支持 `is_enable_similarity_search`，启用后可输入任意自由文本，例如 `[\"Software\"]`。" }, "company_name": { "type": "string", "example": "pubrio", "description": "筛选搜索结果，仅包含指定公司名称。\n\n如果输入的值与公司名称不匹配，则该公司不会出现在搜索结果中，即使其他参数匹配也不会。支持部分匹配。" }, "search_term": { "type": "string", "example": "pubrio", "description": "用于筛选结果的关键词字符串。" }, "search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "pubrio" ], "description": "用于筛选结果的关键词字符串列表。" }, "target_locations": { "type": "array", "items": { "type": "string" }, "example": [ "TW", "AE", "NO" ], "description": "结果必须面向的国家代码。默认与 `filter_conditions` 以 OR 组合 — 命中其中任一即匹配。" }, "exclude_target_locations": { "type": "array", "items": { "type": "string" }, "example": [ "IS", "GB", "FR", "IE", "ES" ], "description": "结果不得面向的国家代码。默认与 `filter_conditions` 以 OR 组合 — 命中其中任一即匹配。" }, "headlines": { "type": "array", "items": { "type": "string" }, "example": [ "ASUS", "iPhone" ], "description": "用于筛选搜索结果的标题列表。" }, "ads_filter_conditions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "target_locations", "exclude_target_locations" ], "example": "exclude_target_locations", "description": "指定应用操作符的筛选键。" }, "operator": { "type": "string", "enum": [ "or", "and" ], "example": "or", "description": "要应用的逻辑操作符。使用 'or' 匹配排除任何指定地点的广告，或使用 'and' 匹配排除所有指定地点的广告。" } } }, "description": "广告搜索的高级筛选选项。指定条件以优化广告搜索端点的搜索结果。" }, "start_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-01", "2025-12-01" ], "description": "用于筛选搜索结果的开始日期列表。" }, "end_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "用于筛选搜索结果的结束日期列表。" }, "advertisement_search_id": { "type": "string", "format": "uuid", "example": "a92643e8-9033-4029-aa65-ef929327cebb", "description": "广告搜索结果的唯一标识符。用于引用从广告搜索端点返回的特定广告。" }, "keywords": { "type": "array", "items": { "type": "string" }, "example": [ "ecommerce", "ai", "fintech" ], "description": "用于按相关性、专业或描述对公司进行关键词筛选的列表。" }, "advertisement_target_locations": { "allOf": [ { "$ref": "#/components/schemas/target_locations" } ], "description": "广告的目标地理位置。" }, "advertisement_exclude_target_locations": { "allOf": [ { "$ref": "#/components/schemas/exclude_target_locations" } ], "description": "从广告定位中排除的地理位置。" }, "advertisement_search_terms": { "type": "array", "items": { "type": "string" }, "example": [ "asus" ], "description": "用于在广告内容或标题中搜索的关键词。" }, "advertisement_start_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "用于广告筛选的起始日期范围。" }, "advertisement_end_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2025-12-25", "2025-12-25" ], "description": "用于广告筛选的结束日期范围。" }, "advertisement_active_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "example": [ "2026-01-01", "2026-01-31" ], "description": "查找在此日期范围内任意时间点仍处于投放状态的广告(基于重叠判定:包含在该范围开始前就已投放、且持续至今仍在投放的广告,而不仅是在范围内才开始投放的广告)。" }, "advertisement_headlines": { "type": "array", "items": { "type": "string" }, "example": [ "limited time offer" ], "description": "用于在广告标题文本中搜索的关键词。" }, "advertisement_platforms": { "type": "array", "items": { "type": "string", "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ] }, "example": [ "linkedin", "facebook" ], "description": "按投放广告所来源的广告库进行筛选。使用小写，且不区分大小写。`meta` 可作为 `facebook` 的别名使用。" }, "advertisement_formats": { "type": "array", "items": { "type": "string", "enum": [ "image", "video", "text", "carousel", "dynamic_product", "document", "message", "event", "article", "spotlight", "follow", "job", "engagement" ] }, "example": [ "image", "video" ], "description": "查找至少有一条广告采用以下任一创意形式的公司。" }, "advertisement_active_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "公司当前活跃广告数量的最小值和最大值，统计范围为所有国家。使用 `null` 表示开放边界，例如 `[1, null]` 表示\"至少一条活跃广告\"。" }, "advertisement_running_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "公司仍在投放中的广告数量的最小值和最大值（无结束日期，或结束日期在未来）。目前仅针对 LinkedIn 广告填充此数据。" }, "advertisement_total_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 10, null ], "description": "公司有记录以来的广告总数的最小值和最大值，统计范围为所有国家。" }, "advertisement_platform_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 2, null ], "description": "公司当前正在投放广告的不同广告平台（linkedin、facebook、google、tiktok、apple）数量的最小值和最大值。" }, "advertisement_format_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 2, null ], "description": "公司当前正在投放的不同广告创意形式数量的最小值和最大值。" }, "advertisement_impressions_estimate": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1000, null ], "description": "预估广告展示次数的最小值和最大值，为所有国家的总和。仅统计具有已报告展示次数区间的广告。" }, "advertisement_country_activity": { "type": "object", "properties": { "country": { "type": "string", "example": "US", "description": "用于限定本筛选器适用范围的 ISO 3166-1 alpha-2 国家代码。必填。" }, "rank": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ null, 500 ], "description": "该国家内按广告投放量计算的排名。1 代表投放量最大的广告主，广告投放量越小，排名数字越大。使用 `[null, 500]` 可查找该国投放量最大的前 500 名广告主；使用 `[500, null]` 可查找排名第 500 位及以后的所有广告主。" }, "percentile": { "type": "array", "items": { "type": "number", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 90, null ], "description": "该国家内按广告投放量计算的百分位，取值 0-100。数值越高代表投放量越大。使用 `[90, null]` 可查找该国投放量排名前 10% 的广告主。" }, "volume_score": { "type": "array", "items": { "type": "number", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 0.5, null ], "description": "`rank` 与 `percentile` 均基于此计算得出的底层广告投放量评分，取值 0-1。" }, "active_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "限定于该国家的活跃广告数量的最小值和最大值。" }, "running_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "限定于该国家的仍在投放中广告数量的最小值和最大值。目前仅针对 LinkedIn 广告填充此数据。" }, "total_ads": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 10, null ], "description": "限定于该国家的广告总数的最小值和最大值。" }, "impressions": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1000, null ], "description": "限定于该国家的预估展示次数的最小值和最大值。" }, "first_seen": { "type": "array", "items": { "type": "string", "nullable": true, "format": "date" }, "minItems": 2, "maxItems": 2, "example": [ "2026-07-01", null ], "description": "[from, to] 时间窗口，用于筛选公司在该国最早投放广告的时间——即“新进入该市场”过滤器。任一端可为 null 表示不设边界；日期采用请求时区。广告没有开始日期的公司没有首次投放值，不会被视为新进入。" }, "last_seen": { "type": "array", "items": { "type": "string", "nullable": true, "format": "date" }, "minItems": 2, "maxItems": 2, "example": [ "2026-07-01", null ], "description": "[from, to] 时间窗口，用于筛选公司在该国最近一次投放广告的时间，回答相反的问题：谁在该市场沉寂了。" } }, "required": [ "country" ], "example": { "country": "US", "rank": [ null, 500 ] }, "description": "特定国家的广告投放活动。`country` 为必填项，且必须至少设置一个其他字段（仅提供国家本身不会匹配任何结果）。若需要所有国家的汇总数据，请改用顶层的 `advertisement_active_ads` / `advertisement_total_ads` / `advertisement_impressions_estimate` 筛选器。" }, "places": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "用于筛选结果的地点名称（城市或地区）。接受本地化或英文地点名称。" }, "exclude_places": { "type": "array", "items": { "type": "string" }, "example": [ "Tokyo" ], "description": "要从结果中排除的地点名称（城市或地区）。接受本地化或英文地点名称。" }, "job_exclude_locations": { "allOf": [ { "$ref": "#/components/schemas/exclude_locations" } ], "description": "从职位发布结果中排除的地理位置。" }, "exclude_fields": { "type": "array", "items": { "type": "string" }, "example": [ "emails", "phones", "contacts" ], "description": "要从响应中排除的字段列表。" }, "is_company_filter_any_mode": { "type": "boolean", "description": "为 true 时，公司级筛选条件使用 OR 逻辑，而不是 AND。" }, "is_parameter_metadata_available": { "type": "boolean", "description": "指示请求中是否可用参数元数据。" }, "is_profile_metadata_available": { "type": "boolean", "description": "指示请求中是否可用配置文件元数据。" }, "company_filter_conditions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "keywords", "verticals", "vertical_categories", "vertical_sub_categories", "technologies", "categories", "advertisement_target_locations", "advertisement_exclude_target_locations", "advertisement_search_terms", "places", "exclude_places", "job_exclude_locations" ], "example": "keywords", "description": "指定要应用运算符的筛选键。" }, "operator": { "type": "string", "enum": [ "or", "and" ], "example": "or", "description": "要应用的逻辑运算符。使用 'or' 匹配任何指定值，或使用 'and' 要求匹配所有指定值。" } } }, "description": "公司搜索的高级筛选选项。指定结合键与逻辑运算符的条件以优化搜索结果。" }, "people_filter_conditions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "keywords", "verticals", "vertical_categories", "vertical_sub_categories", "technologies", "categories", "places", "exclude_places", "social_media" ], "example": "technologies", "description": "要应用运算符的筛选键。键名引用统一公司筛选的名称(使用 `places`,而不是 `company_places`)。" }, "operator": { "type": "string", "enum": [ "or", "and" ], "example": "and", "description": "要应用的逻辑运算符。使用 'or' 匹配任何指定值,或使用 'and' 要求匹配所有指定值。" } } }, "description": "/people/search 中的按键 AND/OR 覆盖。省略时默认为 OR。完整的键重映射参考请见“人员 + 公司筛选器”开发者指南。" }, "company_linkedin_url": { "type": "string", "example": "https://www.linkedin.com/company/pubrio", "description": "LinkedIn 公司主页的完整 URL。URL 需以 `http` 开头且包含 `linkedin.com/company/`。" }, "company_linkedin_urls": { "type": "array", "items": { "type": "string" }, "example": [ "https://www.linkedin.com/company/pubrio" ], "description": "LinkedIn 公司主页的完整 URL。URL 需以 `http` 开头且包含 `linkedin.com/company/`。" }, "people_linkedin_url": { "type": "string", "example": "http://www.linkedin.com/in/king-lai-605382b7", "description": "LinkedIn 用户主页的完整 URL。URL 需以 `http` 开头且包含 `linkedin.com/in/` 或 `linkedin.com/pub/`。" }, "people_linkedin_urls": { "type": "array", "items": { "type": "string" }, "example": [ "http://www.linkedin.com/in/king-lai-605382b7" ], "description": "LinkedIn 用户主页的完整 URL。URL 需以 `http` 开头且包含 `linkedin.com/in/` 或 `linkedin.com/pub/`。" }, "people_name": { "type": "string", "example": "king", "description": "筛选搜索结果，仅包含指定用戶姓名。" }, "page": { "type": "integer", "example": 1, "default": 1, "description": "页码，从 1 开始。上限为订阅中的 `max_search_page`（公司搜索为 `max_company_search_page`），可通过 [Profile](/cn/api-reference/endpoint/profile/profile) 获取。超出会返回 **HTTP 416**。" }, "per_page": { "type": "integer", "example": 25, "default": 25, "maximum": 25, "description": "每页记录数。默认 25，在大多数套餐下这也是上限 —— 该限制即订阅中的 `max_search_per_page`，可通过 [Profile](/cn/api-reference/endpoint/profile/profile) 获取。超出会返回 **HTTP 416** 及错误码 `41676`（公司与人物搜索为 `41613`），而不是自动截断结果。" }, "is_enable_similarity_search": { "type": "boolean", "description": "启用后，上述支持相似度搜索的筛选器可直接填写自由文本以检索特定ID。" }, "similarity_score": { "type": "number", "format": "float", "example": 0.7, "description": "需与 `is_enable_similarity_search` 配合使用。该数值用于分析特定 slug（如行业、技术）与用户输入的相似程度，数值越高，匹配越严格。" }, "data_array": { "type": "array", "nullable": true, "items": { "type": "object", "properties": {} }, "description": "响应信息取决于具体接口。" }, "data": { "type": "object", "nullable": true, "description": "响应信息取决于具体接口。" }, "response_saved_lists": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "profile_id": { "type": "integer" }, "group_id": { "type": "integer" }, "name": { "type": "string" }, "is_personal": { "type": "boolean" } } }, "description": "工作区中已保存的联系人或公司列表。" }, "company_filters": { "type": "object", "description": "公司级筛选器的包装对象。推荐分组方式 — 视觉上分开哪些键筛选*人员*(顶层)、哪些筛选*公司*。接受与顶层公司筛选器相同的键(如 `technologies`、`verticals`、`vertical_categories`、`vertical_sub_categories`、`categories`、`keywords`、`founded_dates`、`employees`、`revenues`、`company_locations`、`company_exclude_locations`、`company_places`、`company_exclude_places`、`companies`、`domains`、`company_linkedin_urls`、`is_enable_similarity_search`、`similarity_score`,以及 `filter_conditions`)。引擎在处理前会把此对象摊平到顶层 — 同名时顶层键优先。与 Monitor `company_filters` 结构一致。示例见筛选器概览开发者指南。", "example": { "company_locations": [ "US" ], "technologies": [ 37, 152 ], "founded_dates": [ 2015, 2023 ], "filter_conditions": [ { "key": "technologies", "operator": "and" } ] } }, "advertisement_publisher_platforms": { "type": "array", "items": { "type": "string", "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ] }, "example": [ "facebook", "instagram" ], "description": "按投放的平台版位筛选 Facebook/Meta 广告。使用小写，且不区分大小写。仅适用于 `facebook` 来源（其他来源为单一平台）。" }, "advertisement_exclude_publisher_platforms": { "type": "array", "items": { "type": "string", "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ] }, "example": [ "audience_network" ], "description": "排除在这些平台版位投放的 Facebook/Meta 广告。" }, "advertisement_is_include_unlinked_companies": { "type": "boolean", "default": false, "example": true, "description": "包含尚未关联到已识别公司的广告（原始层广告，例如诈骗或临时专页广告）。默认为 false，仅返回已关联公司的广告。" }, "date_from": { "type": "string", "format": "date", "example": "2026-01-01", "description": "日期窗口的起始（ISO 8601，YYYY-MM-DD）。与 `date_to` 配合使用，以将结果限定到特定范围；两者都省略则使用默认窗口。" }, "date_to": { "type": "string", "format": "date", "example": "2026-03-31", "description": "日期窗口的结束（ISO 8601，YYYY-MM-DD）。必须等于或晚于 `date_from`。" }, "window_days": { "type": "integer", "example": 90, "description": "可选。滚动时间窗口的天数。在未提供明确的 `transitioned_dates` 范围时使用;若两者均未提供,则使用默认时间窗口。" }, "timezone": { "type": "string", "example": "America/New_York", "description": "用于按本地日对时间序列分桶的 IANA 时区名称。默认为 UTC。" }, "expansion_country_code": { "type": "string", "example": "US", "description": "目标市场，采用 ISO 3166-1 alpha-2（cca2）国家代码。省略时将自动选择该公司最活跃的单个市场；如需所有市场的跨市场视图，请设置 `is_all_markets`。" }, "expansion_momentum": { "type": "array", "items": { "type": "string", "enum": [ "advancing", "steady", "pulling_back" ] }, "example": [ "advancing", "steady" ], "description": "用于筛选的走势。仅接受 `advancing`、`steady` 与 `pulling_back`；[Expansion Reference](/cn/api-reference/endpoint/expansions/types) 中的 `directions` 取值仅用于响应。" }, "expansion_freshness": { "type": "array", "items": { "type": "string", "enum": [ "fresh", "cooling", "stale", "cold" ] }, "example": [ "fresh", "cooling" ], "description": "按证据近期性筛选：fresh（约 30 天）、cooling（约 30–60 天）、stale（约 60–90 天）、cold（超过 90 天）。" }, "expansion_sort_by": { "type": "string", "enum": [ "recent", "expansion_score", "signal_count", "company_ranking" ], "example": "expansion_score", "description": "结果排序方式。留空则使用默认的相关性排序：获得多种信号相互印证的组合在前（2 种及以上不同信号类型），其次是证据反复出现的组合（3 条及以上信号），最后是其余结果——每一层内按最近变更时间排序。`recent` —— 纯按时间排序（最近变更在前）。`expansion_score` —— 按扩张分数从高到低排序。`signal_count` —— 按该组合的信号数量从多到少排序。`company_ranking` —— 按 Pubrio 的整体公司排名排序（数值越小代表越知名），从小到大排列。" }, "expansion_scopes": { "type": "array", "items": { "type": "string", "enum": [ "entering_new_market", "expanding_within_presence", "established_only" ] }, "example": [ "entering_new_market" ], "description": "按市场进入范围筛选。" }, "expansion_stage_slug": { "type": "string", "enum": [ "exploring", "committing", "expanding", "scaling" ], "example": "committing", "description": "筛选到单一的扩张阶段。阶段定义参见扩张信号知识库。" }, "expansion_signal_type_slugs": { "type": "array", "items": { "type": "string", "enum": [ "AD", "AUDIENCE", "DNS", "ENTITY", "EVENT", "EVENT_PLUS", "EXEC", "HIRE", "INFRA", "IP", "NEWS", "OFFICE", "PARTNER", "PRODUCT", "REG", "SCALE", "TECH" ] }, "example": [ "EXEC", "HIRE" ], "description": "筛选到特定的信号类型。各类型的定义和层级请参见知识库中的信号类型目录（`DNS` 和 `INFRA` 为 Premier 级信号）。" }, "expansion_is_include_established": { "type": "boolean", "example": false, "description": "包含 `established` 阶段（无活跃扩张信号的长期运营者）。默认为 false。" }, "expansion_is_include_metadata": { "type": "boolean", "example": true, "description": "API 密钥响应默认精简。设为 true 可包含完整的 `metadata` 块（聚合数据、top origins/destinations、top industries、timeline）以及每家公司的模型细节。" }, "industries": { "type": "array", "items": { "type": "string" }, "example": [ "software", "financial services" ], "description": "按行业名称筛选（自由文本匹配）。" }, "exclude_industries": { "type": "array", "items": { "type": "string" }, "example": [ "tobacco" ], "description": "要排除的行业（自由文本匹配）。" }, "expansion_domain_search_ids": { "type": "array", "items": { "type": "string" }, "example": [ "8f3c1b04-2e7a-4d19-9c55-6ab21f0e7d3c" ], "description": "要包含的公司标识符（domain_search_id UUID）。" }, "expansion_select_size": { "type": "integer", "example": 50, "description": "返回记录的最大数量。受您的套餐限制。" }, "expansion_ids": { "type": "array", "items": { "type": "integer" }, "example": [ 12345, 12346 ], "description": "要导出的扩张记录标识符，由扩张列表端点返回。" }, "only_contraction": { "type": "boolean", "example": false, "description": "为 true 时，仅返回标记为收缩的扩张记录（正在收缩规模的公司）。" }, "signal_strengths": { "type": "array", "items": { "type": "string", "enum": [ "low", "medium", "high", "very_high" ] }, "example": [ "high" ], "description": "按证据置信度分档筛选：`low`、`medium` 或 `high`。注意它不同于信号记录上返回的单条信号 `signal_strength_slug`（其范围为 `low` 到 `very_high`）；此处传入其他任何值都不会匹配任何结果。" }, "expansion_stages": { "type": "array", "items": { "type": "string", "enum": [ "exploring", "committing", "expanding", "scaling" ] }, "example": [ "committing", "expanding" ], "description": "筛选至一个或多个扩张阶段。阶段的具体定义请参见 Expansion Signals 知识库。" }, "expansion_is_all_markets": { "type": "boolean", "example": false, "description": "在一次调用中返回公司在所有市场的整体扩张情况，而非单一市场。设为 `true` 时，将忽略 `country_code`，在能够识别本土市场时将其从信号汇总中排除，`data` 变为公司级别的汇总（主导阶段、信号总数、时间跨度、最高扩张分数），并且 `markets_summary` 列出每个市场。默认为 false。" }, "expansion_froms": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "来源市场（ISO 3166-1 alpha-2）。公司从哪些市场向外扩张 —— 即其总部 / 母国。单独使用可查找从这些市场向外扩张的公司；与 `tos` 组合可指定具体的来源→目标走廊。" }, "expansion_tos": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "目标市场（ISO 3166-1 alpha-2）。公司正在向哪些市场扩张。单独使用可查找进入这些市场的所有公司；与 `froms` 组合可指定具体的来源→目标走廊。" }, "expansion_exclude_froms": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "要排除的来源市场（ISO 3166-1 alpha-2）。" }, "expansion_exclude_tos": { "type": "array", "items": { "type": "string" }, "example": [ "US", "GB" ], "description": "要排除的目标市场（ISO 3166-1 alpha-2）。" }, "expansion_companies": { "type": "array", "items": { "type": "string" }, "example": [ "stripe.com", "https://www.linkedin.com/company/airbnb", "b7d92a56-31f8-4c0b-ae43-19c8e5f24b70" ], "description": "通过 `domain_search_id`、公司域名或公司社交媒体主页链接的任意组合来指定公司。域名和链接会解析为排名最高的公司。" }, "is_expansion_signal_available": { "type": "boolean", "description": "设为 `true` 时，会为每条新闻附加解析出的扩张信号（`expansion_signals`），并启用 `expansion_signal_types` / `expansion_signal_polarities` 筛选。若追求最快的搜索速度，请不要设置该参数——只有在开启此标志时才会加入扩张信号的关联查询。" }, "expansion_signal_types": { "type": "array", "items": { "type": "string", "enum": [ "AD", "AUDIENCE", "DNS", "ENTITY", "EVENT", "EVENT_PLUS", "EXEC", "HIRE", "INFRA", "IP", "NEWS", "OFFICE", "PARTNER", "PRODUCT", "REG", "SCALE", "TECH" ] }, "example": [ "HIRE", "PARTNER" ], "description": "仅返回产生了下列类型之一的扩张信号的新闻（大写 slug）。需要 `is_expansion_signal_available: true`。无法识别的 slug 会被忽略。" }, "expansion_signal_polarities": { "type": "array", "items": { "type": "string", "enum": [ "expansion", "contraction_leading", "contraction_confirming", "contraction_lagging" ] }, "example": [ "expansion" ], "description": "仅返回其扩张信号带有下列极性之一的新闻。需要 `is_expansion_signal_available: true`。与 `expansion_signal_types` 之间为 AND 关系。" }, "expansion_signal_subtype_slugs": { "type": "array", "items": { "type": "string", "enum": [ "marketing_pullback", "domain_dropped", "entity_dissolution", "exhibiting_booth", "speaking_breakout", "speaking_keynote", "sponsorship", "key_departure", "country_manager", "engineering", "freelancer", "hiring_freeze", "job_posting_removal", "legal_compliance", "local_employee", "operations", "regional_vp", "remote_sales_bd", "supply_chain", "ip_abandoned", "office_closure", "partnership_terminated", "product_withdrawal", "regulatory_surrender", "layoffs", "content_decay" ] }, "example": [ "country_manager", "local_employee" ] }, "event_dates": { "type": "array", "items": { "type": "string" }, "example": [ "2026-06-01", "2026-06-30" ], "description": "信号事件日期的日期范围。最大值为当天。" }, "job_seniority_ranks": { "type": "array", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ] }, "example": [ 4, 5 ], "description": "根据职位名称解析的职级：`1` 初级、`2` 资深、`3` 经理、`4` 总监、`5` 高管。1–5 以外的值会被忽略并丢弃该筛选器。结果行在 `seniority_rank` 中返回层级（`0` = 未分类）。" }, "job_functions": { "type": "array", "items": { "type": "string" }, "example": [ "engineering", "product_management" ], "description": "根据职位名称派生的职能 slug，例如 `engineering`、`sales`、`marketing`、`finance`、`product_management`——与结果行 `functions` 中返回的值相同。未知 slug 不匹配任何结果。完整列表见[枚举与常量](/cn/api-reference/enums#职能)。" }, "job_launch_dates": { "type": "array", "items": { "type": "string", "format": "date" }, "minItems": 1, "maxItems": 2, "example": [ "2026-08-01", "2026-08-31" ], "description": "上线日期的闭区间 `[from, to]`（UTC）：使用 `posting_date`，缺失时使用抓取日期。与职位洞察的计数方式一致。只传一个日期则匹配当天。" }, "job_location_ids": { "type": "array", "items": { "type": "integer" }, "example": [ 357, 419 ], "description": "按 Pubrio `location_id` 指定职位所在国家（来自 Locations 端点，每行也会返回）。`locations` 的替代方式。" }, "search_created_at": { "type": "string", "format": "date-time", "example": "2026-09-02T12:00:00Z", "description": "在此时刻当时或之后抓取（UTC）。可传日期或 ISO 时间戳。增量同步时传入你已存储的最新一行的 `created_at`。" }, "is_ascending_order": { "type": "boolean", "default": false, "example": false, "description": "排序方向。默认按最新在前返回；设为 `true` 则最旧在前。此端点没有 `sort_by`——排序键是固定的，见端点说明。" }, "news_published_at_from": { "type": "string", "format": "date-time", "example": "2026-09-01T00:00:00Z", "description": "在此时刻当时或之后发布（UTC）。可传日期或 ISO 时间戳。`published_dates` 是闭区间形式，使用你的工作区时区。" }, "advertisement_reach_tiers": { "type": "array", "items": { "type": "string", "enum": [ "lt_1k", "1k_10k", "10k_50k", "50k_100k", "100k_500k", "500k_1m", "1m_plus" ] }, "example": [ "100k_500k", "500k_1m", "1m_plus" ], "description": "广告的曝光区间：`lt_1k`、`1k_10k`、`10k_50k`、`50k_100k`、`100k_500k`、`500k_1m`、`1m_plus`。没有 `total_impressions` 值的广告不会匹配；未知 slug 不匹配任何结果。" }, "advertisement_exclude_source_types": { "type": "array", "items": { "type": "string", "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ] }, "example": [ "apple" ], "description": "排除来自这些来源的广告。词表与 `source_types` 相同（`linkedin`、`facebook`、`google`、`tiktok`、`apple`；`meta` 是 `facebook` 的别名）。未知值会被忽略。" }, "advertisement_active_dates_search": { "type": "array", "items": { "type": "string", "format": "date" }, "minItems": 2, "maxItems": 2, "example": [ "2026-08-01", "2026-08-31" ], "description": "闭区间 `[from, to]`（UTC）。返回在区间内任一时刻投放的广告，包括更早开始的广告，因此可与广告洞察对账。无日期的广告从 `created_at` 起计。两个日期必填，`from` ≤ `to`。" }, "search_result_company": { "type": "object", "description": "该记录关联的公司。", "properties": { "domain_search_id": { "type": "string", "format": "uuid", "description": "Pubrio 公司标识符。可传给任意搜索的 `companies`，或公司查询端点。" }, "company_name": { "type": "string", "description": "公司名称。" }, "linkedin_name": { "type": "string", "nullable": true, "description": "LinkedIn 公司 slug（`linkedin.com/company/` 之后的部分）。" }, "country_code": { "type": "string", "nullable": true, "description": "公司总部所在国家的 ISO 3166-1 alpha-2 代码。" }, "company_url": { "type": "string", "nullable": true, "description": "公司网站 URL。" }, "domain": { "type": "string", "description": "规范化后的公司域名（`stripe.com`）。" }, "logo_url": { "type": "string", "nullable": true, "description": "公司 Logo URL。" } } }, "search_pagination": { "type": "object", "description": "结果集的分页信息。", "properties": { "page": { "type": "integer", "description": "当前页码。" }, "per_page": { "type": "integer", "description": "每页记录数。" }, "total_entries": { "type": "integer", "description": "匹配记录总数。在不限定公司的宽泛搜索中，这是一个估算值。" }, "total_pages": { "type": "integer", "description": "`total_entries` 除以 `per_page`。" }, "total_display_pages": { "type": "integer", "description": "实际可请求的页数，受套餐的 `max_search_page` 限制。" }, "is_timeout": { "type": "boolean", "description": "计数查询超时、`total_entries` 仅为部分估算时为 `true`。" } } }, "search_metadata": { "type": "object", "description": "请求上下文。", "properties": { "profile": { "type": "object", "nullable": true, "description": "请求信用核算时返回的额度块（`credit`、`topup_credit`、`total_credit_cost`）；普通 API 密钥请求为 `null`。" }, "filters": { "type": "object", "description": "端点实际应用的请求体回显，包含 `per_page`、`language` 等默认值。" }, "ignored_fields": { "type": "array", "items": { "type": "string" }, "description": "端点无法识别并丢弃的请求键。为空表示所有键都已生效——拼错的筛选器会扩大搜索而不是报错。" } } }, "advertisement_search_metadata": { "allOf": [ { "$ref": "#/components/schemas/search_metadata" }, { "type": "object", "properties": { "applied_source_types": { "type": "array", "items": { "type": "string" }, "description": "仅在发送了 `source_types` 时返回：被识别并生效的值。" }, "unsupported_source_types": { "type": "array", "items": { "type": "string" }, "description": "仅在 `source_types` 包含未知来源时返回。这些值不匹配任何结果。" }, "coverage_notes": { "type": "array", "items": { "type": "object", "properties": { "source_type": { "type": "string" }, "scope": { "type": "string", "enum": [ "eea_uk_ch" ] } } }, "description": "适用时返回的所请求来源的覆盖说明。" }, "skipped_source_types": { "type": "array", "items": { "type": "object", "properties": { "source_type": { "type": "string", "description": "被跳过的来源。" }, "reason": { "type": "string", "enum": [ "country_unknown_until_enriched" ], "description": "该来源未被应用的原因。" } } }, "description": "未针对请求的 `target_locations` 应用的来源，每项附带 `reason`。" } } } ], "description": "请求上下文。" }, "job_search_result": { "type": "object", "description": "一条职位发布。", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "职位标识符。" }, "job_search_id": { "type": "string", "format": "uuid", "description": "与 `job_id` 相同。可传给职位查询端点。" }, "created_at": { "type": "string", "format": "date-time", "description": "Pubrio 首次抓取该职位的时间。这是默认排序键。" }, "last_modified": { "type": "string", "format": "date-time", "description": "记录最后更新时间。" }, "title": { "type": "string", "description": "发布的职位名称。" }, "job_url": { "type": "string", "description": "来源处的职位链接。" }, "location": { "type": "string", "description": "发布的自由文本地点。", "nullable": true }, "location_id": { "type": "integer", "nullable": true, "description": "职位所在国家的 Pubrio `location_id`。与 `location_ids` 筛选器词表相同。" }, "country": { "type": "string", "description": "职位所在国家名称。", "nullable": true }, "country_code": { "type": "string", "description": "职位所在国家的 ISO 3166-1 alpha-2 代码。与 `locations` 筛选器词表相同。", "nullable": true }, "posting_date": { "type": "string", "format": "date", "nullable": true, "description": "发布方的发布日期。`launch_dates` 按它筛选，缺失时回退到 `created_at`。" }, "source_type": { "type": "string", "description": "职位的抓取来源，例如 `linkedin`。" }, "functions": { "type": "array", "nullable": true, "items": { "type": "string" }, "description": "根据职位名称解析出的职能 slug；未分类时为 `null`。与 `functions` 筛选器词表相同。" }, "seniority_rank": { "type": "integer", "enum": [ 0, 1, 2, 3, 4, 5 ], "description": "职级层级 `1`–`5`，定义见 `seniority_ranks` 筛选器；职位名称无法分类时为 `0`。" }, "base_salary": { "type": "string", "description": "来源提供时的薪资文本。", "nullable": true }, "experience_requirement": { "type": "string", "description": "来源提供时的经验要求。", "nullable": true }, "education_requirement": { "type": "string", "description": "来源提供时的学历要求。", "nullable": true }, "employment_type": { "type": "string", "description": "来源提供时的雇佣类型（例如 `Full-time`）。", "nullable": true }, "companies": { "$ref": "#/components/schemas/search_result_company" } } }, "news_search_result": { "type": "object", "description": "一条新闻。", "properties": { "news_id": { "type": "string", "format": "uuid", "description": "文章标识符。" }, "news_search_id": { "type": "string", "format": "uuid", "description": "搜索记录标识符。可传给新闻查询端点。" }, "title": { "type": "string", "description": "标题。" }, "summary": { "type": "string", "description": "文章摘要。", "nullable": true }, "url": { "type": "string", "description": "文章链接。" }, "source": { "type": "string", "description": "发布方域名。", "nullable": true }, "image_url": { "type": "string", "description": "文章配图（如有）。", "nullable": true }, "language": { "type": "string", "description": "文章语言的 ISO 639-1 代码。与 `news_languages` 筛选器词表相同。", "nullable": true }, "published_at": { "type": "string", "format": "date-time", "description": "发布时间。这是默认排序键（无日期的文章排在最后）。", "nullable": true }, "last_modified": { "type": "string", "format": "date-time", "description": "记录最后更新时间。" }, "category": { "type": "string", "description": "新闻分类 slug。与 `categories` 筛选器和新闻分类端点词表相同。", "nullable": true }, "news_category_name": { "type": "string", "description": "按 `language` 本地化的分类名称。", "nullable": true }, "news_galleries": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "news_gallery_id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "description": "文章所属的画廊；没有时为 `null`。" }, "country_codes": { "type": "array", "nullable": true, "items": { "type": "string" }, "description": "文章涉及的国家（ISO 3166-1 alpha-2）；未检测到时为 `null`。与 `locations` 筛选器词表相同。" }, "company_country_codes": { "type": "array", "nullable": true, "items": { "type": "string" }, "description": "被提及公司的总部所在国家。与 `company_locations` 筛选器词表相同。" }, "locations": { "type": "array", "nullable": true, "items": { "type": "string" }, "description": "文章中提及的地名；没有时为 `null`。" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "文章提及的所有公司的域名。" }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/search_result_company" }, "description": "文章提及的所有公司，顺序与 `domains` 一致。" }, "expansion_signals": { "type": "array", "items": { "type": "object", "properties": { "signal_type_slug": { "type": "string", "description": "信号类型，例如 `HIRE`、`PARTNER`、`PRODUCT`。" }, "signal_subtype_slug": { "type": "string", "description": "信号子类型（如该类型有子类型）。", "nullable": true }, "signal_strength_slug": { "type": "string", "description": "信号强度：`low`、`medium`、`high`、`very_high`。" }, "polarity": { "type": "string", "description": "`expansion`、`contraction_leading`、`contraction_confirming` 或 `contraction_lagging`。" }, "country_code": { "type": "string", "description": "信号指向的市场。", "nullable": true }, "domain_search_id": { "type": "string", "format": "uuid", "description": "信号所属的公司。" }, "event_date": { "type": "string", "format": "date-time", "description": "信号发生时间。" } } }, "description": "仅当 `is_expansion_signal_available: true` 时返回：该文章产生的扩张信号。没有时为空数组。" } } }, "advertisement_search_result": { "type": "object", "description": "一条广告。", "properties": { "advertisement_id": { "type": "string", "format": "uuid", "description": "广告标识符。" }, "advertisement_search_id": { "type": "string", "format": "uuid", "description": "与 `advertisement_id` 相同。可传给广告查询端点。" }, "created_at": { "type": "string", "format": "date-time", "description": "Pubrio 首次抓取该广告的时间。这是默认排序键。" }, "last_modified": { "type": "string", "format": "date-time", "description": "记录最后更新时间。" }, "started_at": { "type": "string", "format": "date-time", "description": "来源报告的广告开始投放时间。", "nullable": true }, "ended_at": { "type": "string", "format": "date-time", "description": "广告停止投放的时间；仍在投放时为 `null`。", "nullable": true }, "title": { "type": "string", "description": "广告标题。", "nullable": true }, "source_type": { "type": "string", "enum": [ "linkedin", "facebook", "google", "tiktok", "apple" ], "description": "广告的抓取来源。与 `source_types` 筛选器词表相同。" }, "advertisement_format": { "type": "string", "description": "来源发布的原始格式标签，例如 `Single Image Ad`、`MULTI_IMAGES`。", "nullable": true }, "advertisement_format_normalized": { "type": "string", "nullable": true, "enum": [ "image", "video", "text", "carousel", "dynamic_product", "document", "message", "event", "article", "spotlight", "follow", "job", "engagement", "other" ], "description": "规范化格式，即 `advertisement_formats` 筛选器接受的词表。原始标签未映射时为 `other`。" }, "is_company_matched": { "type": "boolean", "description": "广告已关联到 Pubrio 公司记录时为 `true`。未关联的广告仅在 `is_include_unlinked_companies: true` 时返回。" }, "advertiser": { "type": "string", "description": "来源显示的广告主名称。", "nullable": true }, "advertiser_url": { "type": "string", "description": "来源处的广告主页面（如有）。", "nullable": true }, "advertisement_url": { "type": "string", "description": "来源广告库中该广告的链接（如有）。", "nullable": true }, "total_impressions": { "type": "string", "description": "来源发布的原始曝光估算，例如 `< 1k`、`10k-50k`。不报告曝光的来源为 `null`。", "nullable": true }, "total_impressions_lower": { "type": "integer", "nullable": true, "description": "曝光范围的下限；`< N` 形式的范围为 `null`。" }, "total_impressions_upper": { "type": "integer", "nullable": true, "description": "曝光范围的上限；开放区间为 `null`。" }, "image_url": { "type": "string", "description": "广告图片素材（如有）。", "nullable": true }, "video_url": { "type": "string", "description": "广告视频素材（如有）。", "nullable": true }, "carousel_images": { "type": "array", "nullable": true, "items": { "type": "string" }, "description": "轮播格式的各帧图片。" }, "destination_url": { "type": "string", "description": "解析后的落地页。`fb.me` 等 Facebook 点击跳转链接会被还原为真实的漏斗 URL。", "nullable": true }, "raw_link_url": { "type": "string", "description": "还原前抓取到的原始链接。", "nullable": true }, "target_country_codes": { "type": "array", "nullable": true, "items": { "type": "string" }, "description": "广告投放的国家（ISO 3166-1 alpha-2）。与 `target_locations` 筛选器词表相同。" }, "publisher_platforms": { "type": "array", "nullable": true, "items": { "type": "string", "enum": [ "facebook", "instagram", "messenger", "threads", "audience_network" ] }, "description": "广告投放的 Meta 平台面：`facebook`、`instagram`、`messenger`、`threads`、`audience_network`。非 `facebook` 来源为 `null`。" }, "companies": { "$ref": "#/components/schemas/search_result_company" } } }, "exclude_people_titles": { "type": "array", "items": { "type": "string" }, "example": [ "intern", "assistant" ], "description": "要排除的职位名称。与 `people_titles` 相同的按词匹配，因此 `[\"senior\"]` 会移除所有包含该词的职位。在 `people_titles` 之后应用。" }, "exclude_people_locations": { "type": "array", "items": { "type": "string" }, "example": [ "US" ], "description": "人员**不得**居住的国家（ISO 3166-1 alpha-2）。与 `people_locations` 配套使用。" }, "exclude_departments": { "type": "array", "items": { "type": "string" }, "example": [ "master_human_resources" ], "description": "要排除的部门 slug。与 `departments` 词表相同。未记录部门的人员会被保留。" }, "exclude_department_functions": { "type": "array", "items": { "type": "string" }, "example": [ "software_development" ], "description": "要排除的职能 slug。与 `department_functions` 词表相同。未记录职能的人员会被保留。" }, "company_exclude_locations": { "type": "array", "items": { "type": "string" }, "example": [ "CN" ], "description": "要排除的总部所在国家（ISO 3166-1 alpha-2）。与 `company_locations` 配套使用；两者传入相同代码将不返回任何结果。" }, "company_social_media": { "type": "array", "items": { "type": "string", "enum": [ "linkedin", "facebook", "instagram", "tiktok", "twitter", "x", "github", "wantedly", "rocketpunch" ] }, "example": [ "tiktok" ], "description": "在以下任一网络拥有主页的公司：`linkedin`、`facebook`、`instagram`、`tiktok`、`twitter`、`x`、`github`、`wantedly`、`rocketpunch`。可用 `filter_conditions` 提升为 AND。" }, "advertisement_status": { "type": "array", "items": { "type": "string", "enum": [ "currently_running", "active_last_30_min" ] }, "example": [ "currently_running" ], "description": "`currently_running`：有广告记录的公司。`active_last_30_min`：广告在最近 30 分钟内有变化的公司。" }, "company_sort_by": { "type": "string", "enum": [ "relevance", "name", "number_of_employees", "founded_year", "advertisement_country_rank" ], "example": "advertisement_country_rank", "description": "结果排序方式。留空则使用默认的相关性排序。`advertisement_country_rank` 会按公司在 `advertisement_country_activity` 所指定国家内的广告排名排序（排名 1 = 该市场投放量最大的广告主），未使用该筛选器时此排序会被忽略。搭配 `is_ascending_order: false` 可让投放量最小的广告主排在最前。暂不支持：`name`（升序和降序均不支持）以及配合 `is_ascending_order: false` 的 `relevance` —— 这些请求会超时。请改用默认的相关性排序、`number_of_employees` 或 `founded_year`。" }, "cloud_footprint_target_locations": { "type": "array", "items": { "type": "string" }, "example": [ "DE", "SG" ], "description": "在其足迹中任意位置出现在这些国家的公司。" }, "cloud_footprint_exclude_target_locations": { "type": "array", "items": { "type": "string" }, "example": [ "DE", "US", "SG" ], "description": "排除匹配这些基础设施所在的国家代码的足迹记录。" }, "cloud_footprint_id": { "type": "string", "format": "uuid", "example": "f28215e6-f6ed-40c2-ac9b-d8e70164c0be", "description": "单条云足迹记录的标识符。" }, "cloud_footprint_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "example": [ "f28215e6-f6ed-40c2-ac9b-d8e70164c0be" ], "description": "指定云足迹记录的标识符，用于导出所选内容。" }, "cloud_footprint_evidence_url": { "type": "string", "nullable": true, "format": "uri", "example": "https://www.pubrio.com/evidence/9c6ae876b7bf39f0a5beed66a7ad689e", "description": "指向 Pubrio 证据页面的链接，用于佐证该记录。公司本土市场不会产生扩张信号，因此为 `null`。" }, "cloud_footprint_country_activity": { "type": "object", "required": [ "country" ], "properties": { "country": { "type": "string", "example": "DE", "description": "ISO 3166-1 alpha-2 country code." }, "host_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 100, null ] }, "server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 100, null ] }, "shared_server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 100, null ] }, "region_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 100, null ] }, "city_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 100, null ] }, "first_seen": { "type": "array", "items": { "type": "string", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ "2026-07-01", null ] }, "last_seen": { "type": "array", "items": { "type": "string", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ "2026-07-01", null ] } }, "description": "限定单一国家的范围条件：`{\"country\":\"DE\",\"host_count\":[100,null]}` 查找在德国运行 100 台以上主机的公司。不带此结构的 `cloud_footprint_host_count` 是公司在所有国家的总量，二者无法组合表达。仅提供 `country` 会被拒绝。" }, "cloud_footprint_filter_conditions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "cloud_regions", "exclude_cloud_regions", "cities", "exclude_cities" ], "example": "cloud_regions", "description": "该运算符作用于哪个数组筛选。" }, "operator": { "type": "string", "enum": [ "or", "and" ], "example": "and", "description": "`or` 匹配包含任一列出值的记录；`and` 要求全部满足。" } } }, "description": "将数组筛选从 OR（默认：匹配任一值）切换为 AND（匹配全部值）。适用于 `cloud_regions`、`exclude_cloud_regions`、`cities` 与 `exclude_cities`。" }, "providers": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "仅返回匹配这些云或托管服务商的足迹记录。仅限该条足迹记录 — 一个服务商、一个国家。" }, "exclude_providers": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare", "Hetzner" ], "description": "排除匹配这些云或托管服务商的足迹记录。仅限该条足迹记录 — 一个服务商、一个国家。" }, "cloud_regions": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "仅返回匹配这些云区域的足迹记录。仅限该条足迹记录 — 一个服务商、一个国家。" }, "exclude_cloud_regions": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "eu-central-1" ], "description": "排除匹配这些云区域的足迹记录。仅限该条足迹记录 — 一个服务商、一个国家。" }, "cities": { "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "仅返回匹配这些城市的足迹记录。仅限该条足迹记录 — 一个服务商、一个国家。" }, "exclude_cities": { "type": "array", "items": { "type": "string" }, "example": [ "Ashburn", "Frankfurt" ], "description": "排除匹配这些城市的足迹记录。仅限该条足迹记录 — 一个服务商、一个国家。" }, "first_seen_dates": { "type": "array", "items": { "type": "string", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ "2026-01-01", null ], "description": "两个 ISO 8601 日期（YYYY-MM-DD），限定足迹首次发现的时间范围。仅限该条足迹记录 — 一个服务商、一个国家。" }, "last_seen_dates": { "type": "array", "items": { "type": "string", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ "2026-01-01", null ], "description": "两个 ISO 8601 日期（YYYY-MM-DD），限定足迹最近发现的时间范围。仅限该条足迹记录 — 一个服务商、一个国家。" }, "is_cross_border_only": { "type": "boolean", "example": true, "description": "为 true 时仅返回公司本土市场以外的足迹记录。总部未知的公司记录会被排除。" }, "host_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "主机数的最小值与最大值。使用 `null` 表示不设该端边界。仅限该条足迹记录 — 一个服务商、一个国家。" }, "server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "服务器数（不同 IP）的最小值与最大值。使用 `null` 表示不设该端边界。仅限该条足迹记录 — 一个服务商、一个国家。" }, "shared_server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "与其他公司共用的服务器数的最小值与最大值。使用 `null` 表示不设该端边界。仅限该条足迹记录 — 一个服务商、一个国家。" }, "region_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "云区域数的最小值与最大值。使用 `null` 表示不设该端边界。仅限该条足迹记录 — 一个服务商、一个国家。" }, "city_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "城市数的最小值与最大值。使用 `null` 表示不设该端边界。仅限该条足迹记录 — 一个服务商、一个国家。" }, "cloud_footprint_host_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "主机数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "服务器数（不同 IP）的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_shared_server_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "与其他公司共用的服务器数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_provider_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "公司使用的不同服务商数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_country_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "公司托管所在的国家数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_cross_border_country_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "本土市场以外的国家数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_region_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "云区域数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_city_count": { "type": "array", "items": { "type": "integer", "nullable": true }, "minItems": 2, "maxItems": 2, "example": [ 1, null ], "description": "城市数的最小值与最大值。使用 `null` 表示不设该端边界。按公司整体统计，涵盖所有服务商与国家。" }, "cloud_footprint_providers": { "type": "array", "items": { "type": "string" }, "example": [ "AWS", "Cloudflare" ], "description": "筛选在任意位置使用这些服务商的公司。不带前缀的 `providers` 缩小返回的记录；此项缩小公司范围。" }, "cloud_footprint_primary_provider": { "type": "array", "items": { "type": "string" }, "example": [ "AWS" ], "description": "主要（占比最大）服务商为其中之一的公司。" } }, "securitySchemes": { "pubrio_api_key": { "type": "apiKey", "name": "pubrio-api-key", "description": "一个唯一的 API 令牌，用于标识您通过 API 执行的操作以及相应的权限和操作。您可以在 [设置](https://dashboard.pubrio.com/#/settings/) 部分创建该令牌。", "in": "header" } }, "responses": { "server_error": { "description": "内部服务器错误。服务器发生意外错误。如果错误持续存在，请联系支持团队。", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "example": "服务器在处理请求时遇到了未预料的异常。", "type": "string" } } } } } }, "rate_limit_error": { "description": "超出速率限制。在给定时间段内发送了过多请求。请在速率限制窗口重置后重试。", "content": { "application/json": { "schema": { "required": [ "error" ], "type": "object", "properties": { "error": { "example": "请求频率超出限制。请稍后再试。", "type": "string" } } } } } }, "general_error": { "description": "请求错误。请求格式不正确或包含无效参数。请检查错误代码和消息以获取详细信息。", "content": { "application/json": { "schema": { "required": [ "code", "message", "details" ], "type": "object", "properties": { "code": { "example": 40001, "type": "integer" }, "message": { "example": "错误及代码会根据不同场景有所不同，详情请参阅文档。", "type": "string" }, "details": { "type": "object" } } } } } } }, "links": {}, "callbacks": {} }, "security": [ { "pubrio_api_key": [] } ] }