Skip to content

Commit 765ebd5

Browse files
committed
Document v1 points and readings timestamp limiting
1 parent 8e4a863 commit 765ebd5

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

swagger/v1-overrides.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,13 @@ export const v1SummaryOverrides = {
4747
};
4848

4949
export const v1DescriptionOverrides = {
50-
'get-devices-id-points': `Gets one or more points for a device, based on filtering.`,
50+
'get-devices-id-points': `Gets one or more points for a device, based on filtering.
51+
52+
### Filter limitations
53+
54+
When filtering by time ranges, using the ` + '`timestamp`' + ` field, you are limited to at most 90 days of data at a time.
55+
If you request more than 90 days, only the latest 90 days in your range will be returned.
56+
A maximum of 10,000 readings can be returned in one request.`,
5157
'get-devices-id-points-fk': `Get a specific point for device when you already know the device ID and point ID.`,
5258
'get-users-id-getDeviceSummary': `Lists all devices for a user, with a summary of state, including most resent points.`,
5359
'get-devices-id-deactivate': `Deactivates a device.`,
@@ -60,7 +66,13 @@ If you want to activate a device on a modern plan, see the V2 API.`,
6066
'get-devices-id-readings':
6167
`Gets [readings](/terminology/readings) that a device has taken, such as battery voltage, temperature, humidity etc.
6268
63-
Use [filtering](/apis/v1/filtering) to get a specific [type](/terminology/readings#types).`,
69+
Use [filtering](/apis/v1/filtering) to get a specific [type](/terminology/readings#types).
70+
71+
### Filter limitations
72+
73+
When filtering by time ranges, using the ` + '`timestamp`' + ` field, you are limited to at most 90 days of data at a time.
74+
If you request more than 90 days, only the latest 90 days in your range will be returned.
75+
A maximum of 10,000 readings can be returned in one request.`,
6476
'get-devices-id-setupSqsForwarding':
6577
`Configure SQS Notifications for a device.
6678

0 commit comments

Comments
 (0)