首页 > 用户手册 > 导出报表数据——元数据

导出报表数据——元数据

1.事件列表

GET _SJK_API_PATH_/api-v2/base/events

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 事件类型id
name 事件类型名称 如:默认事件、自定义事件等
children 该类型事件列表 以数组形式返回
children[].id 事件id
children[].name 事件中文名称
children[].fe_name 事件英文名称
children[].event_attrs 事件属性列表 以数组形式返回
children[].event_attrs[].id 事件属性id
children[].event_attrs[].name 事件属性中文名称
children[].event_attrs[].fe_name 事件属性英文名称

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 1,
      "name": "\u9ed8\u8ba4\u4e8b\u4ef6",
      "children": [
        {
          "id": 1,
          "name": "\u6d4f\u89c8",
          "fe_name": "view",
          "event_attrs": null
        }
      ]
    },
    {
      "id": 3,
      "name": "\u81ea\u5b9a\u4e49\u4e8b\u4ef6",
      "children": [
        {
          "id": 93,
          "name": "DGA\u6ce8\u518c",
          "fe_name": "signup",
          "event_attrs": [
            {
              "event_id": 93,
              "id": "5_17",
              "fe_name": "eak4",
              "name": "\u6765\u6e90\u4f4d\u7f6e"
            }
          ]
        }
      ]
    }
  ]
}

2.属性列表

GET _SJK_API_PATH_/api-v2/base/attrs

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 属性类型id
name 属性类型名称 如:会话属性、推广属性等
children 该类型属性列表 以数组形式返回
children[].id 属性id
children[].name 属性中文名称
children[].fe_name 属性英文名称

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 2,
      "name": "\u4f1a\u8bdd\u5c5e\u6027",
      "children": [
        {
          "id": "2_14",
          "fe_name": "app_version",
          "name": "\u5e94\u7528\u7248\u672c"
        }
      ]
    },
    {
      "id": 3,
      "name": "\u6e20\u9053\u5c5e\u6027",
      "children": [
        {
          "id": "3_5",
          "fe_name": "channel_type",
          "name": "\u8bbf\u95ee\u6e20\u9053\u7c7b\u578b"
        }
      ]
    }
  ]
}

3.事件参数列表

GET _SJK_API_PATH_/api-v2/base/event_params/:event_id

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token
event_id int 事件id

返回数据:

字段 含义 说明
id 事件参数id
name 事件参数中文名称
fe_name 事件参数英文名称
op 事件参数指标计算操作 默认事件中为null;自定义事件的字符型参数有:COUNT次数,COUNT_DISTINCT去重数;数值型参数有SUM总和,COUNT次数等

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": "6_",
      "fe_name": "event",
      "name": "\u6b21\u6570",
      "op": null
    },
    {
      "id": "7_",
      "fe_name": "unique_event",
      "name": "\u4eba\u6570",
      "op": null
    }
  ]
}

4.属性值列表

GET _SJK_API_PATH_/api-v2/base/attr_values/:attr_id

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token
attr_id int 属性id

返回数据:

字段 含义 说明
name 属性值

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "name": "3.5.0"
    },
    {
      "name": "1.7.7"
    }
  ]
}

5.自定义活跃

GET _SJK_API_PATH_/api-v2/base/activities

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 自定义活跃id
name 自定义活跃名称

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 10,
      "name": "\u9ed8\u8ba4\u6d3b\u8dc3\u7528\u6237"
    },
    {
      "id": 16,
      "name": "\u6d4f\u89c8\u4ea7\u54c1\u529f\u80fd\u6d3b\u8dc3"
    },
    {
      "id": 68,
      "name": "\u6ce8\u518c\u6d3b\u8dc3"
    },
    {
      "id": 195,
      "name": "new-or"
    },
    {
      "id": 196,
      "name": "new-and"
    }
  ]
}

6.自定义漏斗

GET _SJK_API_PATH_/api-v2/base/funnels

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 自定义漏斗id
name 自定义漏斗名称
total_steps 漏斗总步数

示例:

curl -d 'access_token=_TOKEN_' http://a.shujike.com/api-v2/base/funnels
{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 806,
      "name": "\u767b\u5f55",
      "total_steps": 3
    },
    {
      "id": 783,
      "name": "\u6d4f\u89c8\u6d4b\u8bd5",
      "total_steps": 2
    },
    {
      "id": 618,
      "name": "\u6ce8\u518c\u6d41\u7a0b",
      "total_steps": 3
    },
    {
      "id": 820,
      "name": "www",
      "total_steps": 2
    }
  ]
}

