Brands - Segments

/v1.1/brand/[BrandID]/segments GET

API Version: v1.1

Switch to the API v1.0 documents?

Description

Return a list of all of your segments

Parameters

apiKey Your API access key
[brandID] Filter to segments for a specific brand
segmentID ID of the campaign to filter by
orderBy Order the results. Accepts the arguments CREATED or ID, plus ASC and DESC eg. orderBy=CREATED+DESC
excludeBasicSocial Set to 1 to exclude your default Basic Social Listening segment
withActivities Set to 1 to show all activities within this segment

Example Request

				
 					
curl -v -X GET https://api.theappreciationengine.com/v1.1/brand/1234/segments?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p

Sign in with your developer account to use the console, or Sign up for a free 30 day trial