Skip to main content
POST
/
segmentation
/
segments
/
{uuid}
/
fetch
Fetch segment data
curl --request POST \
  --url https://api.getcargo.io/v1/segmentation/segments/{uuid}/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelUuid": "<string>",
  "filter": {
    "conjonction": "or",
    "groups": [
      {}
    ]
  },
  "sort": [
    {
      "columnSlug": "<string>",
      "kind": "asc"
    }
  ],
  "limit": 123,
  "fetchingLimit": 123,
  "fetchingOffset": 123,
  "enrich": true,
  "sync": true
}
'
{
  "records": [
    {}
  ],
  "columns": [
    {
      "slug": "<string>",
      "type": "string",
      "label": "<string>",
      "modelUuid": "<string>"
    }
  ],
  "count": 123
}

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 include.

fetchingLimit
number

Number of records to fetch per batch.

fetchingOffset
number

Offset for fetching records.

enrich
boolean

Whether to enrich records.

sync
boolean

Whether to sync before fetching.

Response

Successful response

records
Records · object[]
required

Fetched segment records.

columns
Columns · object[]
required

Segment columns.

count
number
required

Total number of records.