Data Destinations (ETL) 可用性 API

关注
Avatar
Dora Kishinevsky
Updated

使用 Data Destinations Availability API 检查您的数据目标中的数据是否为最新。该 API 检查您端 (您的 S3 等) 昨天的数据是否与 Singular 数据库中最新的数据相同。

对于您配置的每个数据目标,API 返回 is_all_data_updated (true 或 false)。它还为数据目标导出中包含的每个数据连接器返回 is_updated。

请注意,所比较的数据始终是昨天的数据。

Data Destinations Availability 端点

方法 端点
GET https://api.singular.net/api/v2.0/data_destinations_availability_status

示例查询 (Python) 

import requests
url = "https://api.singular.net/api/v2.0/data_destinations_availability_status"
queryparams = {"api_key":"<API_KEY>"}
response = requests.get(url=url, params=queryparams)

查询参数

参数 格式 描述
api_key String 您的 Singular API 密钥 (可在 Singular Web 应用程序的 Developer Tools > Reporting API Key 中获取)。

示例输出

以下示例显示了一个数据目标的结果,其中包含两个数据连接器。在此示例中,所有数据连接器的 "is_updated" 都为 true,因此 "is_all_data_updated" 为 true。 

{
    'status': 0,
    'substatus': 0,
    'value': [
        {
            'data_destination_info': {
            'data_destination_id': 'dhjeghdj11',
            'data_destination_source_name': 'Postgres Destination',
            'data_destination_schema': 'Campaign and creative data',
            'is_all_data_updated': True,
            'status': 'Active',
            'data_connectors': [
                {
                    'data_connector_id': 'dhe836dh',
                    'display_name':  'AdWords',
                    'data_connector_username': 'myUserName',
                    'is_updated': True,
                    'is_data_delay': False,
                    'is_loading_progress': False
                },{
                    'data_connector_id':  '75encfrr',
                    'display_name':  'Vungle',
                    'data_connector_username': 'myUserName',
                    'is_updated': True,
                    'is_data_delay': False,
                    'is_loading_progress': False
                }

                ...

输出参数

参数 格式 描述
'data_destination_info' 对象中的参数
data_destination_id String 数据目标的唯一标识符。
data_destination_source_name String Singular Web 应用程序中显示的数据目标名称。
data_destination_schema String Singular Web 应用程序中显示的数据目标架构。这有助于您区分配置到同一数据目标的两个导出。
is_all_data_updated Boolean 如果所有相关数据连接器的数据已在数据目标中更新,则为 True。
每个数据连接器的参数
data_connector_id String 数据连接器的唯一标识符。
display_name String Singular Web 应用程序中显示的数据连接器名称。
data_connector_username String 在 Singular Web 应用程序中配置的数据连接器的用户名。如果您对同一广告网络配置了多个具有不同凭据并提取不同数据的连接器,这有助于您识别正确的数据连接器。
is_updated Boolean 如果此数据连接器的数据已在数据目标 (您的 BI 平台、S3 存储桶等) 中更新,则为 True。
is_loading_progress Boolean 如果此数据连接器的数据仍在加载到数据目标,则为 True。如果 is_loading_progress 为 true,则解释了为什么 is_updated 为 false。请等待加载完成后再进行检查。
is_data_delay Boolean 如果 Singular 在从数据源 (例如广告网络) 提取数据时遇到延迟,则为 True。如果 is_data_delay 为 true,则解释了为什么 is_updated 为 false。稍后再次检查,或在 Singular Web 应用程序的 Data Connectors 页面查看有关延迟状态的详细信息。