Get Alert History

使用 HTTP GET 获取警报历史记录

请求

HTTP方法

GET

URL

https://api.thingspeak.com/alerts/history

URL 参数

名称	优先级	描述
`count`	可选	要返回的结果数。默认值为 10，最大值为 100。
`after`	可选	仅包含 `requested_at` 晚于此时间的历史记录项目。根据 ISO 8601 格式化时间。示例，2020-05-15T20:03:48-05:00 表示 2020 年 5 月 15 日 20:03:48 EST。如果您不包含时区偏移量，ThingSpeak 会假定指定时间采用 UTC 格式。注意：警报历史记录项目仅保留 7 天，之后将不再可用。
`before`	可选	仅包含 `requested_at` 早于该时间的历史项目。根据 ISO 8601 格式化时间。示例，2020-05-15T20:03:48-05:00 表示 2020 年 5 月 15 日 20:03:48 EST。如果您不包含时区偏移量，ThingSpeak 会假定指定时间采用 UTC 格式。注意：警报历史记录项目仅保留 7 天，之后将不再可用。
`subject_contains`	可选	仅包含主题包含此值的历史记录项目，区分大小写。
`status`	可选	仅包括状态包含此值的历史项目。

示例： https://api.thingspeak.com/alerts/history?count=10

标头

名称	优先级	描述	值类型
`ThingSpeak-Alerts-API-Key`	必需	指定警报 API 密钥，您可以在 profile 中找到该密钥。该密钥不同于通道API 和用户 API 密钥。	字符串

主体参数

此 API 调用没有可用的主体参数。

响应

成功

HTTP 状态代码

200 OK

错误

您可以使用 Accept头文件控制错误消息提供的详细信息。提供 Accept头文件和密钥 application/json,application/problem+json，服务器将返回详细的错误消息以及标准 HTTP 响应代码。

有关可能的 HTTP 错误的完整列表，请参阅错误代码。

示例

全部展开

使用 MATLAB 查看警报历史记录

您可以使用MATLAB^®读取过去7天的警报历史记录。此示例演示如何发出 HTTP请求来生成警报历史记录。请注意，您可以在任何 MATLAB 环境中编写以下代码，包括 MATLAB 分析和桌面 MATLAB。

设置警报 API 密钥和请求的 URL。您的警报 API 密钥位于 Account> My Profile。

apiKey = 'XXXXXXXXXXXXXXXX';
history_url = "https://api.thingspeak.com/alerts/history"

警报发送请求需要 API 密钥头文件。构建 weboptions 以便 webread 可以正确写入您的 HTTP请求。还要创建电子邮件主体和主题。

options = weboptions("HeaderFields", ["ThingSpeak-Alerts-API-Key", apiKey ]);

使用 webread (MATLAB) 发出获取历史记录请求。

myHistoryStruct = webread(history_url, options);

Web请求返回一个结构体。使用 struct2table (MATLAB)、datetime (MATLAB) 和 table2timetable (MATLAB) 将输出重写为更易于查看的形式。

history = struct2table(myHistoryStruct, "AsArray", true);
history.requestedAt = datetime(history.requestedAt, 'InputFormat', "uuuu-MM-dd'T'HH:mm:ss.SSSz", 'TimeZone',"America/New_York");
history = table2timetable(history)

history =

  2×3 timetable

        requestedAt                    sentAt                        subject               status 
    ____________________    ____________________________    __________________________    ________

    18-Dec-2019 13:46:48    {'2019-12-18T18:46:54.160Z'}    {'Plant soil information'}    {'sent'}
    18-Dec-2019 13:43:36    {'2019-12-18T18:43:42.032Z'}    {'Plant soil information'}    {'sent'}