Export Channel Data

POST

Required permissions matches those required to compute the channels via the compute API.

Request

This endpoint expects an object.

formatobjectRequired

startTimeobjectRequired

endTimeobjectRequired

resolutionobjectRequired

channelsobjectRequired

contextobjectRequired

compression"GZIP" or "ZIP"Optional

Allowed values: GZIPZIP

Response

This endpoint returns a file.

POST

1 curl -X POST https://api.gov.nominal.io/api/export/v1/export \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "format": {
6     "type": "csv",
7     "csv": {}
8   },
9   "startTime": {
10     "seconds": 1000000,
11     "nanos": 1000000
12   },
13   "endTime": {
14     "seconds": 1000000,
15     "nanos": 1000000
16   },
17   "resolution": {
18     "type": "nanoseconds",
19     "nanoseconds": 1000000
20   },
21   "channels": {
22     "type": "timeDomain",
23     "timeDomain": {
24       "outputTimestampFormat": {
25         "type": "iso8601",
26         "iso8601": {}
27       },
28       "mergeTimestampStrategy": {
29         "type": "none",
30         "none": {}
31       },
32       "channels": [
33         {
34           "columnName": "columnName",
35           "computeNode": {
36             "type": "raw",
37             "raw": {
38               "name": "name"
39             }
40           }
41         },
42         {
43           "columnName": "columnName",
44           "computeNode": {
45             "type": "raw",
46             "raw": {
47               "name": "name"
48             }
49           }
50         }
51       ]
52     }
53   },
54   "context": {
55     "variables": {
56       "variables": {
57         "type": "double",
58         "double": 1.1
59       }
60     },
61     "functionVariables": {
62       "functionVariables": {
63         "variables": {
64           "variables": {
65             "type": "double",
66             "double": 1.1
67           }
68         },
69         "subFunctionVariables": {
70           "subFunctionVariables": {
71             "variables": {
72               "variables": {
73                 "type": "double",
74                 "double": 1.1
75               }
76             },
77             "subFunctionVariables": {
78               "subFunctionVariables": {
79                 "variables": {
80                   "variables": {
81                     "type": "double",
82                     "double": 1.1
83                   }
84                 },
85                 "subFunctionVariables": {
86                   "subFunctionVariables": {
87                     "variables": {},
88                     "subFunctionVariables": {}
89                   }
90                 }
91               }
92             }
93           }
94         }
95       }
96     }
97   }
98 }'

Batch Initiate

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/export/v1/export \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"format": {
6	"type": "csv",
7	"csv": {}
8	},
9	"startTime": {
10	"seconds": 1000000,
11	"nanos": 1000000
12	},
13	"endTime": {
14	"seconds": 1000000,
15	"nanos": 1000000
16	},
17	"resolution": {
18	"type": "nanoseconds",
19	"nanoseconds": 1000000
20	},
21	"channels": {
22	"type": "timeDomain",
23	"timeDomain": {
24	"outputTimestampFormat": {
25	"type": "iso8601",
26	"iso8601": {}
27	},
28	"mergeTimestampStrategy": {
29	"type": "none",
30	"none": {}
31	},
32	"channels": [
33	{
34	"columnName": "columnName",
35	"computeNode": {
36	"type": "raw",
37	"raw": {
38	"name": "name"
39	}
40	}
41	},
42	{
43	"columnName": "columnName",
44	"computeNode": {
45	"type": "raw",
46	"raw": {
47	"name": "name"
48	}
49	}
50	}
51	]
52	}
53	},
54	"context": {
55	"variables": {
56	"variables": {
57	"type": "double",
58	"double": 1.1
59	}
60	},
61	"functionVariables": {
62	"functionVariables": {
63	"variables": {
64	"variables": {
65	"type": "double",
66	"double": 1.1
67	}
68	},
69	"subFunctionVariables": {
70	"subFunctionVariables": {
71	"variables": {
72	"variables": {
73	"type": "double",
74	"double": 1.1
75	}
76	},
77	"subFunctionVariables": {
78	"subFunctionVariables": {
79	"variables": {
80	"variables": {
81	"type": "double",
82	"double": 1.1
83	}
84	},
85	"subFunctionVariables": {
86	"subFunctionVariables": {
87	"variables": {},
88	"subFunctionVariables": {}
89	}
90	}
91	}
92	}
93	}
94	}
95	}
96	}
97	}
98	}'