HTTP跟踪API源


分段HTTP跟踪API让你记录分析数据从任何网站或应用程序。请求击中我们的服务器,我们路由您的数据到任何目的地,您想要!

段有本地来源对于大多数用例(Javascript, iOS等),它们都是为高性能和开源而构建的。但有时您可能想要直接发送到HTTP API—这就是此引用的用途。

身份验证

通过发送项目来对跟踪API进行身份验证写钥匙还有一个请求。身份验证使用HTTP Basic Auth,其中包含base64编码的“用户名:密码”,并以字符串“Basic”作为前缀。

在实践中,这意味着获取一个段源写钥匙“abc123”,作为用户名,添加冒号,然后密码字段为空。base64编码后'abc123:'就变成了“YWJjMTIzOg = =”;这是像这样在授权头中传递的:“授权:基本YWJjMTIzOg = =”

内容类型

为了将数据发送到我们的HTTP API, content-type头必须设置为'application / json'

错误

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

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

速度限制

在什么时候段会删除数据,没有硬性速率限制。我们要求,如果您需要以每秒超过500个请求的速度导入,联系我们第一的。请求包括发送批次批量法,这意味着您可以在单个请求中发送大量事件。

最大要求大小

有一个最大值32 kb根据普通的API请求。这批处理API端点接受的最大值为500 kb每个请求,有一个限制32 kb批中的每个事件。如果您从服务器源发送数据,Segment的API将响应400错误请求如果超过了这些限制。

确认

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

我们建议致电确认首次创建用户帐户时的单一时间,并且仅在其特征变更时稍后再识别。

例子确认电话:

文章https://api.segment.io/v1/identify
{“标识”“019 mr8mf4r”“特征”{“电子邮件”“pgibbons@example.com”“名称”“彼得吉布堡”“行业”“技术”},“语境”{“知识产权”“24.5.68.47”},“时间戳”“2012 - 12 - 02 - t00:30:08.276z”}

这个调用是根据用户的惟一用户ID(您在数据库中通过这个ID认识他们)识别用户,并给他们贴上标签电子邮件的名字,行业特征。

类型 描述
匿名 可选,如果设置了userID 细绳 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。用户id或匿名id是必需的。
看到身份文档为更多的细节。
上下文 选修的 对象 提供关于消息的有用上下文的额外信息字典,但与API调用不直接相关知识产权地址或地区看到上下文字段文档为更多的细节。
集成 选修的 对象 要启用或禁用的目的地的字典,请参见目的地领域文档为更多的细节。
时间戳 选修的 日期 消息本身发生的时间戳,段跟踪API默认为当前时间,作为iso - 8601格式化日期字符串。如果事件刚刚发生,请将其留出,我们将使用服务器的时间。如果您正在从过去导入数据,请确保您提供一个时间戳花瓶的时间戳字段的文档更多的细节。
特征 选修的 对象 自由形式字典的用户特征,如电子邮件的名字。看到特征领域文档有关保留特征名称的列表。
用户身份 可选,如果设置了anonymoussid 细绳 数据库中用户的唯一标识符。用户id或匿名id是必需的。看到身份文档为更多的细节。

查找详情识别方法有效载荷在我们的规范

跟踪

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

你会想要追踪那些标志你网站成功的事件,比如注册物品购买书签条

要开始,我们建议追踪一些重要事件。你可以随时添加更多!

例子跟踪电话:

post https://api.segent.io/v1/track.
{“标识”“019 mr8mf4r”“事件”“购买物品”“特性”{“名称”“妄下结论垫”“收入”14.99},“语境”{“知识产权”“24.5.68.47”},“时间戳”“2012-12-02T00:30:12.984z”}

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

跟踪呼叫有以下字段:

