专题API -上传数据

请注意:本文假设您有一个ACCESS_TOKEN准备使用．下面代码中的示例将包括需要将单词ACCESS_TOKEN替换为令牌的地方。

注2:请参阅底部区域说明。

这些说明包括在bash符号中使用curl的示例，如果您使用的是不同的终端，可能需要进行一些修改才能使命令工作。这些命令还假定您正在使用美国数据中心。如果情况并非如此，则需要使用正确的基url修改示例。

组织标识符

theme中的每个帐户都有唯一的标识符。需要使用这个标识符来确定呼叫是针对哪个帐户进行的。这是因为同一个用户可以访问多个组织。标识符看起来像“sda29969”

获取组织标识符

下面的命令将返回您已访问的组织的列表及其详细信息。

curl——request GET \——url 'https://client.www.optionviager.com/api/organizations' \——header '授权:持有者ACCESS_TOKEN'
 . txt

这将返回您已访问的组织的列表及其标识符(以及一些权限信息)。返回数据的简化视图如下所示:

{"data": [{"currentUserCan": ["read:organization"]， "displayId": "sdt38517"， "name": "Sales Demo - Twitch"， "status": "normal"}， {"currentUserCan": ["read:organization"]， "displayId": "sda29969"， "name": "Sales Demo - Airlines"， "status": "normal"}]， "status": "success"}

需要的字段是“displayId”，因此“Sales Demo - Airlines”的标识符是“sda29969”

数据集标识符

每个数据集都有一个标识符(在API文档中称为调查标识符)。这个标识符对于识别上传的数据集是必要的。调查标识符是一个类似于217的数字

获取数据集标识符

要获得数据集标识符，您将需要组织标识符，因此请确保首先遵循上面的说明。

在一个组织中列出你可以访问的数据集(调查)的调用如下:

curl——request GET \——url 'https://client.www.optionviager.com/api/surveys?organization=ORGANIZATION_IDENTIFIER' \——header '授权:持有者ACCESS_TOKEN'
 . txt

需要替换的字段:

  • ORGANIZATION_IDENTIFIER:上面找到的组织标识符
  • ACCESS_TOKEN:访问令牌

这将返回一个数据集(调查)列表，其中包括进一步调用所需的标识符。返回数据的简化视图如下所示

{"data": [{"currentUserCan": ["read:survey"]， "dataSourceIntegration": null， "dataStatus": "READY"， "dataVolume": 0， "hasDraftThemes": false， "id": "217"， "includeInMetrics": true， "isPreview": false， "lastUpdated": "never"， "manualUploadAllowed": true， "name": "Airlines Customer Feedback"， "order": 0， "orgId": "sda29969"， "results": []， "surveyStatus": "normal"， "views": []}]， "status": "success"}

需要的字段是“id”，所以“Airlines Customer Feedback”的标识符是“217”。

上传数据

一旦有了数据集(调查)标识符，就可以上传文件了。该文件应该是csv或xlsx文件(所有数据都在第一个表中)，遵循以前上传的格式。如果您对这应该是什么格式有疑问，请联系您的客户成功代理，他们将能够帮助您。

假设文件名为'upload.csv'，并且与您调用的目录相同，适当的命令将是:

curl——request POST \——url "https://client.www.optionviager.com/api/survey/SURVEY_IDENTIFIER/upload" \——header "Authorization: holder ACCESS_TOKEN" \——form "file=@upload.csv"
 .csv . file=@上传

需要替换的字段:

  • SURVEY_IDENTIFIER:上面找到的数据集(调查)的标识符
  • ACCESS_TOKEN:访问令牌

上传和处理数据是异步的，这意味着返回的是一个作业标识符，可用于跟踪数据处理过程中的进度。该命令返回的示例如下:

{"data": {"callback_url": "" "， "job_status": "queued"， "job_type": "newdata"， "upload_id": "fae644a2-2a18-4fa2-8912-a20e69294924"}， "status": "success"}

从这个数据中我们可以看到，数据将被视为“newdata”(将被添加到现有数据中)，被“排队”处理，并且有一个“upload_id”为“fae644a2-2a18-4fa2-8912-a20e69294924”，可以用来跟踪上传的进度。

跟踪上传的进度

使用上传标识符，您可以跟踪上传的进度，并使用调查和上传标识符检查它是否成功或失败:

curl——request GET \——url "https://client.www.optionviager.com/api/survey/SURVEY_IDENTIFIER/upload/UPLOAD_IDENTIFIER" \——header '授权:持有人ACCESS_TOKEN'
 . curl——request GET \——url "https://client.www.optionviager.com/api/survey/SURVEY_IDENTIFIER/upload/UPLOAD_IDENTIFIER" \——header '授权:持有人ACCESS_TOKEN'
 . txt

需要替换的字段:

  • SURVEY_IDENTIFIER:上面找到的数据集(调查)的标识符
  • UPLOAD_IDENTIFIER:上传的标识符，在文件上传时返回。
  • ACCESS_TOKEN:访问令牌

这将返回关于上传的详细信息，包括上传时间和当前状态。

{"data": {"callback_url": "" "， "created": " 21-05-16 22:11:18.482655"， "created_by": "nathan@www.optionviager.com"， "delta_job": null， "filter_string": null， "full_job": null， "id": "fae644a2-2a18-4fa2-8912-a20e69294924"， "job_type": "ProcessingJobType. "newdata"， "original_filename": "upload.csv"， "processed": "None"， "review_job": null， "status": "ProcessingJobStatus "。Processing "}， "status": "success"}

状态字段可用于跟踪作业是否成功。

上传成功意味着什么?

这意味着数据已被接受，并已尝试与先前提供的数据合并。这包括检查列的数量是否正确，以及日期和分数等特殊列的类型。然而，数据有可能是成功的，但不正确。例如，如果列被转置，而注释列则被数字或空白字符串填充。

上传错误意味着什么?

如果上传错误，我们的支持将被通知，并将帮助追踪错误的原因。

关于区域的说明

专题支持不同地理区域保障数据主权。当调用主题API(或查看文档)时，重要的是查看正确的区域并使用正确的url。专题目前支持的区域有:

在登录到Thematic's Client Portal时，通过查看URL可以看到您所在的区域。