Skip to main content
GET
/
segmentation
/
segments
/
{uuid}
/
metrics
Get segment metrics
curl --request GET \
  --url https://api.getcargo.io/v1/segmentation/segments/{uuid}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "segmentMetrics": [
    {
      "date": "<string>",
      "totalRecordsCount": 123,
      "addedRecordsCount": 123,
      "updatedRecordsCount": 123,
      "removedRecordsCount": 123,
      "unchangedRecordsCount": 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})$

Query Parameters

​
from
string
required

Start of the time range.

​
to
string
required

End of the time range.

​
unit
enum<string>
required

Time unit for aggregation.

Available options:
day,
week,
month,
year

Response

Successful response

​
segmentMetrics
Segment metrics · object[]
required

Segment metrics for the selected range.