查询

查询 API 主要用于获取各种数据分析报告。

接口

• 事件分析报告接口 POST /api/v3/analytics/v1/model/segmentation/report
• 漏斗分析报告接口 POST /api/v3/analytics/v1/model/funnel/report
• 留存分析报告接口 POST /api/v3/analytics/v1/model/retention/report
• 分布分析报告接口 POST /api/v3/analytics/v1/model/addiction/report
• 间隔分析报告接口 POST /api/v3/analytics/v1/model/interval/report
• 归因分析报告接口 POST /api/v3/analytics/v1/model/attribute/report
• LTV_分析报告接口 POST /api/v3/analytics/v1/model/ltv/report
• 属性分析报告接口 POST /api/v3/analytics/v1/model/user-analytics/report
• 事件分析用户明细接口 POST /api/v3/analytics/v1/model/segmentation/users
• 漏斗分析用户明细接口 POST /api/v3/analytics/v1/model/funnel/users
• 留存分析用户明细接口 POST /api/v3/analytics/v1/model/retention/users
• 分布分析用户明细接口 POST /api/v3/analytics/v1/model/addiction/users
• LTV_分析用户明细接口 POST /api/v3/analytics/v1/model/ltv/users
• 用户列表明细接口 POST /api/v3/analytics/v1/model/user/list
• 用户行为列表查询接口 POST /api/v3/analytics/v1/model/user/behavior
• 自定义 SQL 查询接口 POST /api/v3/analytics/v1/model/sql/query

调用方式

使用 查询 OpenAPI 您需要：

1. 请参考 OpenAPI 认证方式 获取 API 密钥并构建请求头（api-key、sensorsdata-project 等）。
2. 请确保您的账户拥有对应分析模型的查询权限。

性能注意事项

响应时间影响因素

1. 查询场景复杂度

• 数据总量大小
• 查询时间范围跨度
• 分析模型/SQL 复杂度
• 聚合计算维度数量

2. 系统配置参数

• 服务器硬件配置（CPU/内存/存储）
• 网络带宽质量
• 集群负载状态

系统限流规则

• 调用频率： ≤ 3 次/秒
• 并发控制：≤ 10

对于大数据量或明细的导出建议 使用 JDBC 进行数据访问，此方式相比 HTTP 查询 API 的性能更好。

用户行为报告

事件分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/segmentation/report
• POST

请求参数说明

完整请求参数示例

{
    "measures":[
        {
            "event_name":"$MPShow",
            "aggregator":"general",
            "name":"小程序显示的总次数",
            "filter":{
                "conditions":[
                    {
                        "field":"event.$Anything.$lib",
                        "function":"equal",
                        "params":[
                            "Android"
                        ]
                    }
                ]
            }
        }
    ],
    "from_date":"2022-10-08",
    "to_date":"2022-10-08",
    "unit":"day",
    "by_fields":[
        "event.$Anything.$event_duration"
    ],
    "filter":{
        "conditions":[
            {
                "field":"user.user_group_fq1",
                "function":"isFalse",
                "params":[

                ]
            },
            {
                "field":"event.$Anything.$event_duration",
                "function":"between",
                "params":[
                    "30",
                    "60"
                ]
            }
        ],
        "relation":"or"
    },
    "bucket_params":{
        "event.$Anything.$event_duration":[
            "40",
            "50"
        ]
    },
    "rollup":false,
    "use_cache":true
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"92c88c91fa81459a9c571ccd632e3560",
    "data":{
        "metadata_columns":{
            "date":"DATE",
            "小程序显示的总次数":"DOUBLE",
            "自定义指标1":"DOUBLE",
            "user.vehicle_system":"STRING"
        },
        "truncated":false,
        "detail_rows":[
            [
                "2022-07-11 00:00:00",
                144,
                "37",
                "1"
            ],
            [
                "2022-07-11 00:00:00",
                126,
                "8",
                "7"
            ]
        ]
    }
}

接口请求curl示例：

curl 'http://localhost:8107/api/v3/analytics/v1/model/segmentation/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"measures":[{"event_name":"$MPShow","aggregator":"general","name":"MPShow_click_times"}],"from_date":"2022-07-11","to_date":"2022-07-11","rollup":true,"unit":"DAY","by_fields":[],"bucket_params":{},"use_cache":true}' \
  --compressed \
  --insecure

