List Peak Flow Readings

GET

Retrieves a paginated list of peak flow readings from the Impilo platform. Optional parameters can be used to filter the results by page number, page size, patient ID, external ID, start timestamp, and end timestamp.

Query parameters

pageintegerOptional

sizeintegerOptional

patientIdlongOptional

externalIdentifierstringOptional

startTimestampstringOptional

endTimestampstringOptional

Response

This endpoint returns an object.

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

GET

1 curl https://app.impiloplatform.com/api/v3/peak-flow-reading \
2      -H "Impilo-API-Key: <apiKey>"

200peakFlowReadingPagedResponseExample

1 {
2   "content": [
3     {
4       "id": 42,
5       "readingTimestamp": "2024-07-04T00:00:00Z",
6       "manual": false,
7       "deviceTimeZoneOffset": 0,
8       "patientTimeZoneOffset": 0,
9       "patient": {
10         "firstName": "John",
11         "lastName": "Doe",
12         "id": 456,
13         "externalIdentifier": "external-identifier-123",
14         "dateOfBirth": "1987-09-13",
15         "email": "email@example.com",
16         "phoneNumber": "111-222-3333",
17         "archived": true,
18         "address": {
19           "lineOne": "1234 Market Street",
20           "city": "Philadelphia",
21           "state": "PA",
22           "zipCode": "19137",
23           "country": "USA",
24           "lineTwo": "Suite 110"
25         },
26         "sex": "unknown"
27       },
28       "item": {
29         "id": 791,
30         "manufacturer": {
31           "id": 2,
32           "name": "Custom Manufacturer"
33         },
34         "name": "Blood Pressure Monitor",
35         "model": "iBloodPressureMonitor123",
36         "sku": "0000001"
37       },
38       "device": {
39         "id": 599,
40         "item": {
41           "id": 791,
42           "manufacturer": {
43             "id": 2,
44             "name": "Custom Manufacturer"
45           },
46           "name": "Blood Pressure Monitor",
47           "model": "iBloodPressureMonitor123",
48           "sku": "0000001"
49         },
50         "currentStatus": "withPatient",
51         "currentPatient": {
52           "firstName": "John",
53           "lastName": "Doe",
54           "id": 456,
55           "externalIdentifier": "external-identifier-123",
56           "dateOfBirth": "1987-09-13",
57           "email": "email@example.com",
58           "phoneNumber": "111-222-3333",
59           "archived": true,
60           "address": {
61             "lineOne": "1234 Market Street",
62             "city": "Philadelphia",
63             "state": "PA",
64             "zipCode": "19137",
65             "country": "USA",
66             "lineTwo": "Suite 110"
67           },
68           "sex": "unknown"
69         },
70         "deviceIdentifiers": [
71           {
72             "type": "imei",
73             "value": "354833969951611"
74           },
75           {
76             "type": "serial",
77             "value": "A44-A0623930"
78           },
79           {
80             "type": "macAddress",
81             "value": "f51da43314fc"
82           }
83         ],
84         "disabledReadings": false
85       },
86       "peakExpiratoryFlow": 100.3,
87       "forcedExpiratoryVolume": 0.62
88     },
89     {
90       "id": 43,
91       "readingTimestamp": "2024-07-04T00:00:00Z",
92       "manual": false,
93       "deviceTimeZoneOffset": 0,
94       "patientTimeZoneOffset": 0,
95       "patient": {
96         "firstName": "John",
97         "lastName": "Doe",
98         "id": 456,
99         "externalIdentifier": "external-identifier-123",
100         "dateOfBirth": "1987-09-13",
101         "email": "email@example.com",
102         "phoneNumber": "111-222-3333",
103         "archived": true,
104         "address": {
105           "lineOne": "1234 Market Street",
106           "city": "Philadelphia",
107           "state": "PA",
108           "zipCode": "19137",
109           "country": "USA",
110           "lineTwo": "Suite 110"
111         },
112         "sex": "unknown"
113       },
114       "item": {
115         "id": 791,
116         "manufacturer": {
117           "id": 2,
118           "name": "Custom Manufacturer"
119         },
120         "name": "Blood Pressure Monitor",
121         "model": "iBloodPressureMonitor123",
122         "sku": "0000001"
123       },
124       "device": {
125         "id": 599,
126         "item": {
127           "id": 791,
128           "manufacturer": {
129             "id": 2,
130             "name": "Custom Manufacturer"
131           },
132           "name": "Blood Pressure Monitor",
133           "model": "iBloodPressureMonitor123",
134           "sku": "0000001"
135         },
136         "currentStatus": "withPatient",
137         "currentPatient": {
138           "firstName": "John",
139           "lastName": "Doe",
140           "id": 456,
141           "externalIdentifier": "external-identifier-123",
142           "dateOfBirth": "1987-09-13",
143           "email": "email@example.com",
144           "phoneNumber": "111-222-3333",
145           "archived": true,
146           "address": {
147             "lineOne": "1234 Market Street",
148             "city": "Philadelphia",
149             "state": "PA",
150             "zipCode": "19137",
151             "country": "USA",
152             "lineTwo": "Suite 110"
153           },
154           "sex": "unknown"
155         },
156         "deviceIdentifiers": [
157           {
158             "type": "imei",
159             "value": "354833969951611"
160           },
161           {
162             "type": "serial",
163             "value": "A44-A0623930"
164           },
165           {
166             "type": "macAddress",
167             "value": "f51da43314fc"
168           }
169         ],
170         "disabledReadings": false
171       },
172       "peakExpiratoryFlow": 100.3,
173       "forcedExpiratoryVolume": 0.62
174     }
175   ],
176   "page": 1,
177   "size": 2,
178   "total": 4,
179   "first": true,
180   "last": false
181 }

