HTTP跟踪API源


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

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

标题

验证

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

在实践中,这意味着获取一个段源写关键,“abc123”,作为用户名,添加冒号,然后留空密码字段。Base64编码后“abc123:”成为“YWJjMTIzOg = =”;这是在授权标题中传递的:'授权:基本YWJJMTizog =='

内容类型

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

错误

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

我们在工作中努力了解更多错误,更有助于对用户的帮助。如果您有任何建议,让我们知道!

速度限制

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

马克斯请求大小

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

识别

识别允许您将用户绑定到他们的行为和记录它们的特征。它包括一个唯一的用户ID和您对其了解的任何可选性状。

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

例子识别称呼:

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

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

场地 类型 描述
anonymousId 可选,如果userid被设置为 字符串 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。需要用户ID或AnonymousID。
看看身份文档更多细节。
语境 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关IP.地址或语言环境看看环境领域的文档更多细节。
一体化 可选 目的 目的地字典到启用或禁用查看目的地字段文档更多细节。
时间戳 可选 日期 时间戳当消息本身发生时,段落跟踪API的当前时间默认为aiso - 8601日期格式的字符串。如果事件刚刚发生,忽略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了一个时间戳.see时间戳字段的文档更多的细节。
特征 可选 目的 自由形式的用户特质词典,喜欢电子邮件或者名称。看看特质字段文档保留特征名的列表。
用户标识 可选,如果设置了匿名ID 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档更多细节。

请参阅识别方法有效载荷在我们的规格

跟踪

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

您需要跟踪对您网站成功指标的事件,如签约,商品购买或者书签条

首先,我们建议跟踪一些重要的事件。您可以在以后添加更多!

例子跟踪称呼:

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

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

跟踪call有以下字段:

场地 类型 描述
anonymousId 可选,如果userid被设置为 字符串 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。需要用户ID或AnonymousID。
看看身份文档更多细节。
语境 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关IP.地址或语言环境看看环境领域的文档更多细节。
事件 必需的 字符串 用户执行的操作的名称。看看事件字段文档更多细节。
一体化 可选 目的 目的地字典到启用或禁用查看目的地字段文档更多细节。
属性 可选 目的 自由形式的事件属性词典,喜欢收入看看属性文档有关保留的属性名称列表。
时间戳 可选 日期 时间戳当消息本身发生时,段落跟踪API的当前时间默认为aiso - 8601日期格式的字符串。如果事件刚刚发生,忽略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了一个时间戳.see时间戳字段的文档更多的细节。
用户标识 可选,如果设置了匿名ID 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档更多细节。

查找详情活动命名的最佳实践以及跟踪方法有效载荷在我们的规格

页面

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

例子称呼:

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

call有以下字段:

场地 类型 描述
anonymousId 可选,如果userid被设置为 字符串 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。需要用户ID或AnonymousID。
看看身份文档更多细节。
语境 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关IP.地址或语言环境看看环境领域的文档更多细节。
一体化 可选 目的 目的地字典到启用或禁用查看目的地字段文档更多细节。
名称 可选 字符串 例如,大多数网站都有一个“注册”页面,可以用来标记,这样你就可以在用户通过你的漏斗时看到他们。
属性 可选 目的 免费表单的属性词典,就像URL.介绍人看看属性字段文档有关保留的属性名称列表。
时间戳 可选 日期 时间戳当消息本身发生时,段落跟踪API的当前时间默认为aiso - 8601日期格式的字符串。如果事件刚刚发生,忽略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了一个时间戳.see时间戳字段的文档更多的细节。
用户标识 可选,如果设置了匿名ID 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档更多细节。

请参阅有效载荷在我们的规格

屏幕

屏幕方法允许用户在任何时候看到您的移动应用程序的屏幕时进行记录。

你会想要发送屏幕当用户请求你的应用程序的一个页面时。

例子屏幕称呼:

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

屏幕call有以下字段:

_
场地 类型 描述
anonymousId 可选,如果userid被设置为 字符串 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。需要用户ID或AnonymousID。
看看身份文档更多细节。
语境 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关IP.地址或语言环境看看环境领域的文档更多细节。
一体化 可选 目的 目的地字典到启用或禁用查看目的地字段文档更多细节。
名称 可选 字符串 屏幕名称见名称字段的文档更多细节。
属性 可选 目的 自由形式屏幕属性词典,喜欢名称看看属性字段文档有关保留的属性名称列表。
时间戳 可选 日期 时间戳当消息本身发生时,段落跟踪API的当前时间默认为aiso - 8601日期格式的字符串。如果事件刚刚发生,忽略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了一个时间戳.see时间戳字段的文档更多的细节。
用户标识 可选,如果设置了匿名ID 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档更多细节。