漏斗分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/funnel/report
• POST

请求参数说明

完整请求参数示例

{
    "funnel":{
        "steps":[
            {
                "event_name":"$AppStart"
            },
            {
                "event_name":"$AppViewScreen"
            },
            {
                "event_name":"$AppClick"
            }
        ],
        "max_convert_time":10080
    },
    "by_fields":[
        "event.$AppStart.$country",
        "event.$AppStart.$province"
    ],
    "filter":{
        "conditions":[
            {
                "field":"event.$AppStart.$country",
                "function":"equal",
                "params":[
                    "韩国"
                ]
            },
            {
                "field":"event.$AppStart.$province",
                "function":"equal",
                "params":[
                    "蔚山广域市"
                ]
            }
        ]
    },
    "filter_field_steps":[
        0,
        0
    ],
    "from_date":"2022-07-01",
    "to_date":"2022-07-03",
    "rollup":false,
    "sampling_factor":64,
    "use_cache":false,
    "extend_over_end_date":"true"
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"3b24d20f13ff49ef8a45846bb0d8b5c2",
    "data":{
        "metadata_columns":{
            "date":"DATE",
            "wastage_user_step_1":"INT",
            "convert_user_step_2":"INT",
            "convert_user_step_1":"INT",
            "funnel_root":"STRING",
            "funnel_level_2":"STRING",
            "funnel_level_1":"STRING",
            "wastage_user_step_2":"INT",
            "convert_rate_step_2":"DOUBLE",
            "completion_rate":"DOUBLE",
            "total_user":"INT",
            "convert_rate_step_1":"DOUBLE",
            "median_converted_time_step_2":"DOUBLE",
            "median_converted_time_step_1":"DOUBLE",
            "completion_converted_user":"INT"
        },
        "truncated":false,
        "detail_rows":[
            [
                "2022-07-03 00:00:00",
                13,
                2,
                8,
                "$AppStart",
                "$AppClick",
                "$AppViewScreen",
                6,
                25,
                9.52,
                21,
                38.1,
                2490,
                89087,
                2
            ],
            [
                "2022-07-01 00:00:00",
                13,
                2,
                6,
                "$AppStart",
                "$AppClick",
                "$AppViewScreen",
                4,
                33.33,
                10.53,
                19,
                31.58,
                12544,
                11671,
                2
            ],
            [
                "2022-07-02 00:00:00",
                10,
                2,
                7,
                "$AppStart",
                "$AppClick",
                "$AppViewScreen",
                5,
                28.57,
                11.76,
                17,
                41.18,
                7801,
                18599,
                2
            ]
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/funnel/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"funnel":{"steps":[{"event_name":"$AppStart"},{"event_name":"$AppViewScreen"},{"event_name":"$AppClick"}],"max_convert_time":10080},"by_fields": [ "event.$AppStart.$country","event.$AppStart.$province" ],"filter": { "conditions": [ { "field": "event.$AppStart.$country","function": "equal","params": [ "韩国" ] },{ "field": "event.$AppStart.$province","function": "equal","params": [ "蔚山广域市" ] } ] },"filter_field_steps": [ 0,0 ],"from_date": "2022-07-01","to_date": "2022-07-03","rollup": false,"sampling_factor": 64,"use_cache": false, "extend_over_end_date": "true" }' \
  --compressed \
  --insecure

留存分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/retention/report
• POST

请求参数说明

完整请求参数示例

{
    "first_event":{
        "event_name":"$AppViewScreen",
        "filter":{

        },
        "relevance_field":""
    },
    "second_event":{
        "event_name":"$AppClick",
        "filter":{

        },
        "relevance_field":""
    },
    "measures":[
        {
            "event_name":"$MPShow",
            "aggregator":"general",
            "filter":{

            }
        }
    ],
    "duration":7,
    "unit":"DAY",
    "from_date":"2022-07-01",
    "to_date":"2022-07-03",
    "use_cache":true,
    "is_wastage":false,
    "sampling_factor":64,
    "user_filter":{

    },
    "rollup":false
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"2906598041854a48922f86b673e11ba3",
    "data":{
        "metadata_columns":{
            "date":"DATE",
            "retention_rate_date_period_0":"DOUBLE",
            "retention_rate_date_period_1":"DOUBLE",
            "retention_rate_date_period_2":"DOUBLE",
            "retention_rate_date_period_7":"DOUBLE",
            "retention_rate_date_period_3":"DOUBLE",
            "retention_rate_date_period_4":"DOUBLE",
            "retention_rate_date_period_5":"DOUBLE",
            "retention_rate_date_period_6":"DOUBLE",
            "measure_date_period_0":"DOUBLE",
            "retention_user_date_period_3":"LONG",
            "measure_date_period_1":"DOUBLE",
            "retention_user_date_period_2":"LONG",
            "retention_user_date_period_1":"LONG",
            "retention_user_date_period_0":"LONG",
            "measure_date_period_4":"DOUBLE",
            "retention_user_date_period_7":"LONG",
            "measure_date_period_5":"DOUBLE",
            "retention_user_date_period_6":"LONG",
            "measure_date_period_2":"DOUBLE",
            "retention_user_date_period_5":"LONG",
            "measure_date_period_3":"DOUBLE",
            "retention_user_date_period_4":"LONG",
            "measure_date_period_6":"DOUBLE",
            "measure_date_period_7":"DOUBLE",
            "initial_user":"LONG"
        },
        "truncated":false,
        "detail_rows":[
            [
                "2022-07-01",
                "48.43",
                "2.03",
                "2.13",
                "2.74",
                "2.74",
                "1.93",
                "3.15",
                "3.15",
                281,
                27,
                10,
                21,
                20,
                477,
                8,
                27,
                17,
                31,
                19,
                31,
                10,
                19,
                24,
                14,
                985
            ],
            [
                "2022-07-02",
                "48.49",
                "2.82",
                "2.72",
                "2.82",
                "2.52",
                "3.32",
                "2.31",
                "2.21",
                299,
                25,
                13,
                27,
                28,
                482,
                19,
                28,
                21,
                22,
                22,
                23,
                16,
                33,
                18,
                18,
                994
            ]
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/retention/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"first_event":{"event_name":"$AppViewScreen","filter":{},"relevance_field":""},"second_event":{"event_name":"$AppClick","filter":{},"relevance_field":""},"measures":[{"event_name":"$MPShow","aggregator":"general","filter":{}}],"duration":7,"unit":"DAY","from_date":"2022-07-01","to_date":"2022-07-03","extend_over_end_date":true,"show_zero_day":"checked","userUnit":"人","isSaved":false,"sub_task_type":"RETENTION","last_zero":true,"rollup_date":true,"use_cache":true,"is_wastage":false,"sli":{},"sampling_factor":64,"subject_id":"$user_id","user_filter":{},"rollup":false}' \
  --compressed \
  --insecure

分布分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/addiction/report
• POST

请求参数说明

完整请求参数示例

{
    "event_name":"$AppClick",
    "filter":{
        "conditions":[
            {
                "field":"event.$Anything.$lib",
                "function":"contain",
                "params":[
                    "iOS",
                    "Android"
                ]
            }
        ]
    },
    "from_date":"2022-09-29",
    "to_date":"2022-10-12",
    "measure_type":"times",
    "result_bucket_param":[
        "5",
        "10",
        "15"
    ],
    "sampling_factor":64,
    "use_cache":true,
    "unit":"week",
    "measure":null,
    "user_filter":{
        "conditions":[
            {
                "field":"user.$country",
                "function":"contain",
                "params":[
                    "中国",
                    "日本",
                    "韩国"
                ]
            }
        ]
    },
    "addition_measures":[
        {
            "event_name":"$Anything",
            "aggregator":"general"
        }
    ],
    "by_field":"event.$Anything.$province"
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"23b2112796184503bac4b9620fc21cfa",
    "data":{
        "by_field":"",
        "metadata_columns":{
            "by_value":"STRING",
            "addiction_rate_bucket_3":"DOUBLE",
            "total_user":"INT",
            "bucket_region_1":"STRING",
            "addiction_rate_bucket_2":"DOUBLE",
            "addiction_rate_bucket_1":"DOUBLE",
            "bucket_region_2":"STRING",
            "total_measure":"DOUBLE",
            "bucket_region_3":"STRING",
            "addiction_user_bucket_3":"INT",
            "addiction_user_bucket_1":"INT",
            "addiction_user_bucket_2":"INT",
            "addiction_measure_bucket_2":"DOUBLE",
            "addiction_measure_bucket_3":"DOUBLE",
            "addiction_measure_bucket_1":"DOUBLE"
        },
        "truncated":false,
        "detail_rows":[
            [
                "2022-07-01",
                0,
                989,
                "[1, 3)",
                4.35,
                95.65,
                "[3, 5)",
                662,
                "[5, 10)",
                0,
                946,
                43,
                18,
                0,
                644
            ],
            [
                "2022-07-02",
                0.21,
                973,
                "[1, 3)",
                7.09,
                92.7,
                "[3, 5)",
                648,
                "[5, 10)",
                2,
                902,
                69,
                44,
                0,
                604
            ],
            [
                "2022-07-03",
                0.3,
                1015,
                "[1, 3)",
                4.73,
                94.98,
                "[3, 5)",
                693,
                "[5, 10)",
                3,
                964,
                48,
                27,
                1,
                665
            ]
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/addiction/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"event_name":"$MPShow","from_date":"2022-07-01","to_date":"2022-07-03","measure_type":"times","result_bucket_param":[],"sampling_factor":64,"use_cache":true,"unit":"DAY","subject_id":"$user_id","rollup_date":false,"addition_measures":[{"event_name":"$AppStart","aggregator":"general"}]}' \
  --compressed \
  --insecure

间隔分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/interval/report
• POST

请求参数说明

完整请求参数示例

{
    "filter":{
    },
    "first_event":{
        "event_name":"$AppClick",
        "filter":{

        },
        "relevance_field":""
    },
    "second_event":{
        "event_name":"$AppClick",
        "filter":{

        },
        "relevance_field":""
    },
    "unit":"DAY",
    "measure_type":"other",
    "from_date":"2022-07-01",
    "to_date":"2022-07-03",
    "use_cache":true,
    "quantiles":[
        10,
        25,
        50,
        75,
        90
    ],
    "bucket_param":[

    ],
    "by_field":"event.$AppClick.$country",
    "by_event":"first",
    "type":"first",
    "sampling_factor":64,
    "rollup":false
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"6117546b4cd44cf79a85c1c7fa2f3e04",
    "data":{
        "metadata_columns":{
            "date":"DATE",
            "uniqavg_cnt":"DOUBLE",
            "by_field":"STRING",
            "25":"DOUBLE",
            "cnt":"DOUBLE",
            "people":"DOUBLE",
            "min_time":"DOUBLE",
            "uniqavg_time":"DOUBLE",
            "90":"DOUBLE",
            "max_time":"DOUBLE",
            "50":"DOUBLE",
            "75":"DOUBLE",
            "avg_time":"DOUBLE",
            "10":"DOUBLE"
        },
        "truncated":false,
        "detail_rows":[
            [
                "2022-07-01",
                1.03,
                "中国",
                7550,
                68,
                66,
                328,
                16686.77,
                31590,
                45802,
                17462,
                24248,
                16419.93,
                2236
            ],
            [
                "2022-07-01",
                1,
                "韩国",
                5973,
                72,
                72,
                276,
                16890.61,
                34792,
                63610,
                14878,
                26667,
                16890.61,
                2712
            ]
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/interval/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"filter":{},"first_event":{"event_name":"$AppClick","filter":{},"relevance_field":""},"second_event":{"event_name":"$AppClick","filter":{},"relevance_field":""},"unit":"DAY","measure_type":"other","from_date":"2022-07-01","to_date":"2022-07-03","extend_over_end_date":true,"rollup_date":true,"use_cache":true,"quantiles":[10,25,50,75,90],"bucket_param":[],"by_field":"event.$AppClick.$country","by_event":"first","type":"first","sampling_factor":64,"rollup":false}' \
  --compressed \
  --insecure

归因分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/attribute/report
• POST

请求参数说明

完整请求参数示例

{
    "from_date":"2022-07-01",
    "to_date":"2022-07-03",
    "use_cache":false,
    "direct_conversion":true,
    "target_event":{
        "event_name":"$AppViewScreen",
        "aggregator":"general",
        "field":"",
        "filter":{

        }
    },
    "link_events":[

    ],
    "attribution_events":{
        "events":[
            {
                "event_name":"$AppClick",
                "link_events":[
                    {
                        "event_name":"$AppViewScreen",
                        "link_properties":{

                        }
                    }
                ]
            }
        ],
        "filter":{

        },
        "by_fields":[
            "event.$Anything.$province"
        ]
    },
    "filter":{
        "conditions":[
            {
                "field":"event.$Anything.$country",
                "function":"equal",
                "params":[
                    "中国"
                ]
            }
        ]
    },
    "model_type":"first",
    "lookback_window":{
        "unit":"DAY",
        "value":7
    }
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"3f2406885ea54ed1a4cf4083968f09ef",
    "data":{
        "metadata_columns":{
            "click_times":"LONG",
            "conversion_value_rate":"DOUBLE",
            "goal_conversion":"DOUBLE",
            "converted_number":"LONG",
            "event_name":"STRING",
            "converted_user_number":"LONG",
            "event.$Anything.$province":"STRING"
        },
        "truncated":false,
        "detail_rows":[
            [
                51,
                2.05,
                21,
                18,
                "$AppClick",
                16,
                "内蒙古自治区"
            ],
            [
                47,
                2.05,
                21,
                15,
                "$AppClick",
                12,
                "青海省"
            ]
        ]
    }
}

接口请求curl示例：

curl 'http://localhost:8107/api/v3/analytics/v1/model/attribute/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"from_date":"2022-07-01","to_date":"2022-07-03","use_cache":false,"rangeText":"","direct_conversion":true,"target_event":{"event_name":"$AppViewScreen","aggregator":"general","field":"","filter":{}},"link_events":[],"attribution_events":{"events":[{"event_name":"$AppClick","link_events":[{"event_name":"$AppViewScreen","link_properties":{}}]}],"filter":{},"by_fields":["event.$Anything.$province"]},"filter":{"conditions":[{"field":"event.$Anything.$country","function":"equal","params":["中国"]}]},"model_type":"first","lookback_window":{"unit":"DAY","value":7}}' \
  --compressed \
  --insecure

LTV 分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/ltv/report
• POST

请求参数说明

完整请求参数示例

{
    "start_sign":{
        "start_event":"$MPShow",
        "filters":{
            "conditions":[
                {
                    "field":"event.$Anything.$ip",
                    "function":"isSet",
                    "params":[

                    ]
                }
            ]
        }
    },
    "measures":[
        {
            "event_name":"activityview",
            "aggregator":"average",
            "name":"activityview的LTV_AVG",
            "profit_rate":100
        }
    ],
    "from_date":"2022-10-06",
    "to_date":"2022-10-12",
    "unit":"day",
    "by_fields":[
        "event.$Anything.$country"
    ],
    "duration":90,
    "use_cache":true,
    "filter":{
        "conditions":[
            {
                "field":"user.$country",
                "function":"notSet",
                "params":[

                ]
            },
            {
                "field":"user.$province",
                "function":"notSet",
                "params":[

                ]
            }
        ]
    },
    "bucket_params":{

    }
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"7408254186664dc1909640c79f7cd791",
    "data":{
        "metadata_columns":{
            "date":"DATE",
            "percent_ltv_0":"STRING",
            "measure_name":"STRING",
            "initial_user":"LONG",
            "amount_ltv_0":"STRING"
        },
        "truncated":false,
        "detail_rows":[
            [
                "2022-10-13",
                "0",
                "activityview的LTV_AVG",
                1228,
                "0.75"
            ],
            [
                "2022-10-13",
                "52.00",
                "realname的LTV_AVG",
                1228,
                "0.39"
            ]
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/ltv/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"start_sign":{"start_event":"$MPShow","filters":{"conditions":[{"field":"event.$Anything.$ip","function":"isSet","params":[]}]},"cname":"小程序显示"},"measures":[{"event_name":"activityview","aggregator":"average","name":"activityview的LTV_AVG","profit_rate":100}],"from_date":"2022-10-06","to_date":"2022-10-12","unit":"day","by_fields":["event.$Anything.$country"],"detail_and_rollup":true,"duration":90,"open_predict":false,"use_cache":true,"filter":{"conditions":[{"field":"user.$country","function":"notSet","params":[],"$$render_index":1},{"field":"user.$province","function":"notSet","params":[],"$$render_index":2}]},"bucket_params":{}}' \
  --compressed \
  --insecure

属性分析报告接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/user-analytics/report
• POST

请求参数说明

完整请求参数示例

{
    "measures":[
        {
            "aggregator":"count",
            "field":""
        }
    ],
    "filter":{
        "conditions":[
            {
                "field":"user.vehicle_system",
                "function":"equal",
                "params":[
                    "Z4"
                ]
            }
        ]
    },
    "by_fields":[
        "user.vehicle_type",
        "user.vehicle_year"
    ],
    "use_cache":true
}

接口响应参数说明

code

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"5c4edafb955e45fd889084422de1ca4d",
    "data":{
        "metadata_columns":{
            "user.vehicle_year":"DOUBLE",
            "user.vehicle_type":"STRING",
            "value":"LONG"
        },
        "truncated":false,
        "detail_rows":[
            [
                3,
                "高性能跑车",
                1287
            ],
            [
                4,
                "旅行车",
                1275
            ]
        ]
    }
}

接口请求curl示例：

curl 'http://localhost:8107/api/v3/analytics/v1/model/user-analytics/report' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"measures":[{"aggregator":"count","field":""}],"filter":{"conditions":[{"field":"user.vehicle_system","function":"equal","params":["Z4"]}]},"by_fields":["user.vehicle_type","user.vehicle_year"],"use_cache":true}' \
  --compressed \
  --insecure

用户明细报告

事件分析用户明细接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/segmentation/users
• POST

请求参数说明

完整请求参数示例

{
    "measures":[
        {
            "event_name":"postpublish",
            "aggregator":"unique",
            "name":"发表帖子的用户数"
        }
    ],
    "from_date":"2022-08-12",
    "to_date":"2022-08-12",
    "unit":"DAY",
    "by_fields":[
        "event.$Anything.post_label"
    ],
    "bucket_params":{

    },
    "slice_by_values":[
        "音乐"
    ],
    "slice_date":"2022-08-12 00:00:00",
    "filter":{

    },
    "page_size":50,
    "page_index":1,
    "limit":10,
    "profiles":[
        "user.$id",
        "user.vehicle_type",
        "user.vehicle_system"
    ],
    "detail":true,
    "use_cache":false
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"e25ff264b4084a5a9f4b1c2ae7367318",
    "data":{
        "page":{
            "current_page":1,
            "page_count":1,
            "total":2
        },
        "users":[
            {
                "id":"-8961289991947891759",
                "first_id":"7tpEmL7hMALkIinn",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"四门轿车",
                    "$id":"-8961289991947891759",
                    "vehicle_system":"7"
                }
            },
            {
                "id":"-9176729725231428021",
                "first_id":"PdU0xVm67XyrA8K7",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"旅行车",
                    "$id":"-9176729725231428021",
                    "vehicle_system":"5"
                }
            }
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/segmentation/users' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"measures":[{"event_name":"postpublish","aggregator":"unique","name":"发表帖子的用户数"}],"from_date":"2022-08-12","to_date":"2022-08-12","unit":"DAY","by_fields":["event.$Anything.post_label"],"detail_and_rollup":true,"enable_detail_follow_rollup_by_values_rank":true,"sub_task_type":"SEGMENTATION","time_zone_mode":"","server_time_zone":"","bucket_params":{},"slice_by_values":["音乐"],"slice_date":"2022-08-12 00:00:00","rollup_date":false,"oriMeasures":[{"event_name":"postpublish","aggregator":"unique","name":"发表帖子的用户数"}],"filter":{},"page_size":50,"page_index":1,"limit":10,"all_page":false,"profiles":["user.$id","user.vehicle_type","user.vehicle_system"],"sort_by_field":"first_id","asc":true,"detail":true,"use_cache":false}' \
  --compressed \
  --insecure

漏斗分析用户明细接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/funnel/users
• POST

请求参数说明

完整请求参数示例

{
    "calculation_caliber":"uniq",
    "funnel":{
        "steps":[
            {
                "event_name":"$AppStart"
            },
            {
                "event_name":"$AppViewScreen"
            },
            {
                "event_name":"postpublish"
            }
        ],
        "max_convert_time":10080
    },
    "by_fields":[
        "event.postpublish.post_label"
    ],
    "bucket_params":{

    },
    "by_field_steps":[
        2
    ],
    "filter":{

    },
    "filter_field_steps":[

    ],
    "from_date":"2022-07-01",
    "to_date":"2022-07-03",
    "sampling_factor":64,
    "use_cache":false,
    "slice_step":"0",
    "slice_by_values":[
        "自驾游\n音乐\nDIY\n节日"
    ],
    "page_size":10,
    "limit":1000,
    "page_index":1,
    "all_page":false,
    "profiles":[
        "user.$id",
        "user.vehicle_type",
        "user.vehicle_system"
    ],
    "detail":true
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"e25ff264b4084a5a9f4b1c2ae7367318",
    "data":{
        "page":{
            "current_page":1,
            "page_count":1,
            "total":2
        },
        "users":[
            {
                "id":"-8961289991947891759",
                "first_id":"7tpEmL7hMALkIinn",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"四门轿车",
                    "$id":"-8961289991947891759",
                    "vehicle_system":"7"
                }
            },
            {
                "id":"-9176729725231428021",
                "first_id":"PdU0xVm67XyrA8K7",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"旅行车",
                    "$id":"-9176729725231428021",
                    "vehicle_system":"5"
                }
            }
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/funnel/users' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"calculation_caliber":"uniq","funnel":{"steps":[{"event_name":"$AppStart"},{"event_name":"$AppViewScreen"},{"event_name":"postpublish"}],"max_convert_time":10080},"by_fields":["event.postpublish.post_label"],"bucket_params":{},"by_field_steps":[2],"filter":{},"filter_field_steps":[],"from_date":"2022-07-01","to_date":"2022-07-03","sampling_factor":64,"use_cache":false,"slice_step":"0","slice_end_date":"2022-07-03","slice_wastage_user":false,"slice_by_values":["自驾游\n音乐\nDIY\n节日"],"slice_date":null,"rollup_date":true,"page_size":10,"limit":1000,"page_index":1,"all_page":false,"profiles":["user.$id","user.vehicle_type","user.vehicle_system"],"detail":true}' \
  --compressed \
  --insecure

留存分析用户明细接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/retention/users
• POST

请求参数说明

完整请求参数示例

{
    "first_event":{
        "event_name":"$AppViewScreen",
        "filter":{

        },
        "relevance_field":""
    },
    "second_event":{
        "event_name":"postpublish",
        "filter":{

        },
        "relevance_field":""
    },
    "duration":7,
    "unit":"DAY",
    "from_date":"2022-07-01",
    "to_date":"2022-07-03",
    "use_cache":false,
    "is_wastage":false,
    "sampling_factor":64,
    "by_fields":[

    ],
    "bucket_params":{

    },
    "by_events":[

    ],
    "user_filter":{
        "conditions":[
            {
                "field":"user.vehicle_system",
                "function":"equal",
                "params":[
                    "Z4"
                ]
            }
        ]
    },
    "slice_interval":"",
    "slice_date":"2022-07-01",
    "filter":{

    },
    "page_size":10,
    "limit":1000,
    "page_index":1,
    "profiles":[
        "user.$id",
        "user.vehicle_type",
        "user.vehicle_system"
    ],
    "detail":true
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"e25ff264b4084a5a9f4b1c2ae7367318",
    "data":{
        "page":{
            "current_page":1,
            "page_count":1,
            "total":2
        },
        "users":[
            {
                "id":"-8961289991947891759",
                "first_id":"7tpEmL7hMALkIinn",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"四门轿车",
                    "$id":"-8961289991947891759",
                    "vehicle_system":"7"
                }
            },
            {
                "id":"-9176729725231428021",
                "first_id":"PdU0xVm67XyrA8K7",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"旅行车",
                    "$id":"-9176729725231428021",
                    "vehicle_system":"5"
                }
            }
        ]
    }
}

接口请求curl示例：

curl 'http://localhost:8107/api/v3/analytics/v1/model/retention/users' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"first_event":{"event_name":"$AppViewScreen","filter":{},"relevance_field":""},"second_event":{"event_name":"postpublish","filter":{},"relevance_field":""},"duration":7,"unit":"DAY","from_date":"2022-07-01","to_date":"2022-07-03","use_cache":false,"is_wastage":false,"sampling_factor":64,"by_fields":[],"bucket_params":{},"by_events":[],"user_filter":{"conditions":[{"field":"user.vehicle_system","function":"equal","params":["Z4"]}]},"slice_interval":"","slice_date":"2022-07-01","filter":{},"page_size":10,"limit":1000,"page_index":1,"profiles":["user.$id","user.vehicle_type","user.vehicle_system"],"detail":true}' \
  --compressed \
  --insecure

分布分析用户明细接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/addiction/users
• POST

请求参数说明

完整请求参数示例

{
    "event_name":"$AppClick",
    "filter":{
        "conditions":[
            {
                "field":"event.$Anything.$lib",
                "function":"contain",
                "params":[
                    "iOS",
                    "Android"
                ]
            }
        ]
    },
    "from_date":"2022-09-29",
    "to_date":"2022-10-12",
    "measure_type":"times",
    "result_bucket_param":[
        "5",
        "10",
        "15"
    ],
    "sampling_factor":64,
    "use_cache":true,
    "unit":"week",
    "measure":null,
    "user_filter":{
        "conditions":[
            {
                "field":"user.$country",
                "function":"contain",
                "params":[
                    "中国",
                    "日本",
                    "韩国"
                ]
            }
        ]
    },
    "addition_measures":[
        {
            "event_name":"$Anything",
            "aggregator":"general"
        }
    ],
    "by_field":"event.$Anything.$province"
    "slice_freq":2,
    "page_size":10,
    "limit":1000,
    "page_index":1,
    "profiles":[
        "user.$id",
        "user.vehicle_type",
        "user.vehicle_system"
    ],
    "detail":true
}

接口响应参数说明

完整的响应报文示例

{
    "code":"SUCCESS",
    "request_id":"e25ff264b4084a5a9f4b1c2ae7367318",
    "data":{
        "page":{
            "current_page":1,
            "page_count":1,
            "total":2
        },
        "users":[
            {
                "id":"-8961289991947891759",
                "first_id":"7tpEmL7hMALkIinn",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"四门轿车",
                    "$id":"-8961289991947891759",
                    "vehicle_system":"7"
                }
            },
            {
                "id":"-9176729725231428021",
                "first_id":"PdU0xVm67XyrA8K7",
                "second_id":"",
                "distinct_id":"",
                "column_names":[
                    "$id",
                    "vehicle_type",
                    "vehicle_system"
                ],
                "profiles":{
                    "vehicle_type":"旅行车",
                    "$id":"-9176729725231428021",
                    "vehicle_system":"5"
                }
            }
        ]
    }
}

接口请求curl示例：

 curl 'http://localhost:8107/api/v3/analytics/v1/model/addiction/users' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: zh-CN,zh;q=0.9' \
  -H 'Content-Type: application/json' \
  -H 'api-key: #K-Bpei9IdKRPPw4LPycj3a1Pts1wsKPX61' \
  -H 'Sensors-Language: ZH-CN' \
  -H 'sensorsdata-project: default' \
  --data-raw '{"event_name":"$AppClick","filter":{"conditions":[{"field":"event.$Anything.$lib","function":"contain","params":["iOS","Android"]}]},"from_date":"2022-09-29","to_date":"2022-10-12","measure_type":"times","result_bucket_param":["5","10","15"],"sampling_factor":64,"use_cache":true,"unit":"week","measure":null,"user_filter":{"conditions":[{"field":"user.$country","function":"contain","params":["中国","日本","韩国"]}]},"addition_measures":[{"event_name":"$Anything","aggregator":"general"}],"by_field":"event.$Anything.$province","slice_freq":2,"page_size":10,"limit":1000,"page_index":1,"profiles":["user.$id","user.vehicle_type","user.vehicle_system"],"detail":true}' \
  --compressed \
  --insecure

LTV 分析用户明细接口

API 服务地址及请求方法

• /api/v3/analytics/v1/model/ltv/users
• POST

请求参数说明