Built with

1	curl https://app.impiloplatform.com/api/v3/peak-flow-reading \
2	-H "Impilo-API-Key: <apiKey>"

1	{
2	"content": [
3	{
4	"id": 42,
5	"readingTimestamp": "2024-07-04T00:00:00Z",
6	"manual": false,
7	"deviceTimeZoneOffset": 0,
8	"patientTimeZoneOffset": 0,
9	"patient": {
10	"firstName": "John",
11	"lastName": "Doe",
12	"id": 456,
13	"externalIdentifier": "external-identifier-123",
14	"dateOfBirth": "1987-09-13",
15	"email": "email@example.com",
16	"phoneNumber": "111-222-3333",
17	"archived": true,
18	"address": {
19	"lineOne": "1234 Market Street",
20	"city": "Philadelphia",
21	"state": "PA",
22	"zipCode": "19137",
23	"country": "USA",
24	"lineTwo": "Suite 110"
25	},
26	"sex": "unknown"
27	},
28	"item": {
29	"id": 791,
30	"manufacturer": {
31	"id": 2,
32	"name": "Custom Manufacturer"
33	},
34	"name": "Blood Pressure Monitor",
35	"model": "iBloodPressureMonitor123",
36	"sku": "0000001"
37	},
38	"device": {
39	"id": 599,
40	"item": {
41	"id": 791,
42	"manufacturer": {
43	"id": 2,
44	"name": "Custom Manufacturer"
45	},
46	"name": "Blood Pressure Monitor",
47	"model": "iBloodPressureMonitor123",
48	"sku": "0000001"
49	},
50	"currentStatus": "withPatient",
51	"currentPatient": {
52	"firstName": "John",
53	"lastName": "Doe",
54	"id": 456,
55	"externalIdentifier": "external-identifier-123",
56	"dateOfBirth": "1987-09-13",
57	"email": "email@example.com",
58	"phoneNumber": "111-222-3333",
59	"archived": true,
60	"address": {
61	"lineOne": "1234 Market Street",
62	"city": "Philadelphia",
63	"state": "PA",
64	"zipCode": "19137",
65	"country": "USA",
66	"lineTwo": "Suite 110"
67	},
68	"sex": "unknown"
69	},
70	"deviceIdentifiers": [
71	{
72	"type": "imei",
73	"value": "354833969951611"
74	},
75	{
76	"type": "serial",
77	"value": "A44-A0623930"
78	},
79	{
80	"type": "macAddress",
81	"value": "f51da43314fc"
82	}
83	],
84	"disabledReadings": false
85	},
86	"peakExpiratoryFlow": 100.3,
87	"forcedExpiratoryVolume": 0.62
88	},
89	{
90	"id": 43,
91	"readingTimestamp": "2024-07-04T00:00:00Z",
92	"manual": false,
93	"deviceTimeZoneOffset": 0,
94	"patientTimeZoneOffset": 0,
95	"patient": {
96	"firstName": "John",
97	"lastName": "Doe",
98	"id": 456,
99	"externalIdentifier": "external-identifier-123",
100	"dateOfBirth": "1987-09-13",
101	"email": "email@example.com",
102	"phoneNumber": "111-222-3333",
103	"archived": true,
104	"address": {
105	"lineOne": "1234 Market Street",
106	"city": "Philadelphia",
107	"state": "PA",
108	"zipCode": "19137",
109	"country": "USA",
110	"lineTwo": "Suite 110"
111	},
112	"sex": "unknown"
113	},
114	"item": {
115	"id": 791,
116	"manufacturer": {
117	"id": 2,
118	"name": "Custom Manufacturer"
119	},
120	"name": "Blood Pressure Monitor",
121	"model": "iBloodPressureMonitor123",
122	"sku": "0000001"
123	},
124	"device": {
125	"id": 599,
126	"item": {
127	"id": 791,
128	"manufacturer": {
129	"id": 2,
130	"name": "Custom Manufacturer"
131	},
132	"name": "Blood Pressure Monitor",
133	"model": "iBloodPressureMonitor123",
134	"sku": "0000001"
135	},
136	"currentStatus": "withPatient",
137	"currentPatient": {
138	"firstName": "John",
139	"lastName": "Doe",
140	"id": 456,
141	"externalIdentifier": "external-identifier-123",
142	"dateOfBirth": "1987-09-13",
143	"email": "email@example.com",
144	"phoneNumber": "111-222-3333",
145	"archived": true,
146	"address": {
147	"lineOne": "1234 Market Street",
148	"city": "Philadelphia",
149	"state": "PA",
150	"zipCode": "19137",
151	"country": "USA",
152	"lineTwo": "Suite 110"
153	},
154	"sex": "unknown"
155	},
156	"deviceIdentifiers": [
157	{
158	"type": "imei",
159	"value": "354833969951611"
160	},
161	{
162	"type": "serial",
163	"value": "A44-A0623930"
164	},
165	{
166	"type": "macAddress",
167	"value": "f51da43314fc"
168	}
169	],
170	"disabledReadings": false
171	},
172	"peakExpiratoryFlow": 100.3,
173	"forcedExpiratoryVolume": 0.62
174	}
175	],
176	"page": 1,
177	"size": 2,
178	"total": 4,
179	"first": true,
180	"last": false
181	}