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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filter": {
    "conjonction": "or",
    "groups": [
      {
        "conjonction": "or",
        "conditions": [
          {
            "kind": "<string>",
            "name": "<string>",
            "clause": "<string>"
          }
        ]
      }
    ]
  },
  "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<uuid>
required

Segment identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

modelUuid
string<uuid>
required

Model identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
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.