Skip to main content
GET
/
segments
/
{segment_token}
Get segment by token
curl --request GET \
  --url https://api.vantage.sh/v2/segments/{segment_token} \
  --header 'Authorization: Bearer <token>'
{
  "token": "fltr_sgmt_e528df30fe4c9da4",
  "title": "Function-based",
  "parent_segment_token": null,
  "description": "Segmented by function.",
  "track_unallocated": false,
  "report_settings": {
    "include_credits": false,
    "include_refunds": false,
    "include_discounts": true,
    "include_tax": true,
    "amortize": true
  },
  "priority": 100,
  "filter": "(costs.provider = 'aws')",
  "created_at": "2024-05-14T14:34:18Z",
  "workspace_token": "wrkspc_eb7573db105407df",
  "report_token": "rprt_f7828113036f5fce"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
segment_token
string
required

Response

Segment model

​
token
string
​
title
string

The title of the Segment.

Example:

"OPEX"

​
parent_segment_token
string

The token of the parent Segment of this Segment.

​
description
string

The description of the Segment.

Example:

"Operating expenses"

​
track_unallocated
boolean

Track Unallocated Costs which are not assigned to any of the created Segments.

Example:

false

​
report_settings
object

Report settings configurable on top-level Segments.

​
priority
integer<int32>

Costs are assigned in priority order across all Segments with assigned filters.

Example:

100

​
filter
string

The filter applied to the Segment. Additional documentation available at https://docs.vantage.sh/vql.

​
created_at
string

The date and time, in UTC, the Segment was created. ISO 8601 Formatted.

Example:

"2021-07-09T00:00:00Z"

​
workspace_token
string

The token for the Workspace the Segment is a part of.

​
report_token
string

The token for the Report the Segment has generated.