7.自定义页面组

GET _SJK_API_PATH_/api-v2/base/page_groups

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 自定义页面组id -1为所有页面
name 自定义页面组名称

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": -1,
      "name": "\u6240\u6709\u9875\u9762"
    },
    {
      "id": 23,
      "name": "\u529f\u80fd\u4ecb\u7ecd\u7ec4"
    },
    {
      "id": 25,
      "name": "\u6ce8\u518c\u9875\u9762"
    },
    {
      "id": 50,
      "name": "\u6d4b\u8bd5\u9875\u9762\u7ec4"
    }
  ]
}

8.自定义留存

GET _SJK_API_PATH_/api-v2/base/retentions

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 自定义留存id
name 自定义留存名称

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 10,
      "name": "\u6d4f\u89c8\u7559\u5b58\u5206\u7ec4"
    },
    {
      "id": 11,
      "name": "\u9ed8\u8ba4\u7559\u5b58"
    }
  ]
}

9.自定义分群

GET _SJK_API_PATH_/api-v2/base/segments

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 自定义分群id
name 自定义分群名称

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 159,
      "name": "\u767b\u5f553\u6b21\u4ee5\u4e0a"
    },
    {
      "id": 116,
      "name": "\u9ad8\u610f\u5411\u672a\u6ce8\u518c\u7684\u56de\u8bbf\u5ba2"
    },
    {
      "id": 203,
      "name": "\u77ed\u4fe1\u8425\u9500\u767b\u5f55\u7528\u6237"
    }
  ]
}

10.自定义表单

GET _SJK_API_PATH_/api-v2/base/forms

请求参数:

字段 格式 说明 示例
access_token string 通过oauth认证获取的token

返回数据:

字段 含义 说明
id 自定义表单id
name 自定义表单名称
tag 自定义表单唯一标示
form 自定义表单input列表 以数组形式返回
form[].input_name 自定义表单input名称
form[].input_type 自定义表单input类型 如 text、select、radio等
form[].input_name_tag 自定义表单input唯一标示
form[].submit_name 自定义表单提交按钮名称 一个完整的表单,应该由一组或多组input和一组submit组成
form[].submit_name_tag 自定义表单提交按钮唯一标示

示例:

{
  "status": 0,
  "msg": {
    "msg": "success",
    "desc": ""
  },
  "data": [
    {
      "id": 6,
      "app_id": 19,
      "name": "\u6570\u6781\u5ba2\u767b\u5f55",
      "tag": "4945145b219c73425b74d3210ba5f237",
      "form": [
        {
          "input_name": "\u7535\u8bdd",
          "input_type": "input",
          "input_name_tag": "9508635fa49b1c08f408166d0e357ca2"
        },
        {
          "input_name": "\u5bc6\u7801",
          "input_type": "input",
          "input_name_tag": "7c7707e5e35fc6a2a55f8429b59dcc5e"
        },
        {
          "submit_name": "\u767b\u5f55",
          "submit_name_tag": "4945145b219c73425b74d3210ba5f237"
        }
      ]
    },
    {
      "id": 7,
      "app_id": 19,
      "name": "\u6570\u6781\u5ba2\u6ce8\u518c",
      "tag": "e61f04043431a3a468208e29cd4f3fb5",
      "form": [
        {
          "input_name": "\u59d3\u540d",
          "input_type": "input",
          "input_name_tag": "854bcbcf86b7ab07522fc32e2ab7d2e9"
        },
        {
          "input_name": "\u624b\u673a\u53f7",
          "input_type": "input",
          "input_name_tag": "7acca942244e5b0f1716672e99c29ce5"
        },
        {
          "input_name": "\u9a8c\u8bc1\u7801",
          "input_type": "input",
          "input_name_tag": "9c6f39435ac22aa493076b5bcb3a9ea9"
        },
        {
          "submit_name": "\u63d0\u4ea4\u6ce8\u518c",
          "submit_name_tag": "e61f04043431a3a468208e29cd4f3fb5"
        }
      ]
    }
  ]
}

results matching ""

    No results matching ""