请参阅屏幕有效载荷在我们的规格

团体

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

这对工具有用对讲机,罚款Totango,因为它将用户绑定到团体其他用户。

例子团体称呼:

发布https://api.segent.io/v1/group.io/v1/group.
{“用户身份”:“019 mr8mf4r”,“groupId”:“8 e9df332ac”,“特征”:{“名称”:“Initech”,“行业”:“技术”,“员工”:420},“时间戳”:“2012-12-02T00:31:38.208z”}

团体call有以下字段:

场地 类型 描述
anonymousId 可选,如果userid被设置为 字符串 用户ID的伪唯一替代品,用于没有绝对唯一标识符的情况。需要用户ID或AnonymousID。
看看身份文档更多细节。
语境 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关IP.地址或语言环境看看环境领域的文档更多细节。
Groupid. 必需的 字符串 数据库中组的唯一标识符。看看组ID字段文档更多的细节。
一体化 可选 目的 目的地字典到启用或禁用查看目的地字段文档更多细节。
时间戳 可选 日期 时间戳当消息本身发生时,段落跟踪API的当前时间默认为aiso - 8601日期格式的字符串。如果事件刚刚发生,忽略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了一个时间戳.see时间戳字段的文档更多的细节。
特征 可选 目的 自由形式的小组特征词典,喜欢电子邮件或者名称看看特质字段文档保留特征名的列表。
用户标识 可选,如果设置了匿名ID 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档更多细节。

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

别名

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

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

例子别名称呼:

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

别名call有以下字段:

场地 类型 描述
语境 可选 目的 提供有关消息的有用上下文的额外信息词典,但与API调用无直接相关IP.地址或语言环境看看环境领域的文档更多细节。
一体化 可选 目的 目的地字典到启用或禁用查看目的地字段文档更多细节。
上一个 必需的 字符串 以前的用户唯一标识符查看以前的ID字段文档更多细节。
时间戳 可选 日期 时间戳当消息本身发生时,段落跟踪API的当前时间默认为aiso - 8601日期格式的字符串。如果事件刚刚发生,忽略它,我们将使用服务器的时间。如果您从过去导入数据,请确保您提供了一个时间戳.see时间戳字段的文档更多的细节。
用户标识 可选,如果设置了匿名ID 字符串 数据库中用户的唯一标识符。需要用户ID或AnonymousID。看看身份文档更多细节。

查询更多有关别名呼叫和有效载荷,看看我们的规格

历史导入

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

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

注意:如果你正在追踪正在发生的事情,就忽略时间戳我们的服务器会为您记录请求的时间。

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

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

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

文章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 - 02 - t00:30:12.984z”},{“类型”:“确定”,“用户身份”:“971 mj8mk7p”,“特征”:{“电子邮件”:“cindy@example.com”,“名称”:“辛迪·冈萨雷斯”,“年龄”: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.
{“用户身份”:“019 mr8mf4r”,“特征”:{“电子邮件”:“pgibbons@example.com”,“名称”:“彼得·吉本斯”,“行业”:“技术”},“背景”:{“IP”:“24.5.68.47”},“时间戳”:“2012 - 12 - 02 - t00:30:08.276z”,“集成”:{“全部”:错误的,“mixpanel”:真的,“只有”:真的,“谷歌分析”:错误的}}

在本例中,我们指定这个标识只指向Mixpanel和Kissmetrics。“所有”:假的说除非另有说明,否则应启用任何目的地。“Mixpanel年”:真的打开MixPanel等。

目的地标志是区分大小写的和匹配docs中的目的地名称(即“Adlearn开放平台”,“AWE.SM”,“MailChimp”等)。

注意:

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

  • 如果您在祖父的计划上,则通过段仪表板过滤的服务器端发送的事件仍然会指望您的API使用情况。

收集IP地址

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

故障排除

如果您有问题,我们有几个技巧有助于常见问题。

我的调试器中没有事件

  1. 仔细检查您已正确设置了库。

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

我的最终工具中没有事件

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

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

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

此页面上次修改:2021年2月1日



从分段开始

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