Segments
Get all segment groups
Get information about segment groups.
get/segment-groups
Query parameters
countinteger
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
offsetinteger
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
sort_fieldstring
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
sort_direction'ASC' | 'DESC'
Direction of sorting the response list.
namestring
Name of the segment group.
text_idstring
You can filter resource results depending on his text ID.
Headers
Accept-Languagestring
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"segment_groups": [
{
"segment_group_id": "83d1d11ea3884a5d33253fe214",
"name": "RFM Badges",
"parent_group_id": "8bed991c68a470e7aaeffbf048",
"note": "RFM Badges for tagging customers",
"text_id": "rfm_badges",
"last_change": "2022-04-21 08:26:36.058922"
}
],
"total_items": 1
}
}