Skip to main content
POST
/
segmentation
/
changes
/
{uuid}
/
fetch
Fetch change data
curl --request POST \
  --url https://api.getcargo.io/v1/segmentation/changes/{uuid}/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kinds": [
    "added"
  ],
  "limit": 123,
  "offset": 123
}
'
{
  "columns": [
    {
      "slug": "<string>",
      "type": "string",
      "label": "<string>",
      "modelUuid": "<string>"
    }
  ],
  "count": 123,
  "records": [
    {}
  ]
}

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.

​
kinds
enum<string>[]
required

Change kinds to include.

Available options:
added,
updated,
removed,
unchanged
​
limit
number

Maximum number of records to return.

​
offset
number

Number of records to skip.

Response

Successful response

​
columns
Columns · object[]
required

Segment columns.

​
count
number
required

Total number of records.

​
records
Records · object[]
required

Fetched change records.