目标
要跟踪聊天代理在提高销售或完成基于网站的目标方面的效果,可以设置与URL完全匹配或在URL中包含特定参数的基于URL的目标(例如定价页面的页面视图)。
目标可以设置为基于代理第一次接触或最后一次接触属性来捕获转换。归因周期为1 ~ 30天。
请注意:帐户最多可以有5个活动目标。如果您超出了活动的目标限制,将出现一个错误消息“目标限制超出”。
JSON格式
目标被表示为具有以下属性的JSON对象:
名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
attribution_model | 字符串 | 假 | 假 | 描述与目标相关的归因模型。first_touch和last_touch中的一个 |
attribution_period | 整数 | 假 | 假 | 描述此目标的归属周期(以天为单位)。范围为“1”至“30” |
描述 | 字符串 | 假 | 假 | 目标的描述 |
启用 | 整数 | 假 | 假 | 描述目标是否已启用 |
id | 整数 | 真正的 | 假 | 目标的ID |
名字 | 字符串 | 假 | 假 | 目标的名称 |
设置 | 对象 | 假 | 假 | 目标的设定。包含了条件 数组中。看到条件 |
条件
的设置
属性包含条件
数组中。的条件
数组包含表示要匹配的单个条件的对象。如果满足了任何一个条件,目标就被认为实现了。每个对象具有以下属性。
名字 | 类型 | 只读 | 描述 |
---|---|---|---|
类型 | 字符串 | 没有 | 描述条件的类型。目前只支持"url" |
操作符 | 字符串 | 没有 | 描述用于比较目标是否实现的运算符。"equals"和"contains"中的一个 |
价值 | 字符串 | 没有 | 描述目标实现后要比较的实际值。如果操作符 指定为"equals",价值 应以“http://”或“https://”开头 |
例子
{
“attribution_model”:“first_touch”,
“attribution_period”:30.,
“描述”:“一个目标样本”,
“启用”:1,
“id”:1,
“名称”:“目标1”,
“设置”:{
“条件”:[
{
“运营商”:“=”,
“类型”:“url”,
“价值”:“http://cart.com/”
},
{
“运营商”:“包含”,
“类型”:“url”,
“价值”:“购物车”
}
]
}
}
目标列表
GET / api / v2 /目标
这里列出了你账户的所有目标。
允许
- 管理员
代码示例
旋度
旋度https://www.zopim.com/api/v2/goals\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/goals”
方法: =“获得”
要求的事情,犯错: =http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
客户端: =&http.客户端{}
res,犯错: =客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错: =io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Java
进口com.squareup.okhttp.*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl.构建器urlBuilder=HttpUrl.解析(“https://support.亚博zendesk.com/api/v2/goals”)
.newBuilder();
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/goals”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/goals”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/goals”)
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
[
{
“attribution_model”:“first_touch”,
“attribution_period”:30.,
“描述”:“一个目标样本”,
“启用”:1,
“id”:1,
“名称”:“目标1”,
“设置”:{
“条件”:[
{
“运营商”:“=”,
“类型”:“url”,
“价值”:“http://cart.com/”
},
{
“运营商”:“包含”,
“类型”:“url”,
“价值”:“购物车”
}
]
}
},
{
“attribution_model”:“last_touch”,
“attribution_period”:15,
“描述”:“一个目标样本”,
“id”:2,
“名称”:“目标2”,
“设置”:{
“条件”:[
{
“运营商”:“=”,
“类型”:“url”,
“价值”:“http://zopim.com/”
},
{
“运营商”:“包含”,
“类型”:“url”,
“价值”:“zopim”
}
]
}
}
]
显示目标
GET / api / v2 /目标/ {goal_id}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
goal_id | 整数 | 路径 | 真正的 | 目标的ID |
代码示例
旋度
旋度https://www.zopim.com/api/v2/goals/{goal_id}\
- v - u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/goals/1”
方法: =“获得”
要求的事情,犯错: =http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
客户端: =&http.客户端{}
res,犯错: =客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错: =io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Java
进口com.squareup.okhttp.*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl.构建器urlBuilder=HttpUrl.解析(“https://support.亚博zendesk.com/api/v2/goals/1”)
.newBuilder();
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/goals/1”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/goals/1”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/goals/1”)
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“attribution_model”:“first_touch”,
“attribution_period”:30.,
“描述”:“一个目标样本”,
“启用”:1,
“id”:1,
“名称”:“目标1”,
“设置”:{
“条件”:[
{
“运营商”:“=”,
“类型”:“url”,
“价值”:“http://cart.com/”
},
{
“运营商”:“包含”,
“类型”:“url”,
“价值”:“购物车”
}
]
}
}
创建目标
POST / api / v2 /目标
允许
- 管理员
代码示例
旋度
旋度https://www.zopim.com/api/v2/goals\
- d”{
“名称”:“目标3”,
"description": "一个新的目标",
"enabled": 1,
"attribution_model": "first_touch",
“attribution_period”:15日
"settings": {
“条件”:[
{
“操作符”:“=”,
“类型”:“url”,
“价值”:“http://mysite.com/”
}
]
}
}'\
- v - u{email_address}:{密码}\
-x post -h“application / json内容类型:
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/goals”
方法: =“职位”
要求的事情,犯错: =http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
客户端: =&http.客户端{}
res,犯错: =客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错: =io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Java
进口com.squareup.okhttp.*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl.构建器urlBuilder=HttpUrl.解析(“https://support.亚博zendesk.com/api/v2/goals”)
.newBuilder();
RequestBody身体=RequestBody.创建(MediaType.解析(“application / json”),
"""
""");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“职位”,身体)
.addHeader(“内容类型”,“application / json”)
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/v2/goals”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/goals”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“职位”,
url,
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/goals”)
请求=网::HTTP::帖子.新(uri,“内容类型”:“application / json”)
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
201年创建
//状态201已创建
{
“attribution_model”:“first_touch”,
“attribution_period”:30.,
“描述”:“一个目标样本”,
“启用”:1,
“id”:1,
“名称”:“目标1”,
“设置”:{
“条件”:[
{
“运营商”:“=”,
“类型”:“url”,
“价值”:“http://cart.com/”
},
{
“运营商”:“包含”,
“类型”:“url”,
“价值”:“购物车”
}
]
}
}
更新的目标
把/ api / v2 /目标/ {goal_id}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
goal_id | 整数 | 路径 | 真正的 | 目标的ID |
代码示例
旋度
旋度https://www.zopim.com/api/v2/goals/3\
- d'{"name": "Good goal"}'\
- v - u{email_address}:{密码}
-x乘以-h“application / json内容类型:
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/goals/1”
方法: =“把”
要求的事情,犯错: =http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
客户端: =&http.客户端{}
res,犯错: =客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错: =io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Java
进口com.squareup.okhttp.*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl.构建器urlBuilder=HttpUrl.解析(“https://support.亚博zendesk.com/api/v2/goals/1”)
.newBuilder();
RequestBody身体=RequestBody.创建(MediaType.解析(“application / json”),
"""
""");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“把”,身体)
.addHeader(“内容类型”,“application / json”)
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“把”,
url:“https://support.亚博zendesk.com/api/v2/goals/1”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/goals/1”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“把”,
url,
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/goals/1”)
请求=网::HTTP::把.新(uri,“内容类型”:“application / json”)
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“attribution_model”:“first_touch”,
“attribution_period”:15,
“描述”:“新目标”,
“启用”:1,
“id”:3.,
“名称”:“好”的目标,
“设置”:{
“条件”:[
{
“运营商”:“=”,
“类型”:“url”,
“价值”:“http://mysite.com/”
}
]
}
}
删除目标
删除/ api / v2 /目标/ {goal_id}
允许
- 管理员
参数
名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
goal_id | 整数 | 路径 | 真正的 | 目标的ID |
代码示例
旋度
旋度https://www.zopim.com/api/v2/goals/3\
- v - u{email_address}:{密码}- x删除
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/goals/1”
方法: =“删除”
要求的事情,犯错: =http.NewRequest(方法,url,零)
如果犯错! =零{
fmt.Println(犯错)
返回
}
要求的事情.头.添加(“内容类型”,“application / json”)
客户端: =&http.客户端{}
res,犯错: =客户端.做(要求的事情)
如果犯错! =零{
fmt.Println(犯错)
返回
}
推迟res.身体.关闭()
身体,犯错: =io.ReadAll(res.身体)
如果犯错! =零{
fmt.Println(犯错)
返回
}
fmt.Println(字符串(身体))
}
Java
进口com.squareup.okhttp.*;
OkHttpClient客户端=新OkHttpClient();
HttpUrl.构建器urlBuilder=HttpUrl.解析(“https://support.亚博zendesk.com/api/v2/goals/1”)
.newBuilder();
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“删除”,零)
.addHeader(“内容类型”,“application / json”)
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“删除”,
url:“https://support.亚博zendesk.com/api/v2/goals/1”,
头:{
“内容类型”:“application / json”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/goals/1”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“删除”,
url,
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/goals/1”)
请求=网::HTTP::删除.新(uri,“内容类型”:“application / json”)
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
204无内容
//状态204无内容
零