使用流服务API监控数据流

Adobe Experience Platform允许从外部源摄取数据,同时允许您使用Experience Platform服务来构建、标记和增强传入数据。 您可以从各种源(如Adobe应用程序、基于云的存储、数据库和许多其他源)中摄取数据。 此外,Experience Platform还允许向外部合作伙伴激活数据。

Flow Service用于收集和集中Adobe Experience Platform中各种不同来源的客户数据。 该服务提供了一个用户界面和RESTful API,所有受支持的源和目标都可通过该用户界面连接。

本教程介绍了使用Flow Service API监控流运行数据的完整性、错误和量度的步骤。

快速入门

本教程要求您具有有效数据流的ID值。 如果您没有有效的数据流ID,请从源概述目标概述中选择您选择的连接器,并按照尝试本教程之前概述的步骤操作。

本教程还要求您实际了解Adobe Experience Platform的以下组件:

  • 目标:目标是预建的与常用应用程序的集成,可无缝激活Experience Platform中的数据,以用于跨渠道营销活动、电子邮件活动、定向广告和许多其他用例。
  • : Experience Platform允许从各种源摄取数据,同时允许您使用Experience Platform服务来构建、标记和增强传入数据。
  • 沙盒: Experience Platform提供将单个Experience Platform实例划分为单独虚拟环境的虚拟沙盒,以帮助开发和改进数字体验应用程序。

以下部分提供了使用Flow Service API成功监视流量运行所需了解的其他信息。

正在读取示例 API 调用

本教程提供了示例API调用来演示如何格式化请求。 这些包括路径、必需的标头和格式正确的请求负载。 还提供了在 API 响应中返回的示例 JSON。 有关示例 API 调用的文档中所用惯例的信息,请参阅故障排除指南中的如何读取示例 API 调用 Experience Platform。

收集所需标头的值

为调用 Experience Platform API,您必须先完成身份验证教程。 完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值,如下所示:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Experience Platform中的所有资源(包括属于Flow Service的资源)都被隔离到特定的虚拟沙盒中。 对Experience Platform API的所有请求都需要一个标头,用于指定将在其中执行操作的沙盒的名称:

  • x-sandbox-name: {SANDBOX_NAME}

所有包含有效负载(POST、PUT、PATCH)的请求都需要一个额外的媒体类型标头:

  • Content-Type: application/json

监控流运行

创建数据流后,对Flow Service API执行GET请求。

API格式

GET /runs?property=flowId=={FLOW_ID}
参数
描述
{FLOW_ID}
要监视的数据流的唯一id值。

请求

以下请求检索现有数据流的规范。

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/runs?property=flowId==c9cef9cb-c934-4467-8ef9-cbc934546741' \
    -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}'

响应

成功的响应将返回有关流运行的详细信息,包括其创建日期、源和目标连接的信息,以及流运行的唯一标识符(id)。

{
    "items": [
        {
            "id": "65b7cfcc-6b2e-47c8-8194-13005b792752",
            "createdAt": 1607520228894,
            "updatedAt": 1607520276948,
            "createdBy": "{CREATED_BY}",
            "updatedBy": "{UPDATED_BY}",
            "createdClient": "{CREATED_CLIENT}",
            "updatedClient": "{UPDATED_CLIENT}",
            "sandboxId": "{SANDBOX_ID}",
            "sandboxName": "prod",
            "imsOrgId": "{ORG_ID}",
            "flowId": "f00c8762-df2f-432b-a7d7-38999fef5e8e",
            "etag": "\"560266dc-0000-0200-0000-5fd0d0140000\"",
            "metrics": {
                "durationSummary": {
                    "startedAtUTC": 1607520205922,
                    "completedAtUTC": 1607520262413
                },
                "sizeSummary": {
                    "inputBytes": 87885,
                    "outputBytes": 56730
                },
                "recordSummary": {
                    "inputRecordCount": 26758,
                    "outputRecordCount": 26758,
                    "failedRecordCount": 0
                },
                "fileSummary": {
                    "inputFileCount": 11,
                    "outputFileCount": 11,
                    "activityRefs": [
                        "37b34f84-1ada-11eb-adc1-0242ac120002"
                    ]
                },
                "statusSummary": {
                    "status": "success"
                }
            },
            "activities": [
                {
                    "id": "4f008a00-3a04-11eb-adc1-0242ac120002",
                    "name": "Copy Activity",
                    "updatedAtUTC": 0,
                    "durationSummary": {
                        "startedAtUTC": 1607520205922,
                        "completedAtUTC": 1607520236968
                    },
                    "sizeSummary": {
                        "inputBytes": 87885,
                        "outputBytes": 87885
                    },
                    "recordSummary": {
                        "inputRecordCount": 26758,
                        "outputRecordCount": 26758
                    },
                    "fileSummary": {
                        "inputFileCount": 11,
                        "outputFileCount": 11
                    },
                    "statusSummary": {
                        "status": "success"
                    }
                },
                {
                    "id": "37b34f84-1ada-11eb-adc1-0242ac120002",
                    "name": "Promotion Activity",
                    "updatedAtUTC": 0,
                    "durationSummary": {
                        "startedAtUTC": 1607520244985,
                        "completedAtUTC": 1607520262413
                    },
                    "sizeSummary": {
                        "inputBytes": 26758,
                        "outputBytes": 56730
                    },
                    "recordSummary": {
                        "inputRecordCount": 26758,
                        "outputRecordCount": 26758,
                        "failedRecordCount": 0
                    },
                    "fileSummary": {
                        "inputFileCount": 11,
                        "outputFileCount": 2,
                        "extensions": {
                            "manifest": {
                                "fileInfo": "https://platform.adobe.io/data/foundation/export/batches/01ES3TRN69E9W2DZ770XCGYAH1/meta?path=input_files",
                                "pathPrefix": "bucket1/csv_test/"
                            }
                        }
                    },
                    "statusSummary": {
                        "status": "success"
                    }
                }
            ]
        }
    ]
}
属性
描述
items
包含与特定流运行关联的元数据的单个有效负载。
metrics
流运行中的数据特征。
activities
显示如何转换数据。
durationSummary
流运行的开始和结束时间。
sizeSummary
数据量(字节)。
recordSummary
数据的记录计数。
fileSummary
数据的文件计数。
fileSummary.extensions
包含特定于活动的信息。 例如,manifest只是“促销活动”的一部分,因此它包含在extensions对象中。
statusSummary
显示运行流是成功还是失败。

后续步骤

按照本教程,您已使用Flow Service API检索有关数据流的量度和错误信息。 您现在可以继续根据摄取计划监视数据流,以跟踪其状态和摄取率。 有关如何监视源数据流的信息,请阅读使用用户界面🔗的监视源数据流的教程。 有关如何监视目标的数据流的详细信息,请阅读使用用户界面的监视目标的数据流教程。

要将多个XDM实体发送到数据流,请在HTTP请求中使用messages数组或上传包含多个记录的文件(CSV、JSON或Parquet)。 有关详细指导和最佳实践,请阅读如何将多个XDM实体发送到数据流

recommendation-more-help
d4f38c9a-ed8e-4b74-98e7-57b4df1b999f