类型 描述
匿名 可选,如果设置了userID 细绳 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。用户id或匿名id是必需的。
看到身份文档为更多的细节。
上下文 选修的 对象 提供关于消息的有用上下文的额外信息字典,但与API调用不直接相关知识产权地址或地区看到上下文字段文档为更多的细节。
事件 要求 细绳 用户执行的操作的名称。看到活动现场文档为更多的细节。
集成 选修的 对象 要启用或禁用的目的地的字典,请参见目的地领域文档为更多的细节。
属性 选修的 对象 事件属性的自由格式字典,例如收入看到文档属性获取保留属性名的列表。
时间戳 选修的 日期 消息本身发生的时间戳,段跟踪API默认为当前时间,作为iso - 8601格式化日期字符串。如果事件刚刚发生,请将其留出,我们将使用服务器的时间。如果您正在从过去导入数据,请确保您提供一个时间戳花瓶的时间戳字段的文档更多的细节。
用户身份 可选,如果设置了anonymoussid 细绳 数据库中用户的唯一标识符。用户id或匿名id是必需的。看到身份文档为更多的细节。

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

页面

页面方法允许您记录在您的网站上的页面浏览情况,以及有关正在浏览的页面的可选额外信息。

例子页面电话:

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

页面呼叫有以下字段:

类型 描述
匿名 可选,如果设置了userID 细绳 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。用户id或匿名id是必需的。
看到身份文档为更多的细节。
上下文 选修的 对象 提供关于消息的有用上下文的额外信息字典,但与API调用不直接相关知识产权地址或地区看到上下文字段文档为更多的细节。
集成 选修的 对象 要启用或禁用的目的地的字典,请参见目的地领域文档为更多的细节。
的名字 选修的 细绳 页面的名称例如,大多数网站都有一个“注册”页面,可用于标记,因此您可以在通过漏斗中移动时查看用户。
属性 选修的 对象 自由格式的字典页的属性,如url推荐人看到属性字段文档获取保留属性名的列表。
时间戳 选修的 日期 消息本身发生的时间戳,段跟踪API默认为当前时间,作为iso - 8601格式化日期字符串。如果事件刚刚发生,请将其留出,我们将使用服务器的时间。如果您正在从过去导入数据,请确保您提供一个时间戳花瓶的时间戳字段的文档更多的细节。
用户身份 可选,如果设置了anonymoussid 细绳 数据库中用户的唯一标识符。用户id或匿名id是必需的。看到身份文档为更多的细节。

查找详情页面有效载荷在我们的规范

屏幕

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

你会想要发送屏幕每当用户请求应用程序页面时都会消息。

例子屏幕电话:

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

屏幕呼叫有以下字段:

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

查找详情屏幕有效载荷在我们的规范

集团

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

这对于像这样的工具很有用对讲机提前totango.,因为它将用户绑定到集团其他的用户。

例子集团电话:

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

集团呼叫有以下字段:

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

有关的更多细节有关集团包括集团有效载荷在我们的规范

别名

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

Mixpanel年它用于在匿名用户注册后将其与身份确认的用户联系起来。为只有,如果您的用户切换了id,则可以使用“alias”重命名“userId”。

例子别名电话:

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

别名呼叫有以下字段:

类型 描述
上下文 选修的 对象 提供关于消息的有用上下文的额外信息字典,但与API调用不直接相关知识产权地址或地区看到上下文字段文档为更多的细节。
集成 选修的 对象 要启用或禁用的目的地的字典,请参见目的地领域文档为更多的细节。
previousId 要求 细绳 先前的用户唯一标识符参见以前的ID字段文档为更多的细节。
时间戳 选修的 日期 消息本身发生的时间戳,段跟踪API默认为当前时间,作为iso - 8601格式化日期字符串。如果事件刚刚发生,请将其留出,我们将使用服务器的时间。如果您正在从过去导入数据,请确保您提供一个时间戳花瓶的时间戳字段的文档更多的细节。
用户身份 可选,如果设置了anonymoussid 细绳 数据库中用户的唯一标识符。用户id或匿名id是必需的。看到身份文档为更多的细节。

