Get Chunks

POST

Fetches “chunks” of series that are stored as Arrow files in S3. This endpoint is being deprecated for new series in favor of batchGetCachedSeries

Path parameters

logicalSeriesRidstringRequired

Request

This endpoint expects an object.

startTimestampobjectRequired

endTimestampobjectRequired

resolutionNanoslongRequired

Response

This endpoint returns an object.

chunkslist of objects

POST

1 curl -X POST https://api.gov.nominal.io/api/timeseries/series-cache/v1/logical-series/logicalSeriesRid/get-chunks \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "startTimestamp": {
6     "seconds": 1000000,
7     "nanos": 1000000
8   },
9   "endTimestamp": {
10     "seconds": 1000000,
11     "nanos": 1000000
12   },
13   "resolutionNanos": 1000000
14 }'

200Successful

1 {
2   "chunks": [
3     {
4       "rid": "rid",
5       "type": "ARROW_WITH_RELATIVE_TIMESTAMPS",
6       "logicalSeriesRid": "logicalSeriesRid",
7       "startTimestamp": {
8         "seconds": 1000000,
9         "nanos": 1000000,
10         "picos": 1
11       },
12       "endTimestamp": {
13         "seconds": 1000000,
14         "nanos": 1000000,
15         "picos": 1
16       },
17       "count": 1000000,
18       "sizeInBytes": 1000000,
19       "resolution": 1000000,
20       "handle": {
21         "type": "s3",
22         "s3": {
23           "s3Path": "s3Path"
24         }
25       }
26     },
27     {
28       "rid": "rid",
29       "type": "ARROW_WITH_RELATIVE_TIMESTAMPS",
30       "logicalSeriesRid": "logicalSeriesRid",
31       "startTimestamp": {
32         "seconds": 1000000,
33         "nanos": 1000000,
34         "picos": 1
35       },
36       "endTimestamp": {
37         "seconds": 1000000,
38         "nanos": 1000000,
39         "picos": 1
40       },
41       "count": 1000000,
42       "sizeInBytes": 1000000,
43       "resolution": 1000000,
44       "handle": {
45         "type": "s3",
46         "s3": {
47           "s3Path": "s3Path"
48         }
49       }
50     }
51   ]
52 }

Create Chunks

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/timeseries/series-cache/v1/logical-series/logicalSeriesRid/get-chunks \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"startTimestamp": {
6	"seconds": 1000000,
7	"nanos": 1000000
8	},
9	"endTimestamp": {
10	"seconds": 1000000,
11	"nanos": 1000000
12	},
13	"resolutionNanos": 1000000
14	}'

1	{
2	"chunks": [
3	{
4	"rid": "rid",
5	"type": "ARROW_WITH_RELATIVE_TIMESTAMPS",
6	"logicalSeriesRid": "logicalSeriesRid",
7	"startTimestamp": {
8	"seconds": 1000000,
9	"nanos": 1000000,
10	"picos": 1
11	},
12	"endTimestamp": {
13	"seconds": 1000000,
14	"nanos": 1000000,
15	"picos": 1
16	},
17	"count": 1000000,
18	"sizeInBytes": 1000000,
19	"resolution": 1000000,
20	"handle": {
21	"type": "s3",
22	"s3": {
23	"s3Path": "s3Path"
24	}
25	}
26	},
27	{
28	"rid": "rid",
29	"type": "ARROW_WITH_RELATIVE_TIMESTAMPS",
30	"logicalSeriesRid": "logicalSeriesRid",
31	"startTimestamp": {
32	"seconds": 1000000,
33	"nanos": 1000000,
34	"picos": 1
35	},
36	"endTimestamp": {
37	"seconds": 1000000,
38	"nanos": 1000000,
39	"picos": 1
40	},
41	"count": 1000000,
42	"sizeInBytes": 1000000,
43	"resolution": 1000000,
44	"handle": {
45	"type": "s3",
46	"s3": {
47	"s3Path": "s3Path"
48	}
49	}
50	}
51	]
52	}