的 Mixpanel 来源为测试版。 请参阅 源概述 有关使用测试版标记的源的详细信息。
以下教程将指导您完成创建源连接和要引入的数据流的步骤 Mixpanel 使用将数据发送到Adobe Experience Platform 流量服务API.
本指南需要对Experience Platform的以下组件有一定的了解:
以下部分提供了成功连接到所需了解的其他信息 Mixpanel 使用 Flow Service API。
为了连接 Mixpanel 对于平台,必须为以下连接属性提供值:
凭据 | 描述 | 示例 |
---|---|---|
username |
与您的 Mixpanel 帐户。 请参阅 Mixpanel 服务帐户文档 以了解更多信息。 | Test8.6d4ee7.mp-service-account |
password |
与您的 Mixpanel 帐户。 | dLlidiKHpCZtJhQDyN2RECKudMeTItX1 |
projectId |
您的 Mixpanel 项目ID。 创建源连接时需要此ID。 请参阅 Mixpanel 项目设置文档 和 Mixpanel 创建和管理项目指南 以了解更多信息。 | 2384945 |
timezone |
与 Mixpanel 项目。 创建源连接需要时区。 请参阅 Mixpanel项目设置文档 以了解更多信息。 | Pacific Standard Time |
有关对 Mixpanel 来源,请参阅 Mixpanel 源概述.
基本连接保留了源和平台之间的信息,包括源的身份验证凭据、连接的当前状态和唯一基本连接ID。 基本连接ID允许您从源中浏览和导航文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
要创建基本连接ID,请向 /connections
提供 Mixpanel 身份验证凭据作为请求正文的一部分。
API格式
POST /connections
请求
以下请求会为 Mixpanel:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Mixpanel base connection",
"description": "Mixpanel base connection to authenticate to Platform",
"connectionSpec": {
"id": "fd2c8ff3-1de0-4f6b-8fa8-4264784870eb",
"version": "1.0"
},
"auth": {
"specName": "Basic Authentication",
"params": {
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
}
}'
属性 | 描述 |
---|---|
name |
基本连接的名称。 确保基本连接的名称具有描述性,因为您可以使用此名称查找有关基本连接的信息。 |
description |
可包含的可选值,用于提供有关基本连接的更多信息。 |
connectionSpec.id |
源的连接规范ID。 此ID可在您的源通过注册和批准之后进行检索 Flow Service API。 |
auth.specName |
用于向平台验证源的验证类型。 |
auth.params. |
包含验证源所需的凭据。 |
auth.params.username |
与您的 Mixpanel 帐户。 |
auth.params.password |
与您的 Mixpanel 帐户。 |
响应
成功的响应会返回新创建的基本连接,包括其唯一连接标识符(id
)。 在下一步中,需要此ID才能浏览源的文件结构和内容。
{
"id": "70383d02-2777-4be7-a309-9dd6eea1b46d",
"etag": "\"d64c8298-add4-4667-9a49-28195b2e2a84\""
}
使用上一步中生成的基本连接ID,您可以通过执行GET请求来浏览文件和目录。
使用以下调用查找要引入Experience Platform的文件的路径:
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
执行GET请求以浏览源的文件结构和内容时,必须包括下表中列出的查询参数:
参数 | 描述 |
---|---|
{BASE_CONNECTION_ID} |
上一步中生成的基本连接ID。 |
objectType=rest |
要浏览的对象类型。 当前,该值始终设置为 rest . |
{OBJECT} |
仅当查看特定目录时,才需要此参数。 其值表示要浏览的目录的路径。 对于此源,值将为 json . |
fileType=json |
要引入平台的文件的文件类型。 目前, json 是唯一支持的文件类型。 |
{PREVIEW} |
一个布尔值,用于定义连接的内容是否支持预览。 |
{SOURCE_PARAMS} |
为要引入平台的源文件定义参数。 检索已接受的格式类型 {SOURCE_PARAMS} ,则必须对整个进行编码 {"projectId":"2671127","timezone":"Pacific Standard Time"} 字符串。 注意:在以下示例中, "{"projectId":"2671127","timezone":"Pacific Standard Time"}" 在base64中编码等于 eyJwcm9qZWN0SWQiOiIyNjcxMTI3IiwidGltZXpvbmUiOiJQYWNpZmljIFN0YW5kYXJkIFRpbWUifQ== . |
请求
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/70383d02-2777-4be7-a309-9dd6eea1b46d/explore?objectType=rest&object=json&fileType=json&preview=true&sourceParams=eyJsaXN0SWQiOiIxMGMwOTdjYTcxIn0=' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
响应
成功的响应会返回查询文件的结构。
{
"format": "hierarchical",
"schema": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"properties": {
"type": "object",
"properties": {
"$mp_api_endpoint": {
"type": "string"
},
"$insert_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"distinct_id": {
"type": "string"
},
"$mp_api_timestamp_ms": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"item_price": {
"type": "string"
},
"$import": {
"type": "boolean"
},
"item_name": {
"type": "string"
},
"time": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"mp_processing_time_ms": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
}
}
}
}
},
"data": [
{
"event": "Items purchased",
"properties": {
"time": 1652825148,
"distinct_id": "test@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b70",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1652850348643,
"item_id": "29066",
"item_name": "charger",
"item_price": "800.00",
"mp_processing_time_ms": 1652850348702
}
},
{
"event": "Items sold",
"properties": {
"time": 1652423938,
"distinct_id": "test@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b70",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1652449138115,
"item_id": "29036",
"item_name": "chair",
"item_price": "5000.00",
"mp_processing_time_ms": 1652449138173
}
},
{
"event": "Items sold",
"properties": {
"time": 1652854256,
"distinct_id": "test@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b70",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1652879456538,
"item_id": "29066",
"item_name": "mobile",
"item_price": "7000.00",
"mp_processing_time_ms": 1652879456604
}
},
{
"event": "Sign off",
"properties": {
"time": 1648140611,
"distinct_id": "test@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b75",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648555709515,
"item_id": "29073",
"item_name": "Watch",
"item_price": "50000.00",
"mp_processing_time_ms": 1648555710375
}
},
{
"event": "Items sold",
"properties": {
"time": 1648140612,
"distinct_id": "test@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b75",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648556481708,
"item_id": "29073",
"item_name": "Pen",
"item_price": "1000.00",
"mp_processing_time_ms": 1648556481880
}
},
{
"event": "Sign in",
"properties": {
"time": 1648140614,
"distinct_id": "test1@test.com",
"$import": true,
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b75",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648556032401,
"item_id": "29073",
"item_name": "Watch",
"item_price": "50000.00",
"mp_processing_time_ms": 1648556032462
}
},
{
"event": "Item Purchased",
"properties": {
"time": 1648165814,
"distinct_id": "test1@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b74",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648480684785,
"item_id": "29073",
"item_name": "Watch",
"item_price": "50000.00",
"mp_processing_time_ms": 1648480685058
}
},
{
"event": "Item Purchased",
"properties": {
"time": 1648165814,
"distinct_id": "test1@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b75",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648551687866,
"item_id": "29073",
"item_name": "Watch",
"item_price": "50000.00",
"mp_processing_time_ms": 1648551687922
}
},
{
"event": "Sign off",
"properties": {
"time": 1648530419,
"distinct_id": "test1@test.com",
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b75",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648555619274,
"item_id": "29073",
"item_name": "Watch",
"item_price": "50000.00",
"mp_processing_time_ms": 1648555619326
}
},
{
"event": "Items sold",
"properties": {
"time": 1648566534,
"distinct_id": "test1@test.com",
"$import": true,
"$insert_id": "935d87b1-00cd-41b7-be34-b9d98dd08b75",
"$mp_api_endpoint": "api.mixpanel.com",
"$mp_api_timestamp_ms": 1648635830114,
"item_id": "29073",
"item_name": "Pen",
"item_price": "1000.00",
"mp_processing_time_ms": 1648635831010
}
}
]
}
您可以通过向 Flow Service API。 源连接由连接ID、源数据文件的路径和连接规范ID组成。
API格式
POST /sourceConnections
请求
以下请求会为 Mixpanel:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Mixpanel source connection",
"description": "Mixpanel source connection",
"baseConnectionId": "70383d02-2777-4be7-a309-9dd6eea1b46d",
"connectionSpec": {
"id": "fd2c8ff3-1de0-4f6b-8fa8-4264784870eb",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"projectId": "{PROJECT_ID}",
"timezone": "{TIMEZONE}"
}
}'
属性 | 描述 |
---|---|
name |
源连接的名称。 确保源连接的名称具有描述性,因为您可以使用该名称查找有关源连接的信息。 |
description |
可包含的可选值,用于提供有关源连接的更多信息。 |
baseConnectionId |
基本连接ID为 Mixpanel. 此ID是在前面的步骤中生成的。 |
connectionSpec.id |
与源对应的连接规范ID。 |
data.format |
的格式 Mixpanel 要摄取的数据。 目前,唯一支持的数据格式是 json . |
params.projectId |
您的 Mixpanel 项目ID。 |
params.timezone |
您的 Mixpanel 项目。 |
响应
成功的响应会返回唯一标识符(id
)。 在后续步骤中需要此ID才能创建数据流。
{
"id": "246d052c-da4a-494a-937f-a0d17b1c6cf5",
"etag": "\"712a8c08-fda7-41c2-984b-187f823293d8\""
}
要在Platform中使用源数据,必须创建目标架构以根据您的需求构建源数据。 然后,目标架构用于创建包含源数据的Platform数据集。
通过对 架构注册表API.
有关如何创建目标XDM架构的详细步骤,请参阅 使用API创建模式.
通过对 目录服务API,在有效负载中提供目标架构的ID。
有关如何创建目标数据集的详细步骤,请参阅 使用API创建数据集.
目标连接表示与存储所摄取数据的目标的连接。 要创建目标连接,必须提供与数据湖相对应的固定连接规范ID。 此ID为: c604ff05-7f1a-43c0-8e18-33bf874cb11c
.
现在,您将唯一标识符作为目标架构作为目标数据集,并将连接规范ID用于数据湖。 使用这些标识符,您可以使用 Flow Service 用于指定将包含集客源数据的数据集的API。
API格式
POST /targetConnections
请求
以下请求会为 Mixpanel:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "{Mixpanel} Target Connection",
"description": "{Mixpanel} Target Connection",
"connectionSpec": {
"id": "fd2c8ff3-1de0-4f6b-8fa8-4264784870eb",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"dataSetId": "5ef4551c52e054191a61a99f"
}
}'
属性 | 描述 |
---|---|
name |
目标连接的名称。 确保目标连接的名称具有描述性,因为您可以使用此名称查找有关目标连接的信息。 |
description |
可包含的可选值,用于提供有关目标连接的更多信息。 |
connectionSpec.id |
与数据湖对应的连接规范ID。 此固定ID是: fd2c8ff3-1de0-4f6b-8fa8-4264784870eb . |
data.format |
的格式 Mixpanel 要引入平台的数据。 |
params.dataSetId |
在上一步中检索到的目标数据集ID。 |
响应
成功的响应会返回新目标连接的唯一标识符(id
)。 此ID是后续步骤所必需的。
{
"id": "7c96c827-3ffd-460c-a573-e9558f72f263",
"etag": "\"a196f685-f5e8-4c4c-bfbd-136141bb0c6d\""
}
要将源数据摄取到目标数据集,必须先将其映射到目标数据集所附加的目标架构。 这是通过执行POST请求来实现的 Data Prep API ,在请求有效负载中定义数据映射。
API格式
POST /conversion/mappingSets
请求
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"version": 0,
"xdmSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/995dabbea86d58e346ff91bd8aa741a9f36f29b1019138d4",
"xdmVersion": "1.0",
"id": null,
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "data.distinct_id",
"destination": "_extconndev.distinct_id",
"name": "distinct_id",
"description": "Mixpanel"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.event_name",
"destination": "_extconndev.event_name"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.import",
"destination": "_extconndev.import"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.insert_id",
"destination": "_extconndev.insert_id"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.item_id",
"destination": "_extconndev.item_id"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.item_name",
"destination": "_extconndev.item_name"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.item_price",
"destination": "_extconndev.item_price"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.mp_api_endpoint",
"destination": "_extconndev.mp_api_endpoint"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.mp_api_timestamp_ms",
"destination": "_extconndev.mp_api_timestamp_ms"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.mp_processing_time_ms",
"destination": "_extconndev.mp_processing_time_ms"
},
{
"sourceType": "ATTRIBUTE",
"source": "data.time",
"destination": "_extconndev.time"
}
]
}'
属性 | 描述 |
---|---|
xdmSchema |
的ID 目标XDM架构 生成。 |
mappings.destinationXdmPath |
源属性映射到的目标XDM路径。 |
mappings.sourceAttribute |
需要映射到目标XDM路径的源属性。 |
mappings.identity |
一个布尔值,用于指定是否将映射集标记为 Identity Service. |
响应
成功的响应会返回新创建映射的详细信息,包括其唯一标识符(id
)。 在后续步骤中需要此值才能创建数据流。
{
"id": "bf5286a9c1ad4266baca76ba3adc9366",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
将数据从 Mixpanel 平台是创建数据流。 现在,您已准备以下必需值:
数据流负责从源中调度和收集数据。 通过在有效负载中提供先前提到的值时执行POST请求,可以创建数据流。
要计划摄取,您必须首先将开始时间值设置为以秒为单位的新纪元时间。 然后,您必须将频率值设置为以下五个选项之一: once
, minute
, hour
, day
或 week
. 间隔值可指定两个连续摄取之间的时间段,但是创建一次性摄取不需要设置间隔。 对于所有其他频率,间隔值必须设置为等于或大于 15
.
API格式
POST /flows
请求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "{Mixpanel} dataflow",
"description": "{Mixpanel} dataflow",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"246d052c-da4a-494a-937f-a0d17b1c6cf5"
],
"targetConnectionIds": [
"7c96c827-3ffd-460c-a573-e9558f72f263"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "bf5286a9c1ad4266baca76ba3adc9366",
"mappingVersion": "0"
}
}
],
"scheduleParams": {
"startTime": "1625040887",
"frequency": "minute",
"interval": 15
}
}'
属性 | 描述 |
---|---|
name |
数据流的名称。 确保数据流的名称具有描述性,因为您可以使用该名称查找有关数据流的信息。 |
description |
可包含的可选值,用于提供有关数据流的更多信息。 |
flowSpec.id |
创建数据流所需的流规范ID。 此固定ID是: 6499120c-0b15-42dc-936e-847ea3c24d72 . |
flowSpec.version |
流量规范ID的相应版本。 此值默认为 1.0 . |
sourceConnectionIds |
的 源连接ID 生成。 |
targetConnectionIds |
的 目标连接ID 生成。 |
transformations |
此属性包含需要应用于数据的各种转换。 将不符合XDM的数据引入平台时,需要使用此属性。 |
transformations.name |
分配给转换的名称。 |
transformations.params.mappingId |
的 映射ID 生成。 |
transformations.params.mappingVersion |
映射ID的相应版本。 此值默认为 0 . |
scheduleParams.startTime |
此属性包含有关数据流的摄取调度的信息。 |
scheduleParams.frequency |
数据流收集数据的频率。 可接受的值包括: once , minute , hour , day 或 week . |
scheduleParams.interval |
该间隔指定两个连续流运行之间的周期。 间隔的值应为非零整数。 将频率设置为时,不需要间隔 once 且应大于或等于 15 的其他频率值。 |
响应
成功的响应会返回ID(id
)。 您可以使用此ID来监视、更新或删除您的数据流。
{
"id": "993f908f-3342-4d9c-9f3c-5aa9a189ca1a",
"etag": "\"510bb1d4-8453-4034-b991-ab942e11dd8a\""
}
以下部分提供了有关可以监视、更新和删除数据流的步骤的信息。
创建数据流后,您可以监视通过其摄取的数据,以查看有关流量运行、完成状态和错误的信息。 有关完整的API示例,请阅读 使用API监控源数据流.
通过向发出PATCH请求,更新数据流的详细信息(如其名称和描述),以及其运行计划和关联的映射集 /flows
端点 Flow Service API,同时提供数据流的ID。 发出PATCH请求时,必须提供数据流的唯一 etag
在 If-Match
标题。 有关完整的API示例,请阅读 使用API更新源数据流.
通过向执行PATCH请求,更新源帐户的名称、说明和凭据 Flow Service API,同时将基本连接ID作为查询参数提供。 发出PATCH请求时,必须提供源帐户的唯一 etag
在 If-Match
标题。 有关完整的API示例,请阅读 使用API更新源帐户.
通过执行对的DELETE请求删除数据流 Flow Service API,同时提供要作为查询参数一部分删除的数据流的ID。 有关完整的API示例,请阅读 使用API删除数据流.
通过向执行DELETE请求删除您的帐户 Flow Service API,同时提供要删除的帐户的基本连接ID。 有关完整的API示例,请阅读 使用API删除源帐户.