有关更多细节别名呼叫和有效载荷,查看我们的规范

历史导入

您可以通过添加时间戳参数的任何方法调用。如果你刚转到细分市场,这可能会很有帮助。

历史进口只能达到可以接受历史时间戳数据的目的地。大多数分析工具,如MixPanel,幅度,吻等等,可以处理这种类型的数据。一个不接受历史数据的一个通用目的地是Google Analytics,因为他们的API无法接受历史数据。

笔记:如果你正在追踪正在发生的事情,就忽略时间戳我们的服务器将为您的请求进行时间戳。

批处理

批处理方法让您发送一系列确认集团跟踪页面屏幕单个批处理请求,保存出站请求。我们的服务器端和移动端来源自动使用此方法以实现更高的性能。

有一个最大值500 kb每批请求和32 kb每个电话。

这是什么批处理请求签名看起来像:

文章https://api.segment.io/v1/batch
{“批”[{“类型”“确定”“标识”“019 mr8mf4r”“特征”{“电子邮件”“jake@yahoo.com”“名称”“杰克彼得森”“年龄”26},“时间戳”“2012 - 12 - 02 - t00:30:08.276z”},{“类型”“跟踪”“标识”“019 mr8mf4r”“事件”“歌曲播放”“特性”{“名称”“爱上你”“艺术家”“Dierks Bentley”},“时间戳”“2012-12-02T00:30:12.984z”},{“类型”“确定”“标识”“971MJ8MK7P”“特征”{“电子邮件”“cindy@example.com”“名称”“辛迪·冈萨雷斯”“年龄”23},“时间戳”“2015-2-02T00:30:08.276z”},{“类型”“跟踪”“标识”“971MJ8MK7P”“事件”“歌曲播放”“特性”{“名称”“正确”“艺术家”“珍妮弗·洛佩兹”},“时间戳”“2015 - 2 - 02 - t00:30:12.984z”}),“语境”{“设备”{“类型”“电话”“名称”“苹果iPhone 6”}}}
类型 描述
批处理大批 一个数组的确认集团跟踪页面屏幕方法调用。每次打电话必须有一个类型属性,该属性具有有效的方法名称。
上下文对象,可选 一样的上下文对于其他调用,但它将与批处理中每个项目中的任何上下文合并。
集成对象,可选 一样的目的地对于其他调用,但它将与批处理中每个项目中的任何目的地合并。

选择目的地

别名集团确认页面跟踪呼叫都可以通过一个对象集成允许您打开或关闭某些目的地。默认情况下,所有目的地都是启用的。

这是一个显示的例子确认只调用Mixpanel和Kissmetrics:

文章https://api.segment.io/v1/identify
{“标识”“019 mr8mf4r”“特征”{“电子邮件”“pgibbons@example.com”“名称”“彼得吉布堡”“行业”“技术”},“语境”{“知识产权”“24.5.68.47”},“时间戳”“2012 - 12 - 02 - t00:30:08.276z”“集成”{“所有”“Mixpanel年”真正的“亲吻”真正的“谷歌分析”}}

在本例中,我们指定这个标识只指向Mixpanel和Kissmetrics。'全部':假表示除非另有指定,否则不应启用任何目的地。'mixpanel':真实打开Mixpanel等。

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

笔记:

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

  • 如果您采用祖父计划,则通过分段指示板过滤发送到服务器端的事件仍将计入您的API使用量。

收集IP地址

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

故障排除

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

我的调试器中没有事件

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

  2. 确保在库成功安装后,您正在调用我们的一个API方法确认跟踪, 等等。

我的终极工具里没有任何事件

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

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

  3. 看看目的地的文档查看是否有其他要求使用方法和目标,您试图获得工作。

最后更改:2021年2月1日



从分段开始

细分是将网站和移动应用数据整合到300多个分析和增长工具的最简单方法。
建立免费账户