全部产品

API概览

更新时间:2020-10-28 14:29:53

我们为您汇总了智能推荐 AIRec 所有可调用 API,具体接口信息请参阅相关文档。

注意:目前所有的API实现的功能已在AIRec控制台中存在,请使用控制台的对应的功能进行操作

实例相关接口

接口 描述
ListInstance 获取用户的实例列表
CreateInstance 创建一个预付费实例
DescribeInstance 获取指定实例详情
ModifyInstance 修改指定实例,包括实例名称、行业、场景、数据源等
UpgradeInstance 更新指定实例配额(Quota)信息
RunInstance 运行指定实例,开启数据导入
ValidateInstance 校验指定实例有效性
DowngradeInstance 降低实例配额信息
DescribeExposureSettings 通过指定的实例ID查看曝光设置
ModifyExposureSettings 修改曝光设置
DescribeUserMetrics 获取用户指标(转化率信息)

数据源相关接口

接口 描述
ListDataSource ​获取指定实例的数据源列表
ModifyDataSource ​修改指定实例的指定数据源信息

数据集相关接口

接口 描述
ListDataSet ​获取指定实例的数据集列表
AttachDataSet ​指定实例的指定数据集生效,开启数据训练
StopDataSet 停止指定实例的指定数据集,数据集状态必须是 数据导入成功 DataSuccess
DeleteDataSet 删除指定实例的指定数据集,数据集状态必须是以下状态中的一种:数据导入失败 DataFailed已生效 Success , 已失效 Failed , 停止 Stopped
DescribeDataSetReport 获取指定实例的指定数据集报告
DescribeDataSetMessage 获取指定实例的指定数据集错误信息

混排相关接口

接口 描述
CreateMix ​给指定实例创建一个混排配置
ListMix ​获取指定实例的混排配置列表
DescribeMix ​获取指定实例的指定混排配置详情
ModifyMix ​修改指定实例的指定混排配置
DeleteMix ​删除指定实例的指定混排配置

打散相关接口

接口 描述
CreateDiversify ​给指定实例创建一个打散配置
ListDiversify ​​获取指定实例的打散配置列表
DescribeDiversify ​获取指定实例的指定打散配置详情
ModifyDiversify ​修改指定实例的指定打散配置
DeleteDiversify ​删除指定实例的指定打散配置

推送推荐相关接口

接口 描述
PushDocument 给指定实例指定表推送文档
Recommend 获取指定实例的推荐结果

数据仪表盘相关接口

接口 描述
ListDashboardParameters 获取指定实例全量的渠道和场景列表
ListDashboard 获取指定实例的统计信息
ListDashboardUid 获取指定实例的跨渠道用户列表
ListDashboardDetailsFlows 通过指定条件查询指定实例的细分流量指标
ListDashboardMetricsFlows 查询指定实例的整理仪表盘流量数据。
ListDashboardDetails 通过指定条件查询指定实例的细分指标
ListDashboardMetrics 查询指定实例的整理仪表盘数据
ListSceneParameters 获取指定实例全量的渠道和场景信息列表。

数据表相关接口

接口 描述
QueryRawData 用户数据表中的原始数据查询
QueryDataMessage 用户数据表中的更新消息查询
QueryDataMessageStatistics 用户数据表中的更新消息统计数据查询

数据管理相关接口

接口 描述
QuerySingleReport 单表维度分析查询
QuerySingleAggregationReport 单表聚合查询
QueryExceptionHistory 异常数据历史分段查询
QuerySyncReportAggregation 查询整体数据概览
DescribeSyncReportOutliers 获取实时数据报告异常明细
DescribeSyncReportDetail 获取实时数据小时级别报告细节信息

其他接口

接口 描述
DescribeQuota 获取指定实例的配额信息
ListInstanceTask 查询指定实例的任务列表

友盟接口

接口 描述
ListUmengAppkeys 获取友盟appkey列表信息

场景相关接口

接口 描述
CreateScene 创建场景,校验创建场景的信息
ModifyScene 修改场景信息
ListScenes 查询场景列表
ListSceneItems 获取预览结果
DeleteScene 删除场景
DescribeScene 查询场景详情
DescribeSceneThroughput 获取场景流量

运营选品规则相关接口

接口 描述
CreateRule 创建规则
ListRules 查询规则列表
ListRuleConditions 查询实例具体的选品规则
PublishRule 发布一个规则
ModifyRule 修改规则
DescribeRule 查询一个规则的详细信息
ListRuleTask 查询规则的任务状态