HTTP跟踪API源


Segment HTTP Tracking API允许您记录任何网站或应用程序的分析数据。请求到达我们的服务器,我们将您的数据路由到任何您想要的目的地!

段有本地来源对于全部用于高性能并且是开源的大多数用例(JavaScript,iOS等)。但有时您可能想直接发送到HTTP API - 这就是此参考的内容。

验证

通过发送您的项目的身份验证到跟踪API写关键以及一个请求。身份验证使用HTTP Basic Auth,该验证涉及“用户名:密码”,它为Base64编码,并使用字符串“基本”。

在实践中,意味着采取段来源写关键'abc123',作为用户名,添加冒号,然后留空密码字段。Base64编码后“abc123:”就变成了'ywjjmtizog ==';这个在授权头文件中是这样传递的:“授权:基本YWJjMTIzOg = =”

内容类型

要将数据发送到我们的HTTP API,必须将内容类型标头设置为“application / json”

错误

我们目前返回一个200所有API请求的响应都应在段调试器中完成调试。唯一的例外是如果请求太大/ JSON无效,它将响应a400

我们正在努力为用户提供更多的错误和更有帮助的反馈。如果你有什么建议,让我们知道

速率限制

没有难率限制,点段将丢弃您的数据。我们要求您需要以超过每秒500个请求的速率导入,联系我们第一。请求包括与批处理方法,这意味着您可以在单个请求内发送大量事件。

马克斯请求大小

最多有一个32 kb根据正常的API请求。的API端点最多接受500KB.每个请求,限制32 kb批量中每次事件。如果要从服务器源发送数据,则段的API响应400个糟糕的要求如果超过这些限制。

识别

识别让你将用户与他们的行为联系起来,并记录他们的特征。它包括一个唯一的用户ID和您所知道的关于用户的任何可选特征。

我们建议打电话识别当用户的账号第一次创建时,只有当他们的特征发生变化时才会再次识别。

例子识别电话:

post https://api.segent.io/v1/identify.
“用户身份”“019MR8MF4R”“特征”“电子邮件”“pgibbons@example.com”“名称”“彼得·吉本斯”“行业”“技术”},“背景”“知识产权”“24.5.68.47”},“时间戳”“2012-12-02T00:30:08.276z”

此调用是通过其唯一的用户ID识别用户(您在数据库中知道它们的一个)并将其标记电子邮件名称,行业特征。

类型 描述
anonymousId 可选,如果userid被设置为 字符串 用于用户ID的伪独特替代,因为您没有绝对唯一的标识符。需要用户ID或AnonymousID。
看看身份文档为更多的细节。
上下文 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关知识产权地址或语言环境看看环境领域的文档为更多的细节。
集成 可选 目的 要启用或禁用的目的地字典参见目的地字段文档为更多的细节。
时间戳 可选 日期 消息本身发生时的时间戳,Segment Tracking API默认为当前时间ISO-8601.日期格式的字符串。如果事件刚刚发生,则省略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了时间戳花瓶的时间戳字段Docs.有关详细信息。
特征 可选 目的 自由形式的用户特质词典,喜欢电子邮件要么名称.看看特质字段文档获取保留特征名列表。
用户标识 如果改为anonymousID,则是可选的 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档为更多的细节。

查询识别方法有效载荷在我们的规范

追踪

追踪允许您录制用户执行的操作。每个动作都触发了我们所谓的“事件”,它也可以具有关联属性。

您需要跟踪对您网站成功指标的事件,如签约物品购买要么文章书签

开始时,我们建议只跟踪几个重要事件。你可以随时添加更多内容!

例子追踪电话:

文章https://api.segment.io/v1/track
“用户身份”“019MR8MF4R”“事件”“项目购买”“属性”“名称”“跳到结论垫”“收入”14.99},“背景”“知识产权”“24.5.68.47”},“时间戳”“2012 - 12 - 02 - t00:30:12.984z”

追踪事件属性可以是您想要记录的任何内容。在这种情况下,名称收入

追踪Call有以下字段:

类型 描述
anonymousId 可选,如果userid被设置为 字符串 用于用户ID的伪独特替代,因为您没有绝对唯一的标识符。需要用户ID或AnonymousID。
看看身份文档为更多的细节。
上下文 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关知识产权地址或语言环境看看环境领域的文档为更多的细节。
事件 必需的 字符串 用户已执行的操作的名称。看看事件字段文档为更多的细节。
集成 可选 目的 要启用或禁用的目的地字典参见目的地字段文档为更多的细节。
特性 可选 目的 事件属性的自由形式字典,比如收入看看文档属性获取保留属性名列表。
时间戳 可选 日期 消息本身发生时的时间戳,Segment Tracking API默认为当前时间ISO-8601.日期格式的字符串。如果事件刚刚发生,则省略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了时间戳花瓶的时间戳字段Docs.有关详细信息。
用户标识 如果改为anonymousID,则是可选的 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档为更多的细节。

查找详情事件命名的最佳实践以及追踪方法有效载荷在我们的规范

