HTTP跟踪API源


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

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

身份验证

通过发送项目的验证到Tracking API写关键还有一个请求。身份验证使用HTTP Basic Auth,它包含一个' username:password ',它是base64编码的,并以字符串' Basic '作为前缀。

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

内容类型

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

错误

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

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

速率限制

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

马克斯请求大小

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

识别

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

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

例子识别电话:

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

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

类型 描述
anonymousId 如果设置了userID则是可选的 字符串 用于用户ID的伪独特替代,因为您没有绝对唯一的标识符。需要userId或anonymousId。
看到身份文档为更多的细节。
上下文 可选 对象 提供有关消息的有用上下文的额外信息字典,但与类似的API调用不直接相关知识产权地址或语言环境看到环境领域的文档为更多的细节。
集成 可选 对象 要启用或禁用的目标字典参见目的地领域文档为更多的细节。
时间戳 可选 日期 消息本身发生的时间戳,由段跟踪API默认为当前时间,作为ISO-8601.日期格式的字符串。如果事件刚刚发生,我们将使用服务器的时间。如果从过去导入数据,请确保提供时间戳花瓶的时间戳字段Docs.有关详细信息。
特征 可选 对象 自由形式的字典的特点的用户,喜欢电子邮件的名字.看到特征领域文档获取保留的特征名称列表。
用户标识 如果设置了anonymousID则可选 字符串 数据库中用户的唯一标识符。需要userId或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的伪独特替代,因为您没有绝对唯一的标识符。需要userId或anonymousId。
看到身份文档为更多的细节。
上下文 可选 对象 提供有关消息的有用上下文的额外信息字典,但与类似的API调用不直接相关知识产权地址或语言环境看到环境领域的文档为更多的细节。
事件 要求 字符串 用户执行的操作名称。看到活动现场文档为更多的细节。
集成 可选 对象 要启用或禁用的目标字典参见目的地领域文档为更多的细节。
特性 可选 对象 事件属性的自由形式字典,比如收入看到文档属性获取保留属性名的列表。
时间戳 可选 日期 消息本身发生的时间戳,由段跟踪API默认为当前时间,作为ISO-8601.日期格式的字符串。如果事件刚刚发生,我们将使用服务器的时间。如果从过去导入数据,请确保提供时间戳花瓶的时间戳字段Docs.有关详细信息。
用户标识 如果设置了anonymousID则可选 字符串 数据库中用户的唯一标识符。需要userId或anonymousId。看到身份文档为更多的细节。

发现细节事件命名的最佳实践以及追踪方法有效载荷在我们的规范

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

例子页面电话:

文章https://api.segment.io/v1/page
“标识”“019MR8MF4R”“名称”“跟踪HTTP API”“时间戳”“2012 - 12 - 02 - t00:31:29.738z”

页面Call包含以下字段:

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

浏览页面有效载荷在我们的规范

屏幕

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

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

例子屏幕电话:

文章https://api.segment.io/v1/screen
“标识”“019MR8MF4R”“名称”“跟踪HTTP API”“时间戳”“2012 - 12 - 02 - t00:31:29.738z”

屏幕Call包含以下字段:

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

浏览屏幕有效载荷在我们的规范

集团

集团让您关联识别用户与一群。一个组可以是一个公司,组织,帐户,项目新万博app2.0下载或团队!它还允许您记录关于该团体的自定义特征,如行业或雇员数量。

这对于像对讲机提前Totango,因为它将用户联系在一起集团其他的用户。

例子集团电话:

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

集团Call包含以下字段:

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

浏览有关集团包括集团有效载荷在我们的规范

别名

别名就是你如何把一个身份和另一个身份联系起来。这是一种先进的方法,但是需要它来成功地管理用户身份一些我们的目的地。

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

例子别名电话:

文章https://api.segment.io/v1/alias
“previousId”“39239-239239-239239-23923”“标识”“019MR8MF4R”“时间戳”“2012 - 12 - 02 - t00:31:29.738z”

别名Call包含以下字段:

类型 描述
上下文 可选 对象 提供有关消息的有用上下文的额外信息字典,但与类似的API调用不直接相关知识产权地址或语言环境看到环境领域的文档为更多的细节。
集成 可选 对象 要启用或禁用的目标字典参见目的地领域文档为更多的细节。
previousId 要求 字符串 前面的用户唯一标识符参见先前的ID字段文档为更多的细节。
时间戳 可选 日期 消息本身发生的时间戳,由段跟踪API默认为当前时间,作为ISO-8601.日期格式的字符串。如果事件刚刚发生,我们将使用服务器的时间。如果从过去导入数据,请确保提供时间戳花瓶的时间戳字段Docs.有关详细信息。
用户标识 如果设置了anonymousID则可选 字符串 数据库中用户的唯一标识符。需要userId或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 - 02 - t00:30:12.984z”],“背景”“设备”“类型”“电话”“名称”“苹果iPhone 6”
类型 描述
批处理数组 一系列识别集团追踪页面屏幕方法调用。每次调用必须有一个类型具有有效方法名称的属性。
上下文对象,可选 相同的语境对于其他调用,但它将与批处理中每个项中的任何上下文合并。
集成对象,可选 相同的目的地用于其他调用,但它将与批处理中每个项目中的任何目的地合并。

选择目的地

别名集团识别页面追踪调用都可以传递一个对象集成它可以让你打开或关闭某些目的地。缺省情况下,所有目的地都是启用的。

这里有一个例子识别调用它只去Mixpanel和Kissmetrics:

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

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

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

注意:

  • 在业务级别可用,过滤跟踪调用可以直接从源模式页面上的Segment UI完成。如果可能的话,我们建议使用UI,因为它是管理过滤器的一种更简单的方法,并且可以在不更改代码的情况下进行更新。

  • 如果您使用祖父计划,通过Segment仪表板过滤的服务器端发送的事件仍将计入您的API使用。

收集IP地址

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

故障排除

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

我的调试器中没有事件

  1. 仔细检查是否正确设置了库。

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

没有事件在我的最终工具

  1. 仔细检查你的目的地证件。

  2. 确保正在进行故障排除的目的地可以接受服务器端API调用。兼容性显示在目标文档页和您的段源目的地页上的工作表。

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

最后更改:2021年5月27日



开始使用细分

细分是将你的网站和手机应用数据整合到300多个分析和增长工具中的最简单方法。
创建免费帐户