Skip to main content
POST
/
segmentation
/
segments
/
{uuid}
/
download
Download segment data
curl --request POST \
  --url https://api.getcargo.io/v1/segmentation/segments/{uuid}/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelUuid": "<string>",
  "filter": {
    "conjonction": "or",
    "groups": [
      {}
    ]
  },
  "sort": [
    {
      "columnSlug": "<string>",
      "kind": "asc"
    }
  ],
  "limit": 123
}
'
{
  "urls": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string
required

Resource UUID

Body

application/json

Request body schema.

modelUuid
string
required

Model identifier.

filter
Filter · object
required

Segment filter criteria.

sort
Sort · object[]

Sort criteria for the segment.

limit
number

Maximum number of records to download.

Response

Successful response

urls
string[]
required

Download URLs for segment records.