Fetch segment data

Fetch data for a segment

POST /segmentation/segments/{uuid}/fetch

Fetch segment data

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/segmentation/segments/{uuid}/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filter": {
    "groups": [
      {
        "conditions": [
          {
            "kind": "<string>",
            "name": "<string>",
            "clause": "<string>"
          }
        ]
      }
    ]
  },
  "sort": [
    {
      "columnSlug": "<string>"
    }
  ],
  "limit": 123,
  "fetchingLimit": 123,
  "fetchingOffset": 123,
  "enrich": true,
  "sync": true
}
'

200

{
  "records": [
    {}
  ],
  "columns": [
    {
      "slug": "<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<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.

Show child attributes

sort · Sort · object[]

Sort criteria for the segment.

Show child attributes

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

200

application/json

Successful response

records · Records · object[] · required

Fetched segment records.

Show child attributes

columns · Columns · object[] · required

Segment columns.

Show child attributes

count · number · required

Total number of records.