Segment
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/segments/graph';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"end_time":"example","field_selector":{"edge_metric_type":["METRIC_NONE"],"node_metric_type":["METRIC_NONE"]},"group_by":["SEGMENT_LABEL_NONE"],"label_filter":[{"label":"SEGMENT_LABEL_NONE","op":"EQ","value":"example"}],"namespace":"example","start_time":"example","step":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/segments/graph \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "end_time": "example", "field_selector": { "edge_metric_type": [ "METRIC_NONE" ], "node_metric_type": [ "METRIC_NONE" ] }, "group_by": [ "SEGMENT_LABEL_NONE" ], "label_filter": [ { "label": "SEGMENT_LABEL_NONE", "op": "EQ", "value": "example" } ], "namespace": "example", "start_time": "example", "step": "example" }'Request to GET different network segments with given metrics . This will give metric data for all segments including intra segment metrics.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace This request is supported only in system namespace.
Request Bodyrequired
Section titled “Request Bodyrequired”Request to specify filters, group by, metric selectors etc for segments.
object
End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339
Optional: If not specified, then the end_time will be evaluated to start_time+10m
If start_time is not specified, then the end_time will be evaluated to
object
Field Selector for edge.
Field Selector for node.
Aggregate data by given group by.
Optional: If not specified, then the data is aggregated/grouped by segment_name.
List of label filter expressions of the form “label key” QueryOp “value”. Response will only contain data that matches all the conditions specified in the label_filter.
Optional: If not specified, segment data for all segments will be returned in the response.
Label Filter.
Filters that will use segment labels to filter out timeseries.
object
Value of the label.
This request is supported only in system namespace.
Start time of metric collection from which data will be considered to build response. Format: unix_timestamp|RFC 3339
Optional: If not specified, then the start_time will be evaluated to end_time-10m
If end_time is not specified, then the start_time will be evaluated to
Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, … Tn=tn-1+step, where tn <= end_time. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days
Optional: If not specified, then step size is evaluated to <end_time - start_time>
Responses
Section titled “Responses”A successful response.
Response for all segments. Metric data for all segments for each metric type specified in the request.
object
Data for different metric types for all segments.
Edge Data.
Data for each segment edge in the segments response.
object
Metric data for the given metric.
Node Metric Data.
Metric Data for each metric type in the segments node.
object
Metric value.
Metric data contains timestamp and the value.
object
Timestamp
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Configuration parameter for value
“name” is the label defined in Labels.
object
“name” is the label defined in Labels.
object
Data for different metric types for all segments.
Node Data.
Data for each segment node in the segments response.
object
Number of connected segments for a given segment.
Metric data for the given metric.
Node Metric Data.
Metric Data for each metric type in the segments node.
object
Metric value.
Metric data contains timestamp and the value.
object
Timestamp
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Configuration parameter for value
“name” is the label defined in Labels.
object
Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.
Example
{ "edges": [ { "data": [ { "type": "METRIC_NONE", "unit": "UNIT_MILLISECONDS", "value": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ] } ], "nodes": [ { "data": [ { "type": "METRIC_NONE", "unit": "UNIT_MILLISECONDS", "value": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ] } ]}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example