Skip to main content
GET
/
segments
Get all segments
curl --request GET \
  --url https://api.vantage.sh/v2/segments \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "self": "https://api.vantage.sh/v2/segments",
    "first": "https://api.vantage.sh/v2/segments?page=1",
    "next": null,
    "last": "https://api.vantage.sh/v2/segments?page=1",
    "prev": null
  },
  "segments": [
    {
      "token": "fltr_sgmt_79b0b8ef658d6bba",
      "title": "Business Units",
      "parent_segment_token": null,
      "description": "Segmented by business unit.",
      "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:22Z",
      "workspace_token": "wrkspc_21f36c4ad272fb7b",
      "report_token": "rprt_8dd4e1fe3b88c821"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer<int32>

The page of results to return.

limit
integer<int32>

The amount of results to return. The maximum is 1000.

Response

200 - application/json

Segments model

segments
object[]