方法允许您在网站上录制页面视图,以及有关正在查看的页面的可选额外信息。

例子电话:

文章https://api.segment.io/v1/page
“用户身份”“019MR8MF4R”“名称”“跟踪HTTP API”“时间戳”“2012-12-02T00:31:29.738z”

Call有以下字段:

类型 描述
anonymousId 可选,如果userid被设置为 字符串 用于用户ID的伪独特替代,因为您没有绝对唯一的标识符。需要用户ID或AnonymousID。
看看身份文档为更多的细节。
上下文 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关知识产权地址或语言环境看看环境领域的文档为更多的细节。
集成 可选 目的 要启用或禁用的目的地字典参见目的地字段文档为更多的细节。
名称 可选 字符串 例如,大多数网站都有一个“注册”页面,这可以用于标记,所以你可以看到用户通过你的漏斗移动。
特性 可选 目的 页面属性的自由格式字典,比如url介绍人看看属性字段文档获取保留属性名列表。
时间戳 可选 日期 消息本身发生时的时间戳,Segment Tracking API默认为当前时间ISO-8601.日期格式的字符串。如果事件刚刚发生,则省略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了时间戳花瓶的时间戳字段Docs.有关详细信息。
用户标识 如果改为anonymousID,则是可选的 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档为更多的细节。

查询有效载荷在我们的规范

屏幕

屏幕方法可以让您在用户看到移动应用程序屏幕时进行记录。

你要发送屏幕消息,每当用户请求一个页面的应用程序。

例子屏幕电话:

post https://api.segent.io/v1/screen.io/v1/Screen.
“用户身份”“019MR8MF4R”“名称”“跟踪HTTP API”“时间戳”“2012-12-02T00:31:29.738z”

屏幕Call有以下字段:

_
类型 描述
anonymousId 可选,如果userid被设置为 字符串 用于用户ID的伪独特替代,因为您没有绝对唯一的标识符。需要用户ID或AnonymousID。
看看身份文档为更多的细节。
上下文 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关知识产权地址或语言环境看看环境领域的文档为更多的细节。
集成 可选 目的 要启用或禁用的目的地字典参见目的地字段文档为更多的细节。
名称 可选 字符串 屏幕的名称看到了名称字段文档为更多的细节。
特性 可选 目的 自由形式屏幕属性词典,喜欢名称看看属性字段文档获取保留属性名列表。
时间戳 可选 日期 消息本身发生时的时间戳,Segment Tracking API默认为当前时间ISO-8601.日期格式的字符串。如果事件刚刚发生,则省略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了时间戳花瓶的时间戳字段Docs.有关详细信息。
用户标识 如果改为anonymousID,则是可选的 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档为更多的细节。

查询屏幕有效载荷在我们的规范

团体

团体让你联想到识别用户与一群。团体可以是公司、组织、账户、项目或团队新万博app2.0下载!它还可以让你记录下该群体的自定义特征,比如行业或员工数量。

这对于像这样的工具很有用对讲机提前Totango,因为它将用户联系在一起团体其他的用户。

例子团体电话:

文章https://api.segment.io/v1/group
“用户身份”“019MR8MF4R”“groupid”“8 e9df332ac”“特征”“名称”“Initech”“行业”“技术”“雇员”420},“时间戳”“2012-12-02T00:31:38.208z”

团体Call有以下字段:

类型 描述
anonymousId 可选,如果userid被设置为 字符串 用于用户ID的伪独特替代,因为您没有绝对唯一的标识符。需要用户ID或AnonymousID。
看看身份文档为更多的细节。
上下文 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关知识产权地址或语言环境看看环境领域的文档为更多的细节。
Groupid. 必需的 字符串 数据库中组的唯一标识符。看看组ID字段文档有关详细信息。
集成 可选 目的 要启用或禁用的目的地字典参见目的地字段文档为更多的细节。
时间戳 可选 日期 消息本身发生时的时间戳,Segment Tracking API默认为当前时间ISO-8601.日期格式的字符串。如果事件刚刚发生,则省略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了时间戳花瓶的时间戳字段Docs.有关详细信息。
特征 可选 目的 自由形式的小组特征词典,喜欢电子邮件要么名称看看特质字段文档获取保留特征名列表。
用户标识 如果改为anonymousID,则是可选的 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档为更多的细节。

了解更多有关团体包括团体有效载荷在我们的规范

别名

别名是你如何与另一个身份关联。这是一种高级方法,但需要成功管理用户身份一些我们的目的地。

Mixpanel年它用于将匿名用户与识别的用户联系起来,一旦注册。为了只有如果您的用户切换ID,则可以使用“别名”重命名'userid'。

例子别名电话:

https://api.segent.io/v1/alias.io.
“previousid”“39239-239239-239239-23923”“用户身份”“019MR8MF4R”“时间戳”“2012-12-02T00:31:29.738z”

别名Call有以下字段:

