数据集的API参考
Geckoboard的数据集API是一种强大而灵活的方式来编译数据内部系统,第三方工具,数据库在你的仪表板上。
要做到这一点,你需要:
- 编写一个连接到数据源并请求所需数据的脚本。
- 创建一个数据集并将其推到Geckoboard,其中包含您想要显示的所有指标。
身份验证
找到您的API密钥
登录您的Geckoboard帐户,并遵循以下步骤:
- 单击右上角的首字母并选择账户.
- 在帐户详细信息屏幕,向下滚动并寻找API密钥在这一页的底部。
安装客户端库
为你的Node.js应用创建一个新目录。
光盘
到你的应用程序目录并运行:
npm安装geckoboard
首先,将这一行添加到应用程序的Gemfile中:
宝石“壁虎红宝石”
然后执行:
$包
或者自己安装:
$宝石安装geckoboard-ruby
需要gem并创建客户端实例:
要求“geckoboard”客户=Geckoboard.客户(api_key)
从PIP安装python客户端:
皮普安装geckoboard.py
导入Geckoboard包并使用你的API密钥创建一个客户端实例:
进口geckoboard客户=geckoboard.客户(API_KEY)
您可以使用通常用于发出HTTP请求的任何方法调用dataset API,但是Geckoboard提供的客户端库使与API的交互更加简单。
使用右上方的选项卡切换示例的编程语言。默认情况下,数据集API文档演示了如何通过HTTP与API交互。
如果您使用的是基于Unix的操作系统(Mac、Linux),那么您的计算机上可能安装了cURL(使用curl - v
命令在您的终端确认)。Windows用户可以通过在Cortana中搜索“命令”来访问命令提示符。
我们将使用Geckoboard Node.js库制作一个简单的Node.js应用程序。node . js版本4 +是必需的。
进行第一次API调用
curl https://api.geckoboard.com/ - u”your-api-key:“
你会收到
200
响应包含{}
平进行身份验证:
varAPI_KEY=“YOUR_API_KEY”;var国标=要求(“geckoboard”)(API_KEY);常量回调=(犯错)=>{如果(!犯错){控制台.日志(“成功”)返回;}控制台.日志(犯错);};国标.平(回调);
验证API密钥是否有效,是否可以使用#平
方法:
客户.平
例子:
Geckoboard.客户(“good-api-key”).平# = > trueGeckoboard.客户(“bad-api-key”).平# =>引发Geckoboard::UnauthorizedError异常
客户.平()
例子:
客户(“good-api-key”).平()# = > true客户(“bad-api-key”).平()# = >提出了
在使用数据集API时,通过在请求中包含您的个人API密钥来验证和测试您的帐户。
如果你漏掉了冒号:
或者仍然要求输入密码,点击输入在你的终端。
验证API密钥是否有效,是否可以使用平
方法。
如果你看到错误undefined method ' client' for Geckoboard:
,你可能有多个壁虎板gemfile。如果需要清除,可以使用命令“gem卸载壁虎”
,然后用“宝石列表”
确认并重新运行ping test命令。
验证API密钥是否有效,是否可以使用平
方法。
属性 | 类型 | 需要吗? | |||
---|---|---|---|---|---|
回调 |
函数 | 是的 |
计划你的模式
当您将数据集小部件添加到仪表板时,我们将查看您的模式,并为您发送给我们的数据类型提供有意义的可视化选项。例如,要绘制折线图,数据集必须包含日期
或datetime
类型。
可视化由单个数据集提供动力,这意味着您不能将两个或多个数据集的数据组合起来构建可视化
Geckoboard可以处理数据聚合和分组,因此不需要预聚合数据。当通过API接收到更新时,由该数据集驱动的所有小部件都会自动更新。
数据集API目前支持以下类型:
日期格式
创建示例:
“字段”:{“日期”:{“类型”:“日期”,“姓名”:“日期”“可选的”:假的}}
“字段”:{“日期”:{“类型”:“日期”,“姓名”:“日期”“可选的”:假的}}
“字段”:{“日期”:{“类型”:“日期”,“姓名”:“日期”“可选的”:假的}}
“字段”:{“日期”:{“类型”:“日期”,“姓名”:“日期”“可选的”:假的}}
添加数据的示例:
“数据”:【{“日期”:“2018-01-01”}]
“数据”:【{“日期”:“2018-01-01”}]
“数据”:【{“日期”:“2018-01-01”}]
“数据”:【{“日期”:“2018-01-01”}]
所有日期类型的格式必须为YYYY-MM-DD
(例如。2018-01-01
).
对于小时,分和秒,使用Datetime格式。
A.日期
字段可以零
如果设置为可选择的
.
元素 | 描述 | 笔记 |
---|---|---|
YYYY |
四位数的年 | |
毫米 |
两位数的月 | 用领先的0 对于1 - 9 |
DD |
一个月里两位数的日子 | 01 通过31 |
Datetime格式
创建示例:
“字段”:{“datetime”:{“类型”:“datetime”,“姓名”:“Datetime”“可选的”:假的}}
“字段”:{“datetime”:{“类型”:“datetime”,“姓名”:“Datetime”“可选的”:假的}}
“字段”:{“datetime”:{“类型”:“datetime”,“姓名”:“Datetime”“可选的”:假的}}
“字段”:{“datetime”:{“类型”:“datetime”,“姓名”:“Datetime”“可选的”:假的}}
添加数据的示例:
“数据”:【{“datetime”:“2018 - 01 - 01 t12:00:30z”}]
“数据”:【{“datetime”:“2018 - 01 - 01 t12:00:30z”}]
“数据”:【{“datetime”:“2018 - 01 - 01 t12:00:30z”}]
“数据”:【{“datetime”:“2018 - 01 - 01 t12:00:30z”}]
datetime
字段的格式必须为ISO 8601字符串,表示日期和时间的国际标准。
我们建议您使用YYYY-MM-DDThh: mm: ssTZD
变量,它将生成如下所示的值2018 - 01 - 01 - t12:00:30z
(2018年1月1日下午12:00:30),UTC).
A.datetime
字段可以零
如果设置为可选择的
.
元素 | 描述 | 笔记 |
---|---|---|
YYYY |
四位数的年 | |
毫米 |
两位数的月 | 用领先的0 对于1 - 9 |
DD |
一个月里两位数的日子 | 01 通过31 |
嗯 |
两位数的小时 | 00 通过23 .24小时时钟只有. |
毫米 |
两位数的分钟 | 00 通过59 |
党卫军 |
两位数秒 | 00 通过59 |
TZD |
时区指示器 | 使用Z 对于UTC或+ hh: mm 或-嗯 A.时区偏移的+ hh: mm 或-嗯 表示日期/时间使用的是本地时区嗯 个小时,毫米 比UTC早或晚几分钟。 |
时间格式
“my_duration_field”:{“姓名”:“我的时间字段”,“类型”:“持续时间”,“time_unit”:“分钟”,“可选的”:假的}
“my_duration_field”:{“姓名”:“我的时间字段”,“类型”:“持续时间”,“time_unit”:“分钟”“可选的”:假的}
“my_duration_field”:{“姓名”:“我的时间字段”,“类型”:“持续时间”,“time_unit”:“分钟”“可选的”:假的}
“my_duration_field”:{“姓名”:“我的时间字段”,“类型”:“持续时间”,“time_unit”:“分钟”“可选的”:假的}
添加数据的示例:
“数据”:【{“my_duration_field”: 83}]
“数据”:【{“my_duration_field”:83}]
“数据”:【{“my_duration_field”:83}]
“数据”:【{“my_duration_field”:83}]
期间
字段可以设置为毫秒
,秒
,分钟
或小时
.
可以使用十进制或整数值。例如,如果您的字段设置为分钟
和你发送1.5
,将显示为1m 30秒
应用程序内。
A.期间
字段可以零
如果设置为可选择的
.
货币格式
创建示例:
“字段”:{“美元”:{“类型”:“钱”,“姓名”:“美元”,“货币代码”:“美元”,“可选的”:假的}}
“字段”:{“美元”:{“类型”:“钱”,“姓名”:“美元”,“货币代码”:“美元”,“可选的”:假的}}
“字段”:{“美元”:{“类型”:“钱”,“姓名”:“美元”,“货币代码”:“美元”,“可选的”:假的}}
“字段”:{“美元”:{“类型”:“钱”,“姓名”:“美元”,“货币代码”:“美元”,“可选的”:假的}}
添加数据的示例:
“数据”:【{“美元”: 14000}]
“数据”:【{“美元”:14000}]
“数据”:【{“美元”:14000}]
“数据”:【{“美元”:14000}]
钱
字段表示单一货币中的一定数量的货币。属性定义字段时,可以指定货币currency_code
选择。属性定义的三个字符货币代码ISO 4217标准。货币代码应该总是大写的。
记录应该以货币的最小面额指定货币的数量,作为一个整数。例如,美元的最小面值是美分,因此USD字段将指定$10.00为1000
.
A.钱
字段可以零
如果设置为可选择的
.
货币 | ISO 4217代码 | 象征 |
---|---|---|
澳元 | 澳元 | A$ |
英国英镑 | 英镑 | £ |
加元 | 计算机辅助设计 | C$ |
人民币 | 元 | 元 |
欧元 | 欧元 | € |
日元 | 日元 | ¥ |
墨西哥比索 | MXN | $ |
瑞典克朗 | 瑞典克朗 | 基米-雷克南 |
瑞士法郎 | 瑞士法郎 | Fr |
美元 | 美元 | $ |
如果你目前没有列出,检查ISO 4217官方货币名称的有效代码的完整列表.
数字格式
创建示例:
“字段”:{“数量”:{“类型”:“数量”,“姓名”:“数量”,“可选的”:假的}}
“字段”:{“数量”:{“类型”:“数量”,“姓名”:“数量”,“可选的”:假的}}
“字段”:{“数量”:{“类型”:“数量”,“姓名”:“数量”,“可选的”:假的}}
“字段”:{“数量”:{“类型”:“数量”,“姓名”:“数量”,“可选的”:假的}}
添加数据的示例:
“数据”:【{“数量”: 42}]
“数据”:【{“数量”:42}]
“数据”:【{“数量”:42}]
“数据”:【{“数量”:42}]
数
字段可以是零
如果设置为可选择的
.
常规的十进制值(例如。10.24
)可用于数字字段。
对于某些类型的十进制值(如软件版本)5.1234
),以及其他字符,如破折号-
和括号()
(用于电话号码)(555) 555 - 1234
),您可能需要使用字符串格式改为格式化。
百分比格式
创建示例:
“字段”:{“比例”:{“类型”:“比例”,“姓名”:“比例”,“可选的”:假的}}
“字段”:{“比例”:{“类型”:“比例”,“姓名”:“比例”,“可选的”:假的}}
“字段”:{“比例”:{“类型”:“比例”,“姓名”:“比例”,“可选的”:假的}}
“字段”:{“比例”:{“类型”:“比例”,“姓名”:“比例”,“可选的”:假的}}
添加数据的示例:
“数据”:【{“比例”: 0.35}]
“数据”:【{“比例”:0.35}]
“数据”:【{“比例”:0.35}]
“数据”:【{“比例”:0.35}]
在使用百分比字段时,在0
来1.
范围将显示在0
来100%
的范围内。
例如,带值的百分比字段0.35
将被Geckoboard解释为百分比35%
.
值高于1.
将对应于高于100%
例如1.5
将被解释为150%
.
A.百分比
字段可以零
如果设置为可选择的
.
字符串格式
创建示例:
“字段”:{“字符串”:{“类型”:“字符串”,“姓名”:“字符串”“可选的”:假的}}
“字段”:{“字符串”:{“类型”:“字符串”,“姓名”:“字符串”“可选的”:假的}}
“字段”:{“字符串”:{“类型”:“字符串”,“姓名”:“字符串”“可选的”:假的}}
“字段”:{“字符串”:{“类型”:“字符串”,“姓名”:“字符串”“可选的”:假的}}
添加数据的示例:
“数据”:【{“字符串”:"这是一个字符串字段"}]
“数据”:【{“字符串”:"这是一个字符串字段"}]
“数据”:【{“字符串”:"这是一个字符串字段"}]
“数据”:【{“字符串”:"这是一个字符串字段"}]
所有字符串
字段的长度不能超过256个字符。
A.字符串
字段可以零
如果设置为可选择的
.
API请求
查找或创建一个新的数据集
https://api.geckoboard.com/datasets/: id
例子:
curl https://api.geckoboard.com/datasets/sales.by_day\- x将\- u'222efc82e7933138077b1c2554439e15:'\- h“application / json内容类型:\- d“{”字段”:{“金额”:{“类型”:“数量”,“名字”:“数量”,“可选”:假},“时间戳”:{“类型”:“datetime”,“名字”:“日期”}},“unique_by”:[“时间戳”]}”
回应:
{“id”:“sales.by_day”,“字段”:{“数量”:{“类型”:“数量”,“姓名”:“数量”,“可选的”:假的},“时间戳”:{“类型”:“datetime”,“姓名”:“日期”}},“unique_by”:[“时间戳”]}
gb.dataset.findOrCreate(选项,回调)
例子:
{“id”:“sales.by_day”,“字段”:{“数量”:{“类型”:“数量”,“姓名”:“数量”,“可选的”:假的},“时间戳”:{“类型”:“datetime”,“姓名”:“时间”}},“unique_by”:[“时间戳”]}
客户.数据集.find_or_create(id,领域:字段)
例子:
数据集=客户.数据集.find_or_create(“sales.by_day”,领域:[Geckoboard::MoneyField.新(数量:,名称:“数量”,currency_code:“美元”,可选:假的),Geckoboard::DateTimeField.新(:时间戳,名称:“时间”),],由以下人员提供的唯一信息:[:时间戳])
客户.数据集.find_or_create(dataset_id,字段,独特的)
例子:
数据集=客户.数据集.find_or_create(“夜间销售”,{“数量”:{“类型”:“数量”,“名字”:“数量”,“可选的”:假的},“时间戳”:{“类型”:“datetime”,“名字”:“时间”}},[“时间戳”])
把
是用于从dataset API检索资源的HTTP方法。
哪里: id
是一个字符串,用于帮助您在Geckoboard中标识数据集。
属性查找并验证现有数据集或创建新数据集findOrCreate
方法。
属性查找并验证现有数据集或创建新数据集find_or_create
方法。
属性查找并验证现有数据集或创建新数据集find_or_create
方法。
请求参数
属性 | 类型 | 需要吗? | 描述 |
---|---|---|---|
字段 |
对象 | 是的 | 数据集中每个列都有键的对象。该值描述该列的类型。 |
独特的 |
数组 | 没有 | 一个或多个字段名的数组,其值在所有记录中都是唯一的。 |
属性 | 类型 | 要求 | 描述 | |||
---|---|---|---|---|---|---|
⌄ | 选项 |
对象 | 是的 | |||
id |
一串 | 是的 | ||||
⌄ | 字段 |
对象 | 是的 | 数据集中每个列都有键的对象。该值描述该列的类型。 | ||
类型 |
一串 | 是的 | ||||
的名字 |
一串 | 是的 | ||||
可选择的 |
布尔 | 没有 | ||||
独特的 |
数组 | 没有 | 一个或多个字段名的数组,其值在所有记录中都是唯一的。 | |||
⌄ | 回调 |
函数 | 没有 | |||
错误 |
错误|零 | 是的 | ||||
数据集 |
未定义 | 是的 |
可用字段类型:
DateField
DateTimeField
NumberField
PercentageField
斯特林菲尔德
MoneyField
属性 | 类型 | 要求 | 描述 | |||
---|---|---|---|---|---|---|
datasets_id |
str | 是的 | ||||
⌄ | 字段 |
dict | 是的 | 数据集中每个列都有键的对象。该值描述该列的类型。 | ||
类型 |
str | 是的 | ||||
的名字 |
str | 是的 | ||||
可选择的 |
布尔 | 是的 | ||||
独特的 |
数组 | 没有 | 一个或多个字段名的数组,其值在所有记录中都是唯一的。 |
将数据附加到数据集
文章https://api.geckoboard.com/datasets/ id /数据
例子:
curl https://api.geckoboard.com/datasets/sales.by_day/data\- x的帖子\- u'222efc82e7933138077b1c2554439e15:'\- h“application / json内容类型:\- d{“数据”:[{“时间戳”:“2018 - 01 - 01 t12:00:00z”,“数量”:819},{“时间戳”:“2018 - 01 - 02 t12:00:00z”,“数量”:409},{“时间戳”:“2018 - 01 - 03 t12:00:00z”,“数量”:164}]}”
回应:
{}
数据集.邮递(项目,选项,回调);
例子:
[{时间戳:“2018 - 01 - 01 t12:00:00z”,量:8192},{时间戳:“2018-01-02T12:00:00Z”,量:4096},{时间戳:“2018 - 01 - 03 t12:00:00z”,量:16384}];
{delete_by:“时间戳”;}
数据集.邮递(项目,delete_by:optional_name_of_a_date_or_datetime_field)
例子:
数据集.邮递([{时间戳:日期时间.新(2018,1.,2.,12,0,0),数额:40900},{时间戳:日期时间.新(2018,1.,3.,12,0,0),数额:16400}],delete_by:时间戳)
数据集.邮递(项目,delete_by)
例子:
数据集.邮递([{“时间戳”:2018 - 01 - 03 t12:00:00z,“数量”:312},{“时间戳”:“2018-01-04T12:00:00Z”,“数量”:665},{“时间戳”:“2018-01-05T12:00:00Z”,“数量”:453}],“时间戳”)
Append将向其中添加新记录或修改数据集中已经存在的记录。它调用邮递
方法。
如果你没有包含独特的
然后,所有新记录将被附加到数据集的现有内容中。
如果你包含了独特的
数组的字段,那么新记录和现有记录之间的任何冲突都将通过将更新合并到数据集的内容中来解决。这可以用来修改现有的记录如果它们的值自上次更新后发生了更改,或者您希望修复不正确的记录。
如果数据集中的记录数在追加后超过5000条记录的限制,旧记录将被丢弃。
属性 | 描述 |
---|---|
数据 |
一个具有键+值的对象数组,表示数据集中的记录。 |
delete_by |
一个可选字符串,用于指定日期 或datetime 现场使用为了截断而订购记录. |
属性 | 类型 | 需要吗? | |||
---|---|---|---|---|---|
项目 |
数组 | 是的 | |||
⌄ | 选项 |
对象|零 | 没有 | ||
delete_by |
一串 | 没有 | |||
⌄ | 回调 |
函数 | 没有 | ||
错误 |
错误|零 | 没有 |
属性 | 类型 | 需要吗? | |||
---|---|---|---|---|---|
项目 |
列表 | 是的 | |||
delete_by |
str | 没有 |
替换数据集中的所有数据
https://api.geckoboard.com/datasets/: id /数据
例子:
curl https://api.geckoboard.com/datasets/sales.by_day/data\- x将\- u'222efc82e7933138077b1c2554439e15:'\- h“application / json内容类型:\- d{“数据”:[{“时间戳”:“2018 - 01 - 01 t12:00:00z”,“数量”:819},{“时间戳”:“2018 - 01 - 02 t12:00:00z”,“数量”:409},{“时间戳”:“2018 - 01 - 03 t12:00:00z”,“数量”:164}]}”
回应:
{}
数据集.把(项目,回调);
例子:
[{时间戳:“2018 - 01 - 01 t12:00:00z”,量:8192},{时间戳:“2018-01-02T12:00:00Z”,量:4096},{时间戳:“2018 - 01 - 03 t12:00:00z”,量:16384}],{}
数据集.把(项目)
例子:
数据集.把([{时间戳:日期时间.新(2018,1.,2.,12,0,0),数额:40900},{时间戳:日期时间.新(2018,1.,3.,12,0,0),数额:16400}])
数据集.把(项目)
例子:
数据集.把([{“时间戳”:2018 - 01 - 01 t12:00:00z,“数量”:819},{“时间戳”:“2018-01-02T12:00:00Z”,“数量”:409},{“时间戳”:2018 - 01 - 03 t12:00:00z,“数量”:164}])
Replace将删除数据集中的所有现有数据,然后写入新数据。实际上,您的数据集将只包含刚刚推送的新记录(您可以将其视为类似于覆盖操作)。它调用把
方法。
如果你看到错误未初始化常量DateTime
添加需要“日期”
在文件的开头,如果您使用的是交互式Ruby (IRB),则在命令之前。
属性 | 描述 |
---|---|
数据 |
一个具有键+值的对象数组,表示数据集中的记录。 |
属性 | 类型 | 需要吗? | |||
---|---|---|---|---|---|
项目 |
数组 | 是的 | |||
⌄ | 回调 |
函数 | 没有 | ||
错误 |
错误|零 | 没有 |
属性 | 类型 | 需要吗? | |||
---|---|---|---|---|---|
项目 |
列表 | 是的 |
附加vs取代
您的特定设置和用例将在很大程度上决定您使用哪种方法,但使用append(与独特的
和delete_by
)是几乎总是更可取的因为它更快,提供更好的性能,并允许您发送更多的数据到Geckoboard。
考虑何时添加:
- 您现在总是从数据源获取数据,并希望在数据集中建立历史记录。
- 您计划每几分钟推送一次以上的数据——即使您正在更新的数据集只包含一条记录。
- 如果您想将超过500条记录推到您的数据集。为此,您需要发送多个追加。
时考虑替换:
- 您对维护历史数据或显示比较不感兴趣。
- 您可以提取感兴趣的整个时间段的完整数据。
清除数据集中的所有数据
curl https://api.geckoboard.com/datasets/sales.by_day/data\- x将\- u'222efc82e7933138077b1c2554439e15:'\- h“application / json内容类型:\- d'{"data": []}'
回应:
{}
数据集.把([]);
数据集.把([])# = > true
数据集.把([])
回应:
真正的
清除数据集中的所有现有数据空数组通过把
方法(即Replace)并留下一个空数据集。数据集本身及其模式将被保留。
这个例子提供了空数组语法。
删除一个数据集
删除https://api.geckoboard.com/datasets/ id
例子:
curl - x删除\- u'222efc82e7933138077b1c2554439e15:'\https://api.geckoboard.com/datasets/sales.by_day
回应:
{}
数据集.删除(回调);
客户.数据集.删除(id)
例子:
客户.数据集.删除(“sales.by_day”)# = > true
的方法也可以删除数据集
#删除
方法的实例上Geckoboard:数据集
.
数据集=客户.数据集.find_or_create(...)数据集.删除# = > true
客户.数据集.删除(dataset_id)
例子:
客户.数据集.删除(“sales.by_day”)# = > true
的方法也可以删除数据集
删除
方法在数据集上执行。
删除给定的数据集和所有数据id
.
删除数据集和其中的所有数据。
删除给定的数据集和所有数据id
.
删除给定的数据集和所有数据id
.
数据集=客户.数据集.find_or_create(...)数据集.删除()# = > true
属性 | 类型 | 需要吗? | |||
---|---|---|---|---|---|
⌄ | 回调 |
函数 | 没有 | ||
错误 |
错误|零 | 没有 |
指定多个字段名
例子:
varAPI_KEY=“your_api_key”;var国标=要求(“geckoboard”)(API_KEY);国标.数据集.findOrCreate({id:“sales.by_day”,字段:{数量:{类型:“数量”,的名字:销售的数量},总值:{类型:“钱”,的名字:“销售总值”,currency_code:“美元”},日期:{类型:“日期”,的名字:“日期”},的名字:{类型:“字符串”,的名字:“姓名”}},“unique_by”:[“日期”,“姓名”]},函数(犯错,数据集){如果(犯错){控制台.错误(犯错);返回;}数据集.把([{日期:'2016-01-01',数量:819,总值:2457000,的名字:“一”},{日期:'2016-01-02',数量:409,总值:1227000,的名字:“两个”},{日期:'2016-01-02',数量:415,总值:1229523,的名字:“两个”},{日期:'2016-01-03',数量:164,总值:492000,的名字:“三”}],函数(犯错){如果(犯错){控制台.错误(犯错);返回;}控制台.日志(“创建数据集和添加数据”);});});
当被选中时,数据集只包含3行,尽管发送了4行。这是因为在这些条件下,一个人被认为是复制品。只有后者保留了下来。
的一部分可以指定多个字段名独特的
只要他们是字符串
,日期
或datetime
字段和具有唯一标识符。
限制和配额
API速率限制
"error": {"message": "您已经超过API速率限制每分钟60个请求。尝试减少发送数据的频率"}}
API上有基本的速率限制。这将限制您每分钟60次请求为您的API密钥。
如果超出限制,API将返回请求太多了
状态和错误消息。
记录每个数据集
每个数据集最多可以包含5000张唱片.
当数据集超过记录计数限制时,最早的记录(按插入时间)将被删除。可以使用delete_by
附加新记录时的选项。
当设置为日期
或datetime
场,delete_by
选项将用于在记录从数据集截断之前对记录进行排序(从最新到最老)。
如果你指定日期
字段delete_by
那么数据集API就会尽量避免只留下一天的部分数据。当它删除一条记录时,它也将删除该字段具有相同日期值的任何记录。
如果delete_by
字段是一个datetime
字段则只删除具有相同时间戳(即相同的年、月、日、时、分、秒和毫秒)的记录。
记录每个请求
每一个把
或邮递
请求将接受500张唱片,其中包括新记录和对现有记录的更新。
每个帐户的数据集
每个Geckoboard帐户限制为200个数据集.当数据集数量达到时,不能再添加数据集。控件可以删除数据集API.
更新频率
由数据集驱动的小部件在实时当接收到新数据时。
对向数据集发送更新的频率没有限制,只要它在速率限制内,但仪表板上的可视化显示最多每10秒显示一次更改。我们建议更新数据集的频率不要超过此频率。
可视化要求
您的模式决定了可以在Geckoboard仪表板上使用数据集构建的可视化效果。
如果要构建特定的可视化,请确保在模式中包含这些类型的数据。
数字可视化
数字可视化的重点是显示可由单个数字表示的指标,以及可选的关联辅助指标,如变化或趋势指示。
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
数 | ![]() |
期间 或钱 或数 或百分比 |
数字与亮色比较 | ![]() |
钱 或数 或百分比 |
具有特定基于时间的火花线比较的数字 | ![]() |
钱 或数 或百分比 和日期 或datetime |
百分数比较 | ![]() |
钱 或数 或百分比 |
数与数比较 | ![]() |
钱 或数 或百分比 |
数字与目标比较 | ![]() |
钱 或数 或百分比 |
计可视化
仪表是表示随时间波动的单个数据点的一种很好的方式,就像汽车中的速度表一样。通过与定义的最小值和最大值进行比较,仪表最有助于快速查看度量值。
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
测量 | ![]() |
期间 或钱 或数 或百分比 |
用针测量特定的时间值 | ![]() |
期间 或钱 或数 或百分比 和日期 或datetime |
折线图
折线图最好用于跟踪随时间的变化,在每个数据点之间使用相等的时间间隔。
有两种方法可以使用数据集API创建多系列折线图。当创建多系列折线图时,您需要选择一个:
- 具有具有相同数据类型的折线图系列(即所有数据类型均为货币)
- 在数据集中有一个字符串值“拆分依据”(自动为每个不同的字符串值生成序列)
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
折线图多系列 | ![]() |
期间 或钱 或数 或百分比 |
折线图轴 | ![]() |
期间 或日期 或datetime |
列图表
柱状图数据由矩形条表示,其长度与所代表的值成正比。柱状图的离散数据是分类数据,回答了问题“有多少?”在每个类别中。
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
列图表规 | ![]() |
期间 或钱 或数 或百分比 |
柱形图X轴 | ![]() |
期间 或日期 或datetime 或字符串 |
多系列柱状图度量 | ![]() |
期间 或钱 或数 或百分比 |
条形图
条形图使用水平矩形条显示数据,其中条形条的长度与数据值成比例。柱状图的离散数据是分类数据,回答了问题“有多少?”在每个类别中。
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
条形图度量 | ![]() |
期间 或钱 或数 或百分比 |
条形图X轴 | ![]() |
期间 或日期 或datetime 或字符串 |
排行榜可视化
排行榜是成就的形象化。他们的目标是比较人们(或物品)的等级。
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
排行榜标签 | ![]() |
字符串 |
排行榜价值 | ![]() |
钱 或数 或百分比 |
表可视化
表用于显示数据集最多10列的数据。有两种类型的表格:
- 原始数据:显示原始数据的每条记录的一行。
- 摘要:按字符串或日期分组的聚合数据。
可视化类型 | 可视化例子 | 所需类型 |
---|---|---|
原始数据表 | ![]() |
任何数据类型,只要至少有两个 |
表总结 | ![]() |
期间 或
|