Segment
SegmentScan
Get a paged list of Users for a Segment.
get/api/segment/{segId}/scan
Request
- Base URLhttps://api.lytics.io
- URLhttps://api.lytics.io/api/segment/{segId}/scan
- AuthAPI key in header Authorization
Path parameters
segIdstring required
segment Id in path
Query parameters
account_idstring
Your Lytics account ID.
idstring
segment Id in querystring instead of path then use api/segment/scan
limitinteger
num of rows to return per call, default = 10, max = 100
splitsstring
1,2,3 comma seperated list of ints 0-99 for a-b split testing (a=1,5,8 )
startinteger
optional ID of a previous segment scan to resume, must be recent this is retrieved from the next parameter in JSON response
metaboolean
optional boolean, whether to include schema in response
sortfieldstring
field to sort on
sortorderstring
[desc,asc]
recentboolean
short cut for last visit timestamp desc [t,true,]
segmentsstring
JSON of ad-hoc segment, or pass this in http Body
fieldsstring
list of fields to include in response
Response
OK
unknown required
Changes
No recorded changes to this operation across all 1 revision of this API.