类型 描述
上下文 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关知识产权地址或语言环境看看环境领域的文档为更多的细节。
集成 可选 目的 要启用或禁用的目的地字典参见目的地字段文档为更多的细节。
previousId 必需的 字符串 以前的用户唯一标识符参见以前的ID字段文档为更多的细节。
时间戳 可选 日期 消息本身发生时的时间戳,Segment Tracking API默认为当前时间ISO-8601.日期格式的字符串。如果事件刚刚发生,则省略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了时间戳花瓶的时间戳字段Docs.有关详细信息。
用户标识 如果改为anonymousID,则是可选的 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档为更多的细节。

有关的详细资料别名呼叫和载荷,检查我们的规范

历史进口

您可以通过添加来导入历史数据时间戳对您的任何方法调用的参数。如果您刚刚切换到段,这可能会有所帮助。

历史导入只能在能够接受历史时间戳数据的目的地中进行。大多数分析工具,如Mixpanel、Amplitude、Kissmetrics等,都可以很好地处理这类数据。不接受历史数据的一个常见目的地是谷歌Analytics,因为它们的API不能接受历史数据。

笔记:如果你正在跟踪现在发生的事情,请留出来时间戳我们的服务器会为你记录请求时间。

批处理

方法允许您发送一系列识别团体追踪屏幕请求单一批处理,保存出站的请求。我们的服务器端和移动来源为了提高性能,请自动使用此方法。

最多有一个500KB.每批请求和32 kb每一个电话。

是这样的请求签名如下:

https://api.segent.io/v1/batch.io/v1/batch.
“批”“类型”“确认”“用户身份”“019MR8MF4R”“特征”“电子邮件”“jake@yahoo.com”“名称”“杰克彼得森”“年龄”26.},“时间戳”“2012-12-02T00:30:08.276z”},“类型”“跟踪”“用户身份”“019MR8MF4R”“事件”“歌”“属性”“名称”“为你坠落”“艺术家”“Dierks Bentley”},“时间戳”“2012 - 12 - 02 - t00:30:12.984z”},“类型”“确认”“用户身份”“971 mj8mk7p”“特征”“电子邮件”“cindy@example.com”“名称”“Cindy Gonzalez”“年龄”23.},“时间戳”“2015 - 2 - 02 - t00:30:08.276z”},“类型”“跟踪”“用户身份”“971 mj8mk7p”“事件”“歌”“属性”“名称”“正确”“艺术家”“珍妮弗·洛佩兹”},“时间戳”“2015-2-02T00:30:12.984z”],“背景”“设备”“类型”“电话”“名称”“Apple iPhone 6”
类型 描述
数组 一系列识别团体追踪屏幕方法调用。每次调用必须有一个类型具有有效方法名称的属性。
上下文对象,可选 相同的语境但它将与批处理中每个项中的任何上下文合并。
集成对象,可选 相同的目的地但它将与批处理中每个项中的任何目的地合并。

选择目的地

别名团体识别追踪调用都可以传递一个对象集成这让您打开或关闭某些目的地。默认情况下,所有目的地都已启用。

这里有一个例子识别呼叫只能进入MixPanel和Kissmetrics:

post https://api.segent.io/v1/identify.
“用户身份”“019MR8MF4R”“特征”“电子邮件”“pgibbons@example.com”“名称”“彼得·吉本斯”“行业”“技术”},“背景”“知识产权”“24.5.68.47”},“时间戳”“2012-12-02T00:30:08.276z”“集成”“所有”“mixpanel”真正的“只有”真正的“谷歌分析”

在这种情况下,我们指定我们希望此标识只能转到MixPanel和Kissmetrics。“所有”:假的说除非另有说明,否则应启用任何目的地。“Mixpanel年”:真的打开Mixpanel等。

目的地标志是区分大小写的和匹配目的地的名称在文档中(例如:“AdLearn开放平台”、“awe。sm”、“MailChimp的”,等等)。

笔记:

  • 在业务级别可用,可以从源模式页面上的段UI完成过滤跟踪呼叫。如果可能,我们建议使用UI,因为它是管理过滤器的更简单方法,并且可以在您身边未更新任何代码。

  • 如果您使用的是“祖父计划”,那么通过Segment仪表板过滤的服务器端发送的事件仍然会计入您的API使用。

收集IP地址

用户设备发起HTTP呼叫时,可以通过设置采集IP地址context.direct.真正的

故障排除

如果你遇到了困难,我们有一些帮助常见问题的建议。

我的调试器中没有事件

  1. 再次检查是否正确设置了库。

  2. 确保一旦库成功安装,就会调用我们的API方法之一 -识别追踪等。

我的最终工具中没有事件

  1. 仔细检查您的目的地的凭据。

  2. 确保正在进行故障诊断的目的地能够接受服务器端API调用。兼容性显示在目的地文档页,并在你的Segment source Destinations页的表格上。

  3. 检查目的地的文档要查看是否存在使用您尝试工作的方法和目标的其他要求。

最后更改:2021年5月27日



开始使用细分

段是将网站和移动应用程序数据集成到超过300个分析和增长工具的最简单方法。
要么
创建免费帐户